GNUnet  0.19.5
gnunet-service-messenger_handle.h
Go to the documentation of this file.
1 /*
2  This file is part of GNUnet.
3  Copyright (C) 2020--2022 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  */
26 #ifndef GNUNET_SERVICE_MESSENGER_HANDLE_H
27 #define GNUNET_SERVICE_MESSENGER_HANDLE_H
28 
29 #include "platform.h"
30 #include "gnunet_cadet_service.h"
31 #include "gnunet_util_lib.h"
33 
36 
37 #include "messenger_api_ego.h"
38 #include "messenger_api_message.h"
39 
41 {
44 
45  char *name;
46 
47  const struct GNUNET_MESSENGER_Ego *ego;
48 
50 };
51 
61  struct GNUNET_MQ_Handle *mq);
62 
68 void
70 
79 void
81  const char *name,
82  char **dir);
83 
93 const struct GNUNET_ShortHashCode*
95  const struct GNUNET_HashCode *key);
96 
108 int
110  const struct GNUNET_HashCode *key,
111  const struct GNUNET_ShortHashCode *unique_id);
112 
119 void
121  const struct GNUNET_MESSENGER_Ego *ego);
122 
129 const struct GNUNET_MESSENGER_Ego*
131 
138 void
140  const char *name);
141 
148 void
150 
160 void
162  const char *name);
163 
172 int
174  const struct GNUNET_HashCode *key);
175 
185 int
187  const struct GNUNET_PeerIdentity *door,
188  const struct GNUNET_HashCode *key);
189 
198 int
200  const struct GNUNET_HashCode *key);
201 
210 int
212  const struct GNUNET_HashCode *key,
213  const struct GNUNET_MESSENGER_Message *message);
214 
224 void
226  struct GNUNET_MESSENGER_SrvRoom *room,
227  const struct GNUNET_MESSENGER_MemberSession *session,
228  const struct GNUNET_MESSENGER_Message *message,
229  const struct GNUNET_HashCode *hash);
230 
237 void
239 
246 void
248 
249 #endif //GNUNET_SERVICE_MESSENGER_HANDLE_H
struct GNUNET_MQ_Handle * mq
Definition: 003.c:5
static char * dir
Set to the directory where runtime files are stored.
Definition: gnunet-arm.c:89
struct GNUNET_HashCode key
The key used in the DHT.
static struct GNUNET_DNS_Handle * handle
Handle to transport service.
static struct GNUNET_SERVICE_Handle * service
Handle to our service instance.
int change_srv_handle_member_id(struct GNUNET_MESSENGER_SrvHandle *handle, const struct GNUNET_HashCode *key, const struct GNUNET_ShortHashCode *unique_id)
Changes the member id of a given handle in a specific room to match a unique_id and returns GNUNET_OK...
void save_srv_handle_configuration(struct GNUNET_MESSENGER_SrvHandle *handle)
Saves member ids and other potential configuration from a given handle which depends on the given nam...
void notify_srv_handle_message(struct GNUNET_MESSENGER_SrvHandle *handle, struct GNUNET_MESSENGER_SrvRoom *room, const struct GNUNET_MESSENGER_MemberSession *session, const struct GNUNET_MESSENGER_Message *message, const struct GNUNET_HashCode *hash)
Notifies the handle that a new message was received or sent.
int close_srv_handle_room(struct GNUNET_MESSENGER_SrvHandle *handle, const struct GNUNET_HashCode *key)
Removes the membership of the room using a specific key and closes it if no other handle from this se...
void load_srv_handle_configuration(struct GNUNET_MESSENGER_SrvHandle *handle)
Loads member ids and other potential configuration from a given handle which depends on the given nam...
const struct GNUNET_ShortHashCode * get_srv_handle_member_id(const struct GNUNET_MESSENGER_SrvHandle *handle, const struct GNUNET_HashCode *key)
Returns the member id of a given handle in a specific room.
void set_srv_handle_ego(struct GNUNET_MESSENGER_SrvHandle *handle, const struct GNUNET_MESSENGER_Ego *ego)
Sets the EGO used by a given handle.
int open_srv_handle_room(struct GNUNET_MESSENGER_SrvHandle *handle, const struct GNUNET_HashCode *key)
Makes a given handle a member of the room using a specific key and opens the room from the handles se...
void setup_srv_handle_name(struct GNUNET_MESSENGER_SrvHandle *handle, const char *name)
Tries to set the name and EGO key of a handle initially by looking up a specific name.
int entry_srv_handle_room(struct GNUNET_MESSENGER_SrvHandle *handle, const struct GNUNET_PeerIdentity *door, const struct GNUNET_HashCode *key)
Makes a given handle a member of the room using a specific key and enters the room through a tunnel t...
int send_srv_handle_message(struct GNUNET_MESSENGER_SrvHandle *handle, const struct GNUNET_HashCode *key, const struct GNUNET_MESSENGER_Message *message)
Sends a message from a given handle to the room using a specific key.
void set_srv_handle_name(struct GNUNET_MESSENGER_SrvHandle *handle, const char *name)
Tries to rename the handle which implies renaming the EGO its using and moving all related data into ...
const struct GNUNET_MESSENGER_Ego * get_srv_handle_ego(const struct GNUNET_MESSENGER_SrvHandle *handle)
Returns the EGO used by a given handle.
void update_srv_handle(struct GNUNET_MESSENGER_SrvHandle *handle)
Tries to change the key pair of an EGO of a handle under the same name and informs all rooms about th...
void get_srv_handle_data_subdir(const struct GNUNET_MESSENGER_SrvHandle *handle, const char *name, char **dir)
Writes the path of the directory for a given handle using a specific name to the parameter dir.
void destroy_srv_handle(struct GNUNET_MESSENGER_SrvHandle *handle)
Destroys a handle and frees its memory fully.
struct GNUNET_MESSENGER_SrvHandle * create_srv_handle(struct GNUNET_MESSENGER_Service *service, struct GNUNET_MQ_Handle *mq)
Creates and allocates a new handle related to a service and using a given mq (message queue).
GNUnet MESSENGER service.
CADET service; establish channels to distant peers.
Identity service; implements identity management for GNUnet.
GNUnet MESSENGER service.
messenger api: client and service implementation of GNUnet MESSENGER service
const char * name
Internal representation of the hash map.
A 512-bit hashcode.
struct GNUNET_MESSENGER_Service * service
const struct GNUNET_MESSENGER_Ego * ego
struct GNUNET_CONTAINER_MultiHashMap * member_ids
Handle to a message queue.
Definition: mq.c:87
The identity of the host (wraps the signing key of the peer).
A 256-bit hashcode.