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.h116
1 files changed, 0 insertions, 116 deletions
diff --git a/src/messenger/messenger_api_contact.h b/src/messenger/messenger_api_contact.h
deleted file mode 100644
index b5410f998..000000000
--- a/src/messenger/messenger_api_contact.h
+++ /dev/null
@@ -1,116 +0,0 @@
1/*
2 This file is part of GNUnet.
3 Copyright (C) 2020--2021 GNUnet e.V.
4
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
7 by the Free Software Foundation, either version 3 of the License,
8 or (at your option) any later version.
9
10 GNUnet is distributed in the hope that it will be useful, but
11 WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 Affero General Public License for more details.
14
15 You should have received a copy of the GNU Affero General Public License
16 along with this program. If not, see <http://www.gnu.org/licenses/>.
17
18 SPDX-License-Identifier: AGPL3.0-or-later
19 */
20/**
21 * @author Tobias Frisch
22 * @file src/messenger/messenger_api_contact.h
23 * @brief messenger api: client implementation of GNUnet MESSENGER service
24 */
25
26#ifndef GNUNET_MESSENGER_API_CONTACT_H
27#define GNUNET_MESSENGER_API_CONTACT_H
28
29#include "platform.h"
30#include "gnunet_crypto_lib.h"
31#include "gnunet_identity_service.h"
32
33struct GNUNET_MESSENGER_Contact
34{
35 char *name;
36 size_t rc;
37
38 struct GNUNET_IDENTITY_PublicKey public_key;
39};
40
41/**
42 * Creates and allocates a new contact with a given public <i>key</i> from an EGO.
43 *
44 * @param[in] key Public key
45 * @return New contact
46 */
47struct GNUNET_MESSENGER_Contact*
48create_contact (const struct GNUNET_IDENTITY_PublicKey *key);
49
50/**
51 * Destroys a contact and frees its memory fully.
52 *
53 * @param[in/out] contact Contact
54 */
55void
56destroy_contact (struct GNUNET_MESSENGER_Contact *contact);
57
58/**
59 * Returns the current name of a given <i>contact</i> or NULL if no valid name was assigned yet.
60 *
61 * @param[in] contact Contact
62 * @return Name of the contact or NULL
63 */
64const char*
65get_contact_name (const struct GNUNET_MESSENGER_Contact *contact);
66
67/**
68 * Changes the current name of a given <i>contact</i> by copying it from the parameter <i>name</i>.
69 *
70 * @param[in/out] contact Contact
71 * @param[in] name Name
72 */
73void
74set_contact_name (struct GNUNET_MESSENGER_Contact *contact,
75 const char *name);
76
77/**
78 * Returns the public key of a given <i>contact</i>.
79 *
80 * @param[in] contact Contact
81 * @return Public key of the contact
82 */
83const struct GNUNET_IDENTITY_PublicKey*
84get_contact_key (const struct GNUNET_MESSENGER_Contact *contact);
85
86/**
87 * Increases the reference counter of a given <i>contact</i> which is zero as default.
88 *
89 * @param[in/out] contact Contact
90 */
91void
92increase_contact_rc (struct GNUNET_MESSENGER_Contact *contact);
93
94/**
95 * Decreases the reference counter if possible (can not underflow!) of a given <i>contact</i>
96 * and returns #GNUNET_YES if the counter is equal to zero, otherwise #GNUNET_NO.
97 *
98 * @param[in/out] contact Contact
99 * @return #GNUNET_YES or #GNUNET_NO depending on the reference counter
100 */
101int
102decrease_contact_rc (struct GNUNET_MESSENGER_Contact *contact);
103
104/**
105 * Calculates the context <i>hash</i> of a member in a room and returns it.
106 *
107 * @param[in] key Key of room
108 * @param[in] id Member id
109 * @param[out] hash Member context
110 */
111void
112get_context_from_member (const struct GNUNET_HashCode *key,
113 const struct GNUNET_ShortHashCode *id,
114 struct GNUNET_HashCode *context);
115
116#endif //GNUNET_MESSENGER_API_CONTACT_H