aboutsummaryrefslogtreecommitdiff
path: root/src/messenger/messenger_api_contact_store.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/messenger/messenger_api_contact_store.h')
-rw-r--r--src/messenger/messenger_api_contact_store.h127
1 files changed, 0 insertions, 127 deletions
diff --git a/src/messenger/messenger_api_contact_store.h b/src/messenger/messenger_api_contact_store.h
deleted file mode 100644
index bdab2ceeb..000000000
--- a/src/messenger/messenger_api_contact_store.h
+++ /dev/null
@@ -1,127 +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_store.h
23 * @brief messenger api: client implementation of GNUnet MESSENGER service
24 */
25
26#ifndef GNUNET_MESSENGER_API_CONTACT_STORE_H
27#define GNUNET_MESSENGER_API_CONTACT_STORE_H
28
29#include "platform.h"
30#include "gnunet_container_lib.h"
31#include "gnunet_crypto_lib.h"
32#include "gnunet_identity_service.h"
33
34struct GNUNET_MESSENGER_Contact;
35
36struct GNUNET_MESSENGER_ContactStore
37{
38 struct GNUNET_CONTAINER_MultiHashMap *anonymous;
39 struct GNUNET_CONTAINER_MultiHashMap *contacts;
40};
41
42/**
43 * Initializes a contact store as fully empty.
44 *
45 * @param[out] store Contact store
46 */
47void
48init_contact_store (struct GNUNET_MESSENGER_ContactStore *store);
49
50/**
51 * Clears a contact store, wipes its content and deallocates its memory.
52 *
53 * @param[in/out] store Contact store
54 */
55void
56clear_contact_store (struct GNUNET_MESSENGER_ContactStore *store);
57
58/**
59 * Returns a contact using the hash of a specific public key. In case the anonymous
60 * key gets used by the requested contact, it will use its provided member
61 * <i>context</i> to select the matching contact from the <i>store</i>.
62 *
63 * In case there is no contact stored which uses the given key or context,
64 * NULL gets returned.
65 *
66 * @param[in/out] store Contact store
67 * @param[in] context Member context
68 * @param[in] key_hash Hash of public key
69 */
70struct GNUNET_MESSENGER_Contact*
71get_store_contact_raw (struct GNUNET_MESSENGER_ContactStore *store,
72 const struct GNUNET_HashCode *context,
73 const struct GNUNET_HashCode *key_hash);
74
75/**
76 * Returns a contact using a specific public key. In case the anonymous
77 * key gets used by the requested contact, it will use its provided member
78 * <i>context</i> to select the matching contact from the <i>store</i>.
79 *
80 * In case there is no contact stored which uses the given key or context,
81 * a new contact will be created automatically.
82 *
83 * The function returns NULL if an error occurs during allocation
84 * or validation of the contacts key.
85 *
86 * @param[in/out] store Contact store
87 * @param[in] context Member context
88 * @param[in] pubkey Public key of EGO
89 */
90struct GNUNET_MESSENGER_Contact*
91get_store_contact (struct GNUNET_MESSENGER_ContactStore *store,
92 const struct GNUNET_HashCode *context,
93 const struct GNUNET_IDENTITY_PublicKey *pubkey);
94
95/**
96 * Moves a <i>contact</i> from the <i>store</i> to another location
97 * matching a given public key and member <i>context</i>.
98 *
99 * This function allows changes of keys or changes of member contexts!
100 *
101 * @param[in/out] store Contact store
102 * @param[in/out] contact Contact
103 * @param[in] context Member context
104 * @param[in] next_context Member context
105 * @param[in] pubkey Public key of EGO
106 */
107void
108update_store_contact (struct GNUNET_MESSENGER_ContactStore *store,
109 struct GNUNET_MESSENGER_Contact* contact,
110 const struct GNUNET_HashCode *context,
111 const struct GNUNET_HashCode *next_context,
112 const struct GNUNET_IDENTITY_PublicKey *pubkey);
113
114/**
115 * Removes a <i>contact</i> from the <i>store</i> which uses
116 * a given member <i>context</i>.
117 *
118 * @param[in/out] store Contact store
119 * @param[in/out] contact Contact
120 * @param[in] context Member context
121 */
122void
123remove_store_contact (struct GNUNET_MESSENGER_ContactStore *store,
124 struct GNUNET_MESSENGER_Contact* contact,
125 const struct GNUNET_HashCode *context);
126
127#endif //GNUNET_MESSENGER_API_CONTACT_STORE_H