GNUnet  0.11.x
gnunet-service-messenger_room.h
Go to the documentation of this file.
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  */
26 #ifndef GNUNET_SERVICE_MESSENGER_ROOM_H
27 #define GNUNET_SERVICE_MESSENGER_ROOM_H
28 
29 #include "platform.h"
30 #include "gnunet_cadet_service.h"
31 #include "gnunet_container_lib.h"
32 #include "gnunet_crypto_lib.h"
34 #include "gnunet_mq_lib.h"
35 
41 
43 
47 #include "messenger_api_ego.h"
48 
49 #define GNUNET_MESSENGER_IDLE_DELAY GNUNET_TIME_relative_multiply \
50  (GNUNET_TIME_relative_get_second_ (), 5)
51 
52 #define GNUNET_MESSENGER_REQUEST_DELAY GNUNET_TIME_relative_multiply \
53  (GNUNET_TIME_relative_get_minute_ (), 5)
54 
55 #define GNUNET_MESSENGER_MERGE_DELAY GNUNET_TIME_relative_multiply \
56  (GNUNET_TIME_relative_get_second_ (), 30)
57 
60 
62 {
66 
68 
70 
74 
77 
79 
82 };
83 
93 
99 void
101 
110 
119 
128 
141 int
143 
154 int
156  const struct GNUNET_PeerIdentity *door);
157 
175 struct GNUNET_MQ_Envelope*
177  struct GNUNET_MESSENGER_Message *message, struct GNUNET_HashCode *hash, int mode);
178 
194 int
196  struct GNUNET_MESSENGER_Message *message);
197 
206 void
208  struct GNUNET_MESSENGER_Message *message, const struct GNUNET_HashCode *hash);
209 
218 void
220 
228 void
230 
241 int
243  const struct GNUNET_HashCode *hash, const struct GNUNET_TIME_Relative delay);
244 
251 struct GNUNET_CADET_Handle*
253 
260 const struct GNUNET_HashCode*
261 get_room_key (const struct GNUNET_MESSENGER_SrvRoom *room);
262 
271 const struct GNUNET_MESSENGER_SrvTunnel*
273 
283  void *cls, struct GNUNET_MESSENGER_SrvRoom *room,
284  const struct GNUNET_MESSENGER_Message *message,
285  const struct GNUNET_HashCode *hash
286 );
287 
303 int
304 request_room_message (struct GNUNET_MESSENGER_SrvRoom *room, const struct GNUNET_HashCode *hash,
305  const struct GNUNET_MESSENGER_MemberSession *session,
306  GNUNET_MESSENGER_MessageRequestCallback callback, void* cls);
307 
317 void
319  const struct GNUNET_ShortHashCode *member_id, struct GNUNET_TIME_Absolute timestamp);
320 
327 void
329 
336 void
337 load_room (struct GNUNET_MESSENGER_SrvRoom *room);
338 
345 void
346 save_room (struct GNUNET_MESSENGER_SrvRoom *room);
347 
348 #endif //GNUNET_SERVICE_MESSENGER_ROOM_H
struct GNUNET_MESSENGER_MemberStore member_store
GNUnet MESSENGER service.
void check_room_peer_status(struct GNUNET_MESSENGER_SrvRoom *room, struct GNUNET_MESSENGER_SrvTunnel *tunnel)
Checks the current state of opening a given room from this peer and re-publishes it if necessary to a...
struct GNUNET_MESSENGER_MessageState state
struct GNUNET_MESSENGER_MessageStore message_store
Opaque handle to the service.
Definition: cadet_api.c:38
void load_room(struct GNUNET_MESSENGER_SrvRoom *room)
Loads the local configuration for a given room of a service which contains the last messages hash and...
void forward_room_message(struct GNUNET_MESSENGER_SrvRoom *room, struct GNUNET_MESSENGER_SrvTunnel *tunnel, struct GNUNET_MESSENGER_Message *message, const struct GNUNET_HashCode *hash)
Forwards a message with a given hash to a specific tunnel inside of a room.
void rebuild_room_basement_structure(struct GNUNET_MESSENGER_SrvRoom *room)
Rebuilds the decentralized structure for a room by ensuring all required connections are made dependi...
GNUnet MESSENGER service.
struct GNUNET_CADET_Port * port
int request_room_message(struct GNUNET_MESSENGER_SrvRoom *room, const struct GNUNET_HashCode *hash, const struct GNUNET_MESSENGER_MemberSession *session, GNUNET_MESSENGER_MessageRequestCallback callback, void *cls)
Requests a message from a room identified by a given hash.
const struct GNUNET_MESSENGER_SrvTunnel * get_room_tunnel(const struct GNUNET_MESSENGER_SrvRoom *room, const struct GNUNET_PeerIdentity *peer)
Returns a tunnel inside of a room leading towards a given peer if such a tunnel exists, otherwise NULL.
static enum @8 mode
Should we do a PUT (mode = 0) or GET (mode = 1);.
struct GNUNET_MESSENGER_SrvRoom * create_room(struct GNUNET_MESSENGER_SrvHandle *handle, const struct GNUNET_HashCode *key)
Creates and allocates a new room for a handle with a given key.
A 256-bit hashcode.
struct GNUNET_MESSENGER_OperationStore operation_store
struct GNUNET_CADET_Handle * get_room_cadet(struct GNUNET_MESSENGER_SrvRoom *room)
Returns the CADET handle from a rooms service.
cryptographic primitives for GNUnet
int send_room_message(struct GNUNET_MESSENGER_SrvRoom *room, struct GNUNET_MESSENGER_SrvHandle *handle, struct GNUNET_MESSENGER_Message *message)
Sends a message from a given handle into a room.
struct GNUNET_SCHEDULER_Task * idle
struct GNUNET_MESSENGER_Service * service
GNUnet MESSENGER service.
struct GNUNET_HashCode * peer_message
void save_room(struct GNUNET_MESSENGER_SrvRoom *room)
Saves the configuration for a given room of a service which contains the last messages hash and the r...
struct GNUNET_MESSENGER_MessageStore * get_room_message_store(struct GNUNET_MESSENGER_SrvRoom *room)
Returns the used message store of a given room.
void() GNUNET_MESSENGER_MessageRequestCallback(void *cls, struct GNUNET_MESSENGER_SrvRoom *room, const struct GNUNET_MESSENGER_Message *message, const struct GNUNET_HashCode *hash)
Method called whenever a message is found during a request in a room.
struct GNUNET_MESSENGER_SrvRoom * room
static struct GNUNET_DNS_Handle * handle
Handle to transport service.
struct GNUNET_MESSENGER_OperationStore * get_room_operation_store(struct GNUNET_MESSENGER_SrvRoom *room)
Returns the used operation store of a given room.
Internal representation of the hash map.
struct GNUNET_MESSENGER_ListMessages handling
A 512-bit hashcode.
struct GNUNET_MESSENGER_MemberStore * get_room_member_store(struct GNUNET_MESSENGER_SrvRoom *room)
Returns the used member store of a given room.
GNUnet MESSENGER service.
int delete_room_message(struct GNUNET_MESSENGER_SrvRoom *room, struct GNUNET_MESSENGER_MemberSession *session, const struct GNUNET_HashCode *hash, const struct GNUNET_TIME_Relative delay)
Deletes a message from the room with a given hash in a specific delay if the provided member by its s...
struct GNUNET_TESTBED_Peer * peer
The peer associated with this model.
struct GNUNET_MESSENGER_SrvHandle * host
struct GNUNET_MQ_Envelope * pack_room_message(const struct GNUNET_MESSENGER_SrvRoom *room, const struct GNUNET_MESSENGER_SrvHandle *handle, struct GNUNET_MESSENGER_Message *message, struct GNUNET_HashCode *hash, int mode)
Packs a message depending on the selected mode into a newly allocated envelope.
void solve_room_member_collisions(struct GNUNET_MESSENGER_SrvRoom *room, const struct GNUNET_IDENTITY_PublicKey *public_key, const struct GNUNET_ShortHashCode *member_id, struct GNUNET_TIME_Absolute timestamp)
Checks for potential collisions with member ids and solves them changing active handles ids if they u...
static struct GNUNET_TIME_Relative delay
When should dkg communication start?
void merge_room_last_messages(struct GNUNET_MESSENGER_SrvRoom *room, struct GNUNET_MESSENGER_SrvHandle *handle)
Reduces all current forks inside of the message history of a room to one remaining last message by me...
The identity of the host (wraps the signing key of the peer).
An identity key as per LSD0001.
void destroy_room(struct GNUNET_MESSENGER_SrvRoom *room)
Destroys a room and frees its memory fully.
messenger api: client and service implementation of GNUnet MESSENGER service
struct GNUNET_MESSENGER_ListTunnels basement
Entry in list of pending tasks.
Definition: scheduler.c:134
Opaque handle to a port.
Definition: cadet_api.c:79
Time for absolute times used by GNUnet, in microseconds.
int enter_room_at(struct GNUNET_MESSENGER_SrvRoom *room, struct GNUNET_MESSENGER_SrvHandle *handle, const struct GNUNET_PeerIdentity *door)
Connects a tunnel to a hosting peer of a room through a so called door which is represented by a peer...
int open_room(struct GNUNET_MESSENGER_SrvRoom *room, struct GNUNET_MESSENGER_SrvHandle *handle)
Tries to open a room for a given handle.
const struct GNUNET_HashCode * get_room_key(const struct GNUNET_MESSENGER_SrvRoom *room)
Returns the shared secret you need to access a room.
struct GNUNET_CONTAINER_MultiPeerMap * tunnels
Time for relative time used by GNUnet, in microseconds.