GNUnet 0.22.2
Data Structures | Functions
messenger_api_handle.h File Reference
#include "gnunet_util_lib.h"
#include "gnunet_messenger_service.h"
#include "messenger_api_contact_store.h"
Include dependency graph for messenger_api_handle.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  GNUNET_MESSENGER_Handle
 

Functions

struct GNUNET_MESSENGER_Handle * create_handle (const struct GNUNET_CONFIGURATION_Handle *cfg, GNUNET_MESSENGER_MessageCallback msg_callback, void *msg_cls)
 Creates and allocates a new handle using a given configuration and a custom message callback with a given closure for the client API. More...
 
void destroy_handle (struct GNUNET_MESSENGER_Handle *handle)
 Destroys a handle and frees its memory fully from the client API. More...
 
void set_handle_name (struct GNUNET_MESSENGER_Handle *handle, const char *name)
 Sets the name of a handle to a specific name. More...
 
const char * get_handle_name (const struct GNUNET_MESSENGER_Handle *handle)
 Returns the current name of a given handle or NULL if no valid name was assigned yet. More...
 
void set_handle_key (struct GNUNET_MESSENGER_Handle *handle, const struct GNUNET_CRYPTO_PrivateKey *key)
 Sets the keypair of a given handle to the keypair of a specific private key. More...
 
const struct GNUNET_CRYPTO_PrivateKey * get_handle_key (const struct GNUNET_MESSENGER_Handle *handle)
 Returns the private key of a given handle. More...
 
const struct GNUNET_CRYPTO_PublicKey * get_handle_pubkey (const struct GNUNET_MESSENGER_Handle *handle)
 Returns the public key of a given handle. More...
 
struct GNUNET_MESSENGER_ContactStore * get_handle_contact_store (struct GNUNET_MESSENGER_Handle *handle)
 Returns the used contact store of a given handle. More...
 
struct GNUNET_MESSENGER_Contact * get_handle_contact (struct GNUNET_MESSENGER_Handle *handle, const struct GNUNET_HashCode *key)
 Returns the contact of a given handle in a room identified by a given key. More...
 
void open_handle_room (struct GNUNET_MESSENGER_Handle *handle, const struct GNUNET_HashCode *key)
 Marks a room known to a handle identified by a given key as open. More...
 
void entry_handle_room_at (struct GNUNET_MESSENGER_Handle *handle, const struct GNUNET_PeerIdentity *door, const struct GNUNET_HashCode *key)
 Adds a tunnel for a room known to a handle identified by a given key to a list of opened connections. More...
 
void close_handle_room (struct GNUNET_MESSENGER_Handle *handle, const struct GNUNET_HashCode *key)
 Destroys and so implicitly closes a room known to a handle identified by a given key. More...
 
struct GNUNET_MESSENGER_Room * get_handle_room (struct GNUNET_MESSENGER_Handle *handle, const struct GNUNET_HashCode *key)
 Returns the room known to a handle identified by a given key. More...
 

Function Documentation

◆ create_handle()

struct GNUNET_MESSENGER_Handle * create_handle ( const struct GNUNET_CONFIGURATION_Handle *  cfg,
GNUNET_MESSENGER_MessageCallback  msg_callback,
void *  msg_cls 
)

Creates and allocates a new handle using a given configuration and a custom message callback with a given closure for the client API.

Parameters
[in]cfgConfiguration
[in]msg_callbackMessage callback
[in,out]msg_clsClosure
Returns
New handle

Definition at line 32 of file messenger_api_handle.c.

35{
36 struct GNUNET_MESSENGER_Handle *handle;
37
38 GNUNET_assert (cfg);
39
40 handle = GNUNET_new (struct GNUNET_MESSENGER_Handle);
41
42 handle->cfg = cfg;
43 handle->mq = NULL;
44
45 handle->msg_callback = msg_callback;
46 handle->msg_cls = msg_cls;
47
48 handle->name = NULL;
49 handle->key = NULL;
50 handle->pubkey = NULL;
51
52 handle->reconnect_time = GNUNET_TIME_relative_get_zero_ ();
53 handle->reconnect_task = NULL;
54
55 handle->rooms = GNUNET_CONTAINER_multihashmap_create (8, GNUNET_NO);
56
57 init_contact_store (get_handle_contact_store (handle));
58
59 return handle;
60}
cfg
static struct GNUNET_CONFIGURATION_Handle * cfg
Our configuration.
Definition: gnunet-arm.c:108
handle
static struct GNUNET_VPN_Handle * handle
Handle to vpn service.
Definition: gnunet-vpn.c:35
GNUNET_CONTAINER_multihashmap_create
struct GNUNET_CONTAINER_MultiHashMap * GNUNET_CONTAINER_multihashmap_create(unsigned int len, int do_not_copy_keys)
Create a multi hash map.
Definition: container_multihashmap.c:180
GNUNET_NO
@ GNUNET_NO
Definition: gnunet_common.h:110
GNUNET_assert
#define GNUNET_assert(cond)
Use this for fatal errors that cannot be handled.
Definition: gnunet_common.h:957
GNUNET_new
#define GNUNET_new(type)
Allocate a struct or union of the given type.
Definition: gnunet_common.h:1237
GNUNET_TIME_relative_get_zero_
struct GNUNET_TIME_Relative GNUNET_TIME_relative_get_zero_(void)
Return relative time of 0ms.
Definition: time.c:133
init_contact_store
void init_contact_store(struct GNUNET_MESSENGER_ContactStore *store)
Initializes a contact store as fully empty.
Definition: messenger_api_contact_store.c:33
get_handle_contact_store
struct GNUNET_MESSENGER_ContactStore * get_handle_contact_store(struct GNUNET_MESSENGER_Handle *handle)
Returns the used contact store of a given handle.
Definition: messenger_api_handle.c:190
GNUNET_MESSENGER_Handle
Definition: messenger_api_handle.h:36
GNUNET_MESSENGER_Handle::msg_cls
void * msg_cls
Definition: messenger_api_handle.h:42
GNUNET_MESSENGER_Handle::msg_callback
GNUNET_MESSENGER_MessageCallback msg_callback
Definition: messenger_api_handle.h:41
GNUNET_VPN_Handle::cfg
const struct GNUNET_CONFIGURATION_Handle * cfg
Configuration we use.
Definition: vpn_api.c:39
GNUNET_VPN_Handle::mq
struct GNUNET_MQ_Handle * mq
Connection to VPN service.
Definition: vpn_api.c:44

References cfg, GNUNET_VPN_Handle::cfg, get_handle_contact_store(), GNUNET_assert, GNUNET_CONTAINER_multihashmap_create(), GNUNET_new, GNUNET_NO, GNUNET_TIME_relative_get_zero_(), handle, init_contact_store(), GNUNET_VPN_Handle::mq, GNUNET_MESSENGER_Handle::msg_callback, and GNUNET_MESSENGER_Handle::msg_cls.

Referenced by GNUNET_MESSENGER_connect().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ destroy_handle()

void destroy_handle ( struct GNUNET_MESSENGER_Handle *  handle)

Destroys a handle and frees its memory fully from the client API.

Parameters
[in,out]handleHandle

Definition at line 80 of file messenger_api_handle.c.

81{
82 GNUNET_assert (handle);
83
84 clear_contact_store (get_handle_contact_store (handle));
85
86 if (handle->rooms)
87 {
88 GNUNET_CONTAINER_multihashmap_iterate (handle->rooms, iterate_destroy_room,
89 NULL);
90
91 GNUNET_CONTAINER_multihashmap_destroy (handle->rooms);
92 }
93
94 if (handle->reconnect_task)
95 GNUNET_SCHEDULER_cancel (handle->reconnect_task);
96
97 if (handle->mq)
98 GNUNET_MQ_destroy (handle->mq);
99
100 if (handle->name)
101 GNUNET_free (handle->name);
102
103 if (handle->key)
104 GNUNET_free (handle->key);
105
106 if (handle->pubkey)
107 GNUNET_free (handle->pubkey);
108
109 GNUNET_free (handle);
110}
GNUNET_CONTAINER_multihashmap_iterate
int GNUNET_CONTAINER_multihashmap_iterate(struct GNUNET_CONTAINER_MultiHashMap *map, GNUNET_CONTAINER_MultiHashMapIteratorCallback it, void *it_cls)
Iterate over all entries in the map.
Definition: container_multihashmap.c:309
GNUNET_CONTAINER_multihashmap_destroy
void GNUNET_CONTAINER_multihashmap_destroy(struct GNUNET_CONTAINER_MultiHashMap *map)
Destroy a hash map.
Definition: container_multihashmap.c:215
GNUNET_free
#define GNUNET_free(ptr)
Wrapper around free.
Definition: gnunet_common.h:1412
GNUNET_MQ_destroy
void GNUNET_MQ_destroy(struct GNUNET_MQ_Handle *mq)
Destroy the message queue.
Definition: mq.c:700
GNUNET_SCHEDULER_cancel
void * GNUNET_SCHEDULER_cancel(struct GNUNET_SCHEDULER_Task *task)
Cancel the task with the specified identifier.
Definition: scheduler.c:980
clear_contact_store
void clear_contact_store(struct GNUNET_MESSENGER_ContactStore *store)
Clears a contact store, wipes its content and deallocates its memory.
Definition: messenger_api_contact_store.c:61
iterate_destroy_room
static enum GNUNET_GenericReturnValue iterate_destroy_room(void *cls, const struct GNUNET_HashCode *key, void *value)
Definition: messenger_api_handle.c:64

References clear_contact_store(), get_handle_contact_store(), GNUNET_assert, GNUNET_CONTAINER_multihashmap_destroy(), GNUNET_CONTAINER_multihashmap_iterate(), GNUNET_free, GNUNET_MQ_destroy(), GNUNET_SCHEDULER_cancel(), handle, iterate_destroy_room(), and GNUNET_VPN_Handle::mq.

Referenced by GNUNET_MESSENGER_connect(), and GNUNET_MESSENGER_disconnect().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ set_handle_name()

void set_handle_name ( struct GNUNET_MESSENGER_Handle *  handle,
const char *  name 
)

Sets the name of a handle to a specific name.

Parameters
[in,out]handleHandle
[in]nameNew name

Definition at line 114 of file messenger_api_handle.c.

116{
117 GNUNET_assert (handle);
118
119 if (handle->name)
120 GNUNET_free (handle->name);
121
122 handle->name = name ? GNUNET_strdup (name) : NULL;
123}
name
static char * name
Name (label) of the records to list.
Definition: gnunet-namecache.c:48
GNUNET_strdup
#define GNUNET_strdup(a)
Wrapper around GNUNET_xstrdup_.
Definition: gnunet_common.h:1426

References GNUNET_assert, GNUNET_free, GNUNET_strdup, handle, and name.

Referenced by GNUNET_MESSENGER_connect(), and GNUNET_MESSENGER_set_name().

Here is the caller graph for this function:

◆ get_handle_name()

const char * get_handle_name ( const struct GNUNET_MESSENGER_Handle *  handle)

Returns the current name of a given handle or NULL if no valid name was assigned yet.

Parameters
[in]handleHandle
Returns
Name of the handle or NULL

Definition at line 127 of file messenger_api_handle.c.

128{
129 GNUNET_assert (handle);
130
131 return handle->name;
132}

References GNUNET_assert, and handle.

Referenced by GNUNET_MESSENGER_get_name(), handle_name_message(), iterate_send_name_to_room(), and send_message_to_room_with_key().

Here is the caller graph for this function:

◆ set_handle_key()

void set_handle_key ( struct GNUNET_MESSENGER_Handle *  handle,
const struct GNUNET_CRYPTO_PrivateKey *  key 
)

Sets the keypair of a given handle to the keypair of a specific private key.

Parameters
[in,out]handleHandle
[in]keyPrivate key or NULL

Definition at line 136 of file messenger_api_handle.c.

138{
139 GNUNET_assert (handle);
140
141 if (! key)
142 {
143 if (handle->key)
144 GNUNET_free (handle->key);
145
146 if (handle->pubkey)
147 GNUNET_free (handle->pubkey);
148
149 handle->key = NULL;
150 handle->pubkey = NULL;
151 return;
152 }
153
154 if (! handle->key)
155 handle->key = GNUNET_new (struct GNUNET_CRYPTO_PrivateKey);
156
157 if (! handle->pubkey)
158 handle->pubkey = GNUNET_new (struct GNUNET_CRYPTO_PublicKey);
159
160 GNUNET_memcpy (handle->key, key, sizeof(*key));
161 GNUNET_CRYPTO_key_get_public (key, handle->pubkey);
162}
key
struct GNUNET_HashCode key
The key used in the DHT.
Definition: gnunet-dht-put.c:37
GNUNET_CRYPTO_key_get_public
enum GNUNET_GenericReturnValue GNUNET_CRYPTO_key_get_public(const struct GNUNET_CRYPTO_PrivateKey *privkey, struct GNUNET_CRYPTO_PublicKey *key)
Retrieves the public key representation of a private key.
Definition: crypto_pkey.c:430
GNUNET_memcpy
#define GNUNET_memcpy(dst, src, n)
Call memcpy() but check for n being 0 first.
Definition: gnunet_common.h:1317
GNUNET_CRYPTO_PrivateKey
A private key for an identity as per LSD0001.
Definition: gnunet_crypto_lib.h:400
GNUNET_CRYPTO_PublicKey
An identity key as per LSD0001.
Definition: gnunet_crypto_lib.h:427

References GNUNET_assert, GNUNET_CRYPTO_key_get_public(), GNUNET_free, GNUNET_memcpy, GNUNET_new, handle, and key.

Referenced by GNUNET_MESSENGER_connect(), and GNUNET_MESSENGER_set_key().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ get_handle_key()

const struct GNUNET_CRYPTO_PrivateKey * get_handle_key ( const struct GNUNET_MESSENGER_Handle *  handle)

Returns the private key of a given handle.

Parameters
[in]handleHandle
Returns
Private key of the handle

Definition at line 166 of file messenger_api_handle.c.

167{
168 GNUNET_assert (handle);
169
170 if (handle->key)
171 return handle->key;
172
173 return get_anonymous_private_key ();
174}
get_anonymous_private_key
const struct GNUNET_CRYPTO_PrivateKey * get_anonymous_private_key(void)
Returns the private identity key of GNUNET_IDENTITY_ego_get_anonymous() without recalculating it ever...
Definition: messenger_api_util.c:85

References get_anonymous_private_key(), GNUNET_assert, and handle.

Referenced by enqueue_message_to_room(), handle_member_id(), and handle_private_message().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ get_handle_pubkey()

const struct GNUNET_CRYPTO_PublicKey * get_handle_pubkey ( const struct GNUNET_MESSENGER_Handle *  handle)

Returns the public key of a given handle.

Parameters
[in]handleHandle
Returns
Public key of the handle

Definition at line 178 of file messenger_api_handle.c.

179{
180 GNUNET_assert (handle);
181
182 if (handle->pubkey)
183 return handle->pubkey;
184
185 return get_anonymous_public_key ();
186}
get_anonymous_public_key
const struct GNUNET_CRYPTO_PublicKey * get_anonymous_public_key(void)
Returns the public identity key of GNUNET_IDENTITY_ego_get_anonymous() without recalculating it every...
Definition: messenger_api_util.c:94

References get_anonymous_public_key(), GNUNET_assert, and handle.

Referenced by get_handle_contact(), GNUNET_MESSENGER_get_key(), send_enter_room(), send_message_to_room_with_key(), and send_open_room().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ get_handle_contact_store()

struct GNUNET_MESSENGER_ContactStore * get_handle_contact_store ( struct GNUNET_MESSENGER_Handle *  handle)

Returns the used contact store of a given handle.

Parameters
[in,out]handleHandle
Returns
Contact store

Definition at line 190 of file messenger_api_handle.c.

191{
192 GNUNET_assert (handle);
193
194 return &(handle->contact_store);
195}

References GNUNET_assert, and handle.

Referenced by create_handle(), destroy_handle(), get_handle_contact(), handle_id_message(), handle_join_message(), handle_key_message(), handle_transcript_message(), process_message_control(), and task_message_control().

Here is the caller graph for this function:

◆ get_handle_contact()

struct GNUNET_MESSENGER_Contact * get_handle_contact ( struct GNUNET_MESSENGER_Handle *  handle,
const struct GNUNET_HashCode *  key 
)

Returns the contact of a given handle in a room identified by a given key.

Parameters
[in,out]handleHandle
[in]keyKey of room
Returns
Contact

Definition at line 199 of file messenger_api_handle.c.

201{
202 struct GNUNET_MESSENGER_Room *room;
203 const struct GNUNET_ShortHashCode *contact_id;
204
205 GNUNET_assert ((handle) && (key));
206
207 room = GNUNET_CONTAINER_multihashmap_get (handle->rooms, key);
208
209 if (! room)
210 return NULL;
211
212 contact_id = get_room_sender_id (room);
213
214 if (! contact_id)
215 return NULL;
216
217 {
218 struct GNUNET_HashCode context;
219 get_context_from_member (key, contact_id, &context);
220
221 return get_store_contact (get_handle_contact_store (handle),
222 &context,
223 get_handle_pubkey (handle));
224 }
225}
context
static pa_context * context
Pulseaudio context.
Definition: gnunet-helper-audio-playback.c:81
GNUNET_CONTAINER_multihashmap_get
void * GNUNET_CONTAINER_multihashmap_get(const struct GNUNET_CONTAINER_MultiHashMap *map, const struct GNUNET_HashCode *key)
Given a key find a value in the map matching the key.
Definition: container_multihashmap.c:281
get_context_from_member
void get_context_from_member(const struct GNUNET_HashCode *key, const struct GNUNET_ShortHashCode *id, struct GNUNET_HashCode *context)
Calculates the context hash of a member in a room and returns it.
Definition: messenger_api_contact.c:122
get_store_contact
struct GNUNET_MESSENGER_Contact * get_store_contact(struct GNUNET_MESSENGER_ContactStore *store, const struct GNUNET_HashCode *context, const struct GNUNET_CRYPTO_PublicKey *pubkey)
Returns a contact using a specific public key.
Definition: messenger_api_contact_store.c:120
get_handle_pubkey
const struct GNUNET_CRYPTO_PublicKey * get_handle_pubkey(const struct GNUNET_MESSENGER_Handle *handle)
Returns the public key of a given handle.
Definition: messenger_api_handle.c:178
get_room_sender_id
const struct GNUNET_ShortHashCode * get_room_sender_id(const struct GNUNET_MESSENGER_Room *room)
Returns the member id of the room's sender.
Definition: messenger_api_room.c:206
GNUNET_HashCode
A 512-bit hashcode.
Definition: gnunet_common.h:284
GNUNET_MESSENGER_Room
Definition: messenger_api_room.h:61
GNUNET_ShortHashCode
A 256-bit hashcode.
Definition: gnunet_common.h:294

References context, get_context_from_member(), get_handle_contact_store(), get_handle_pubkey(), get_room_sender_id(), get_store_contact(), GNUNET_assert, GNUNET_CONTAINER_multihashmap_get(), handle, and key.

Referenced by handle_delete_message(), handle_private_message(), and handle_transcript_message().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ open_handle_room()

void open_handle_room ( struct GNUNET_MESSENGER_Handle *  handle,
const struct GNUNET_HashCode *  key 
)

Marks a room known to a handle identified by a given key as open.

Parameters
[in,out]handleHandle
[in]keyKey of room

Definition at line 229 of file messenger_api_handle.c.

231{
232 struct GNUNET_MESSENGER_Room *room;
233
234 GNUNET_assert ((handle) && (key));
235
236 room = GNUNET_CONTAINER_multihashmap_get (handle->rooms, key);
237
238 if (room)
239 room->opened = GNUNET_YES;
240}
GNUNET_YES
@ GNUNET_YES
Definition: gnunet_common.h:113
GNUNET_MESSENGER_Room::opened
enum GNUNET_GenericReturnValue opened
Definition: messenger_api_room.h:67

References GNUNET_assert, GNUNET_CONTAINER_multihashmap_get(), GNUNET_YES, handle, key, and GNUNET_MESSENGER_Room::opened.

Referenced by handle_room_open().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ entry_handle_room_at()

void entry_handle_room_at ( struct GNUNET_MESSENGER_Handle *  handle,
const struct GNUNET_PeerIdentity *  door,
const struct GNUNET_HashCode *  key 
)

Adds a tunnel for a room known to a handle identified by a given key to a list of opened connections.

Parameters
[in,out]handleHandle
[in]doorPeer identity
[in]keyKey of room

Definition at line 244 of file messenger_api_handle.c.

247{
248 struct GNUNET_MESSENGER_Room *room;
249
250 GNUNET_assert ((handle) && (door) && (key));
251
252 room = GNUNET_CONTAINER_multihashmap_get (handle->rooms, key);
253
254 if (room)
255 add_to_list_tunnels (&(room->entries), door, NULL);
256}
add_to_list_tunnels
void add_to_list_tunnels(struct GNUNET_MESSENGER_ListTunnels *tunnels, const struct GNUNET_PeerIdentity *peer, const struct GNUNET_HashCode *hash)
Adds a specific peer from a tunnel to the end of the list.
Definition: messenger_api_list_tunnels.c:71
GNUNET_MESSENGER_Room::entries
struct GNUNET_MESSENGER_ListTunnels entries
Definition: messenger_api_room.h:73

References add_to_list_tunnels(), GNUNET_MESSENGER_Room::entries, GNUNET_assert, GNUNET_CONTAINER_multihashmap_get(), handle, and key.

Referenced by handle_room_entry().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ close_handle_room()

void close_handle_room ( struct GNUNET_MESSENGER_Handle *  handle,
const struct GNUNET_HashCode *  key 
)

Destroys and so implicitly closes a room known to a handle identified by a given key.

Parameters
[in,out]handleHandle
[in]keyKey of room

Definition at line 260 of file messenger_api_handle.c.

262{
263 struct GNUNET_MESSENGER_Room *room;
264
265 GNUNET_assert ((handle) && (key));
266
267 room = GNUNET_CONTAINER_multihashmap_get (handle->rooms, key);
268
269 if ((room) && (GNUNET_YES == GNUNET_CONTAINER_multihashmap_remove (
270 handle->rooms, key, room)))
271 destroy_room (room);
272}
GNUNET_CONTAINER_multihashmap_remove
enum GNUNET_GenericReturnValue GNUNET_CONTAINER_multihashmap_remove(struct GNUNET_CONTAINER_MultiHashMap *map, const struct GNUNET_HashCode *key, const void *value)
Remove the given key-value pair from the map.
Definition: container_multihashmap.c:406
destroy_room
void destroy_room(struct GNUNET_MESSENGER_Room *room)
Destroys a room and frees its memory fully from the client API.
Definition: messenger_api_room.c:134

References destroy_room(), GNUNET_assert, GNUNET_CONTAINER_multihashmap_get(), GNUNET_CONTAINER_multihashmap_remove(), GNUNET_YES, handle, and key.

Referenced by handle_room_close().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ get_handle_room()

struct GNUNET_MESSENGER_Room * get_handle_room ( struct GNUNET_MESSENGER_Handle *  handle,
const struct GNUNET_HashCode *  key 
)

Returns the room known to a handle identified by a given key.

Parameters
[in,out]handlehandle Handle
[in]keyKey of room
Returns
Room or NULL

Definition at line 276 of file messenger_api_handle.c.

278{
279 GNUNET_assert ((handle) && (key));
280
281 return GNUNET_CONTAINER_multihashmap_get (handle->rooms, key);
282}

References GNUNET_assert, GNUNET_CONTAINER_multihashmap_get(), handle, and key.

Referenced by handle_member_id(), handle_miss_message(), handle_recv_message(), handle_room_close(), handle_room_entry(), handle_room_open(), and handle_room_sync().

Here is the call graph for this function:
Here is the caller graph for this function: