aboutsummaryrefslogtreecommitdiff
path: root/src/messenger/gnunet-service-messenger_ego_store.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/messenger/gnunet-service-messenger_ego_store.h')
-rw-r--r--src/messenger/gnunet-service-messenger_ego_store.h152
1 files changed, 152 insertions, 0 deletions
diff --git a/src/messenger/gnunet-service-messenger_ego_store.h b/src/messenger/gnunet-service-messenger_ego_store.h
new file mode 100644
index 000000000..41f14fff2
--- /dev/null
+++ b/src/messenger/gnunet-service-messenger_ego_store.h
@@ -0,0 +1,152 @@
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/gnunet-service-messenger_ego_store.h
23 * @brief GNUnet MESSENGER service
24 */
25
26#ifndef GNUNET_SERVICE_MESSENGER_EGO_STORE_H
27#define GNUNET_SERVICE_MESSENGER_EGO_STORE_H
28
29#include "platform.h"
30#include "gnunet_container_lib.h"
31
32#include "messenger_api_ego.h"
33
34struct GNUNET_MESSENGER_Ego;
35struct GNUNET_MESSENGER_EgoStore;
36
37typedef void
38(*GNUNET_MESSENGER_EgoLookupCallback) (void *cls, const char *identifier,
39 const struct GNUNET_MESSENGER_Ego *ego);
40
41struct GNUNET_MESSENGER_EgoLookup
42{
43 struct GNUNET_MESSENGER_EgoLookup *prev;
44 struct GNUNET_MESSENGER_EgoLookup *next;
45
46 struct GNUNET_IDENTITY_EgoLookup *lookup;
47
48 struct GNUNET_MESSENGER_EgoStore *store;
49
50 GNUNET_MESSENGER_EgoLookupCallback cb;
51 void *cls;
52
53 char *identifier;
54};
55
56struct GNUNET_MESSENGER_EgoOperation
57{
58 struct GNUNET_MESSENGER_EgoOperation *prev;
59 struct GNUNET_MESSENGER_EgoOperation *next;
60
61 struct GNUNET_IDENTITY_Operation *operation;
62
63 struct GNUNET_MESSENGER_EgoStore *store;
64 void *handle;
65
66 char *identifier;
67};
68
69struct GNUNET_MESSENGER_EgoStore
70{
71 const struct GNUNET_CONFIGURATION_Handle *cfg;
72
73 struct GNUNET_IDENTITY_Handle *identity;
74 struct GNUNET_CONTAINER_MultiHashMap *egos;
75
76 struct GNUNET_MESSENGER_EgoLookup *lu_start;
77 struct GNUNET_MESSENGER_EgoLookup *lu_end;
78
79 struct GNUNET_MESSENGER_EgoOperation *op_start;
80 struct GNUNET_MESSENGER_EgoOperation *op_end;
81};
82
83/**
84 * Initializes an EGO-store as fully empty.
85 *
86 * @param[out] store EGO-store
87 * @param[in] config Configuration handle
88 */
89void
90init_ego_store (struct GNUNET_MESSENGER_EgoStore *store, const struct GNUNET_CONFIGURATION_Handle *config);
91
92/**
93 * Clears an EGO-store, wipes its content and deallocates its memory.
94 *
95 * @param[in/out] store EGO-store
96 */
97void
98clear_ego_store (struct GNUNET_MESSENGER_EgoStore *store);
99
100/**
101 * Creates a new EGO which will be registered to a <i>store</i> under
102 * a specific <i>identifier</i>. A given <i>handle</i> will be informed
103 * about the creation and changes its EGO accordingly.
104 *
105 * @param[in/out] store EGO-store
106 * @param[in] identifier Identifier string
107 * @param[in/out] handle Handle or NULL
108 */
109void
110create_store_ego (struct GNUNET_MESSENGER_EgoStore *store, const char *identifier,
111 void *handle);
112
113/**
114 * Lookups an EGO which was registered to a <i>store</i> under
115 * a specific <i>identifier</i>.
116 *
117 * @param[in/out] store EGO-store
118 * @param[in] identifier Identifier string
119 * @param[in] lookup Lookup callback (non-NULL)
120 * @param[in] cls Closure
121 */
122void
123lookup_store_ego (struct GNUNET_MESSENGER_EgoStore *store, const char *identifier,
124 GNUNET_MESSENGER_EgoLookupCallback lookup, void *cls);
125
126/**
127 * Updates the registration of an EGO to a <i>store</i> under
128 * a specific <i>identifier</i> with a new <i>key</i>.
129 *
130 * @param[in/out] store EGO-store
131 * @param[in] identifier Identifier string
132 * @param[in] key Private EGO key
133 * @return Updated EGO
134 */
135struct GNUNET_MESSENGER_Ego*
136update_store_ego (struct GNUNET_MESSENGER_EgoStore *store, const char *identifier,
137 const struct GNUNET_IDENTITY_PrivateKey *key);
138
139/**
140 * Updates the location of a registered EGO in a <i>store</i> to
141 * a different one under a specific <i>new_identifier<i> replacing
142 * its old one.
143 *
144 * @param[in/out] store EGO-store
145 * @param[in] old_identifier Old identifier string
146 * @param[in] new_identifier New identifier string
147 */
148void
149rename_store_ego (struct GNUNET_MESSENGER_EgoStore *store, const char *old_identifier,
150 const char *new_identifier);
151
152#endif //GNUNET_SERVICE_MESSENGER_EGO_STORE_H