1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
|
/*
This file is part of GNUnet.
Copyright (C) 2020--2021 GNUnet e.V.
GNUnet is free software: you can redistribute it and/or modify it
under the terms of the GNU Affero General Public License as published
by the Free Software Foundation, either version 3 of the License,
or (at your option) any later version.
GNUnet is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
SPDX-License-Identifier: AGPL3.0-or-later
*/
/**
* @author Tobias Frisch
* @file src/messenger/messenger_api_room.h
* @brief messenger api: client implementation of GNUnet MESSENGER service
*/
#ifndef GNUNET_MESSENGER_API_ROOM_H
#define GNUNET_MESSENGER_API_ROOM_H
#include "platform.h"
#include "gnunet_container_lib.h"
#include "gnunet_crypto_lib.h"
#include "gnunet_messenger_service.h"
#include "messenger_api_list_tunnels.h"
#include "messenger_api_contact.h"
#include "messenger_api_message.h"
struct GNUNET_MESSENGER_RoomMessageEntry {
struct GNUNET_MESSENGER_Contact* sender;
struct GNUNET_MESSENGER_Message* message;
};
struct GNUNET_MESSENGER_Room
{
struct GNUNET_MESSENGER_Handle *handle;
struct GNUNET_HashCode key;
int opened;
struct GNUNET_ShortHashCode *contact_id;
struct GNUNET_MESSENGER_ListTunnels entries;
struct GNUNET_CONTAINER_MultiHashMap *messages;
struct GNUNET_CONTAINER_MultiShortmap *members;
};
/**
* Creates and allocates a new room for a <i>handle</i> with a given <i>key</i> for the client API.
*
* @param[in/out] handle Handle
* @param[in] key Key of room
* @return New room
*/
struct GNUNET_MESSENGER_Room*
create_room (struct GNUNET_MESSENGER_Handle *handle, const struct GNUNET_HashCode *key);
/**
* Destroys a room and frees its memory fully from the client API.
*
* @param[in/out] room Room
*/
void
destroy_room (struct GNUNET_MESSENGER_Room *room);
/**
* Returns a message locally stored from a map for a given <i>hash</i> in a <i>room</i>. If no matching
* message is found, NULL gets returned.
*
* @param[in] room Room
* @param[in] hash Hash of message
* @return Message or NULL
*/
const struct GNUNET_MESSENGER_Message*
get_room_message (const struct GNUNET_MESSENGER_Room *room, const struct GNUNET_HashCode *hash);
/**
* Returns a messages sender locally stored from a map for a given <i>hash</i> in a <i>room</i>. If no
* matching message is found, NULL gets returned.
*
* @param[in] room Room
* @param[in] hash Hash of message
* @return Contact of sender or NULL
*/
struct GNUNET_MESSENGER_Contact*
get_room_sender (const struct GNUNET_MESSENGER_Room *room, const struct GNUNET_HashCode *hash);
/**
* Handles a <i>message</i> with a given <i>hash</i> in a <i>room</i> for the client API to update
* members and its information. The function also stores the message in map locally for access afterwards.
*
* The contact of the message's sender could be updated or even created. It may not be freed or destroyed though!
* (The contact may still be in use for old messages...)
*
* @param[in/out] room Room
* @param[in/out] sender Contact of sender
* @param[in] message Message
* @param[in] hash Hash of message
* @return Contact of sender
*/
struct GNUNET_MESSENGER_Contact*
handle_room_message (struct GNUNET_MESSENGER_Room *room, struct GNUNET_MESSENGER_Contact *sender,
const struct GNUNET_MESSENGER_Message *message, const struct GNUNET_HashCode *hash);
/**
* Iterates through all members of a given <i>room</i> to forward each of them to a selected
* <i>callback</i> with a custom closure.
*
* @param[in/out] room Room
* @param[in] callback Function called for each member
* @param[in/out] cls Closure
* @return Amount of members iterated
*/
int
iterate_room_members (struct GNUNET_MESSENGER_Room *room, GNUNET_MESSENGER_MemberCallback callback,
void* cls);
#endif //GNUNET_MESSENGER_API_ROOM_H
|