aboutsummaryrefslogtreecommitdiff
path: root/src/messenger/messenger_api_contact.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/messenger/messenger_api_contact.h')
-rw-r--r--src/messenger/messenger_api_contact.h45
1 files changed, 33 insertions, 12 deletions
diff --git a/src/messenger/messenger_api_contact.h b/src/messenger/messenger_api_contact.h
index 0673b9b85..e94d1fcd0 100644
--- a/src/messenger/messenger_api_contact.h
+++ b/src/messenger/messenger_api_contact.h
@@ -1,6 +1,6 @@
1/* 1/*
2 This file is part of GNUnet. 2 This file is part of GNUnet.
3 Copyright (C) 2020 GNUnet e.V. 3 Copyright (C) 2020--2021 GNUnet e.V.
4 4
5 GNUnet is free software: you can redistribute it and/or modify it 5 GNUnet is free software: you can redistribute it and/or modify it
6 under the terms of the GNU Affero General Public License as published 6 under the terms of the GNU Affero General Public License as published
@@ -33,6 +33,7 @@
33struct GNUNET_MESSENGER_Contact 33struct GNUNET_MESSENGER_Contact
34{ 34{
35 char *name; 35 char *name;
36 size_t rc;
36 37
37 struct GNUNET_IDENTITY_PublicKey public_key; 38 struct GNUNET_IDENTITY_PublicKey public_key;
38}; 39};
@@ -40,7 +41,7 @@ struct GNUNET_MESSENGER_Contact
40/** 41/**
41 * Creates and allocates a new contact with a given public <i>key</i> from an EGO. 42 * Creates and allocates a new contact with a given public <i>key</i> from an EGO.
42 * 43 *
43 * @param key Public key 44 * @param[in] key Public key
44 * @return New contact 45 * @return New contact
45 */ 46 */
46struct GNUNET_MESSENGER_Contact* 47struct GNUNET_MESSENGER_Contact*
@@ -49,7 +50,7 @@ create_contact (const struct GNUNET_IDENTITY_PublicKey *key);
49/** 50/**
50 * Destroys a contact and frees its memory fully. 51 * Destroys a contact and frees its memory fully.
51 * 52 *
52 * @param contact Contact 53 * @param[in/out] contact Contact
53 */ 54 */
54void 55void
55destroy_contact (struct GNUNET_MESSENGER_Contact *contact); 56destroy_contact (struct GNUNET_MESSENGER_Contact *contact);
@@ -57,7 +58,7 @@ destroy_contact (struct GNUNET_MESSENGER_Contact *contact);
57/** 58/**
58 * Returns the current name of a given <i>contact</i> or NULL if no valid name was assigned yet. 59 * Returns the current name of a given <i>contact</i> or NULL if no valid name was assigned yet.
59 * 60 *
60 * @param contact Contact 61 * @param[in] contact Contact
61 * @return Name of the contact or NULL 62 * @return Name of the contact or NULL
62 */ 63 */
63const char* 64const char*
@@ -66,8 +67,8 @@ get_contact_name (const struct GNUNET_MESSENGER_Contact *contact);
66/** 67/**
67 * Changes the current name of a given <i>contact</i> by copying it from the parameter <i>name</i>. 68 * Changes the current name of a given <i>contact</i> by copying it from the parameter <i>name</i>.
68 * 69 *
69 * @param contact Contact 70 * @param[in/out] contact Contact
70 * @param name Valid name (may not be NULL!) 71 * @param[in] name Name
71 */ 72 */
72void 73void
73set_contact_name (struct GNUNET_MESSENGER_Contact *contact, const char *name); 74set_contact_name (struct GNUNET_MESSENGER_Contact *contact, const char *name);
@@ -75,19 +76,39 @@ set_contact_name (struct GNUNET_MESSENGER_Contact *contact, const char *name);
75/** 76/**
76 * Returns the public key of a given <i>contact</i>. 77 * Returns the public key of a given <i>contact</i>.
77 * 78 *
78 * @param contact Contact 79 * @param[in] contact Contact
79 * @return Public key of the contact 80 * @return Public key of the contact
80 */ 81 */
81const struct GNUNET_IDENTITY_PublicKey* 82const struct GNUNET_IDENTITY_PublicKey*
82get_contact_key (const struct GNUNET_MESSENGER_Contact *contact); 83get_contact_key (const struct GNUNET_MESSENGER_Contact *contact);
83 84
84/** 85/**
85 * Returns the resulting hashcode of the public key from a given <i>contact</i>. 86 * Increases the reference counter of a given <i>contact</i> which is zero as default.
86 * 87 *
87 * @param contact Contact 88 * @param[in/out] contact Contact
88 * @return Hash of the contacts public key
89 */ 89 */
90const struct GNUNET_HashCode* 90void
91get_contact_id_from_key (const struct GNUNET_MESSENGER_Contact *contact); 91increase_contact_rc (struct GNUNET_MESSENGER_Contact *contact);
92
93/**
94 * Decreases the reference counter if possible (can not underflow!) of a given <i>contact</i>
95 * and returns #GNUNET_YES if the counter is equal to zero, otherwise #GNUNET_NO.
96 *
97 * @param[in/out] contact Contact
98 * @return #GNUNET_YES or #GNUNET_NO depending on the reference counter
99 */
100int
101decrease_contact_rc (struct GNUNET_MESSENGER_Contact *contact);
102
103/**
104 * Calculates the context <i>hash</i> of a member in a room and returns it.
105 *
106 * @param[in] key Key of room
107 * @param[in] id Member id
108 * @param[out] hash Member context
109 */
110void
111get_context_from_member (const struct GNUNET_HashCode *key, const struct GNUNET_ShortHashCode *id,
112 struct GNUNET_HashCode *context);
92 113
93#endif //GNUNET_MESSENGER_API_CONTACT_H 114#endif //GNUNET_MESSENGER_API_CONTACT_H