GNUnet  0.11.x
Data Structures | Typedefs | Functions
gnunet-service-messenger_member_store.h File Reference

GNUnet MESSENGER service. More...

#include "platform.h"
#include "gnunet_crypto_lib.h"
#include "gnunet_container_lib.h"
#include "gnunet_identity_service.h"
#include "messenger_api_message.h"
Include dependency graph for gnunet-service-messenger_member_store.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_MemberStore
 

Typedefs

typedef int(* GNUNET_MESSENGER_MemberIteratorCallback) (void *cls, const struct GNUNET_IDENTITY_PublicKey *public_key, struct GNUNET_MESSENGER_MemberSession *session)
 

Functions

void init_member_store (struct GNUNET_MESSENGER_MemberStore *store, struct GNUNET_MESSENGER_SrvRoom *room)
 Initializes a member store as fully empty connected to a room. More...
 
void clear_member_store (struct GNUNET_MESSENGER_MemberStore *store)
 Clears a member store, wipes its content and deallocates its memory. More...
 
struct GNUNET_MESSENGER_ContactStoreget_member_contact_store (struct GNUNET_MESSENGER_MemberStore *store)
 Returns the used contact store of a given member store. More...
 
const struct GNUNET_HashCodeget_member_store_key (const struct GNUNET_MESSENGER_MemberStore *store)
 Returns the shared secret you need to access a room of the store. More...
 
void load_member_store (struct GNUNET_MESSENGER_MemberStore *store, const char *directory)
 Loads members from a directory into a member store. More...
 
void save_member_store (struct GNUNET_MESSENGER_MemberStore *store, const char *directory)
 Saves members from a member store into a directory. More...
 
struct GNUNET_MESSENGER_Memberget_store_member (const struct GNUNET_MESSENGER_MemberStore *store, const struct GNUNET_ShortHashCode *id)
 Returns the member in a store identified by a given id. More...
 
struct GNUNET_MESSENGER_Memberget_store_member_of (struct GNUNET_MESSENGER_MemberStore *store, const struct GNUNET_MESSENGER_Message *message)
 Returns the member of a store using a sender id of a given message. More...
 
struct GNUNET_MESSENGER_Memberadd_store_member (struct GNUNET_MESSENGER_MemberStore *store, const struct GNUNET_ShortHashCode *id)
 Adds a member to a store under a specific id and returns it on success. More...
 
int iterate_store_members (struct GNUNET_MESSENGER_MemberStore *store, GNUNET_MESSENGER_MemberIteratorCallback it, void *cls)
 Iterate through all member sessions currently connected to the members of the given member store and call the provided iterator callback with a selected closure. More...
 

Detailed Description

GNUnet MESSENGER service.

Author
Tobias Frisch

Definition in file gnunet-service-messenger_member_store.h.

Typedef Documentation

◆ GNUNET_MESSENGER_MemberIteratorCallback

typedef int(* GNUNET_MESSENGER_MemberIteratorCallback) (void *cls, const struct GNUNET_IDENTITY_PublicKey *public_key, struct GNUNET_MESSENGER_MemberSession *session)

Definition at line 47 of file gnunet-service-messenger_member_store.h.

Function Documentation

◆ init_member_store()

void init_member_store ( struct GNUNET_MESSENGER_MemberStore store,
struct GNUNET_MESSENGER_SrvRoom room 
)

Initializes a member store as fully empty connected to a room.

Parameters
[out]storeMember store
roomRoom

Definition at line 33 of file gnunet-service-messenger_member_store.c.

35 {
36  GNUNET_assert ((store) && (room));
37 
38  store->room = room;
40 }
@ GNUNET_NO
Definition: gnunet_common.h:94
struct GNUNET_CONTAINER_MultiShortmap * GNUNET_CONTAINER_multishortmap_create(unsigned int len, int do_not_copy_keys)
Create a multi peer map (hash map for public keys of peers).
#define GNUNET_assert(cond)
Use this for fatal errors that cannot be handled.
struct GNUNET_CONTAINER_MultiShortmap * members

References GNUNET_assert, GNUNET_CONTAINER_multishortmap_create(), GNUNET_NO, GNUNET_MESSENGER_MemberStore::members, and GNUNET_MESSENGER_MemberStore::room.

Referenced by create_room().

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

◆ clear_member_store()

void clear_member_store ( struct GNUNET_MESSENGER_MemberStore store)

Clears a member store, wipes its content and deallocates its memory.

Parameters
[in/out]store Member store

Definition at line 53 of file gnunet-service-messenger_member_store.c.

54 {
55  GNUNET_assert ((store) && (store->members));
56 
59 }
static int iterate_destroy_members(void *cls, const struct GNUNET_ShortHashCode *key, void *value)
int GNUNET_CONTAINER_multishortmap_iterate(struct GNUNET_CONTAINER_MultiShortmap *map, GNUNET_CONTAINER_ShortmapIterator it, void *it_cls)
Iterate over all entries in the map.
void GNUNET_CONTAINER_multishortmap_destroy(struct GNUNET_CONTAINER_MultiShortmap *map)
Destroy a hash map.

References GNUNET_assert, GNUNET_CONTAINER_multishortmap_destroy(), GNUNET_CONTAINER_multishortmap_iterate(), iterate_destroy_members(), GNUNET_MESSENGER_MemberStore::members, and GNUNET_MESSENGER_Member::store.

Referenced by destroy_room().

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

◆ get_member_contact_store()

struct GNUNET_MESSENGER_ContactStore* get_member_contact_store ( struct GNUNET_MESSENGER_MemberStore store)

Returns the used contact store of a given member store.

Parameters
[in/out]store Member store
Returns
Contact store

Definition at line 63 of file gnunet-service-messenger_member_store.c.

64 {
65  GNUNET_assert ((store) && (store->room));
66 
67  struct GNUNET_MESSENGER_SrvRoom *room = store->room;
68 
69  return get_service_contact_store(room->service);
70 }
struct GNUNET_MESSENGER_ContactStore * get_service_contact_store(struct GNUNET_MESSENGER_Service *service)
Returns the used contact store of a given service.
struct GNUNET_MESSENGER_Service * service

References get_service_contact_store(), GNUNET_assert, GNUNET_MESSENGER_MemberStore::room, and GNUNET_MESSENGER_SrvRoom::service.

Referenced by check_member_session_completion(), create_member_session(), destroy_member_session(), reset_member_session(), and switch_member_session().

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

◆ get_member_store_key()

const struct GNUNET_HashCode* get_member_store_key ( const struct GNUNET_MESSENGER_MemberStore store)

Returns the shared secret you need to access a room of the store.

Parameters
[in]storeMember store
Returns
Shared secret

Definition at line 73 of file gnunet-service-messenger_member_store.c.

74 {
75  GNUNET_assert (store);
76 
77  return get_room_key((const struct GNUNET_MESSENGER_SrvRoom*) store->room);
78 }
const struct GNUNET_HashCode * get_room_key(const struct GNUNET_MESSENGER_SrvRoom *room)
Returns the shared secret you need to access a room.

References get_room_key(), GNUNET_assert, and GNUNET_MESSENGER_MemberStore::room.

Referenced by get_member_session_key().

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

◆ load_member_store()

void load_member_store ( struct GNUNET_MESSENGER_MemberStore store,
const char *  directory 
)

Loads members from a directory into a member store.

Parameters
[out]storeMember store
[in]directoryPath to a directory

Definition at line 137 of file gnunet-service-messenger_member_store.c.

139 {
140  GNUNET_assert ((store) && (directory));
141 
142  char *scan_dir;
143  GNUNET_asprintf (&scan_dir, "%s%s%c", directory, "members", DIR_SEPARATOR);
144 
147 
150 
152 }
static int iterate_sync_member_contacts(void *cls, const struct GNUNET_ShortHashCode *id, void *value)
static int iterate_load_next_member_sessions(void *cls, const struct GNUNET_ShortHashCode *id, void *value)
static int callback_scan_for_members(void *cls, const char *filename)
@ GNUNET_OK
Definition: gnunet_common.h:95
@ GNUNET_YES
Definition: gnunet_common.h:97
enum GNUNET_GenericReturnValue GNUNET_DISK_directory_test(const char *fil, int is_readable)
Test if fil is a directory and listable.
Definition: disk.c:404
int GNUNET_DISK_directory_scan(const char *dir_name, GNUNET_FileNameCallback callback, void *callback_cls)
Scan a directory for files.
Definition: disk.c:814
int int GNUNET_asprintf(char **buf, const char *format,...) __attribute__((format(printf
Like asprintf, just portable.
#define GNUNET_free(ptr)
Wrapper around free.
#define DIR_SEPARATOR
Definition: platform.h:164

References callback_scan_for_members(), DIR_SEPARATOR, GNUNET_asprintf(), GNUNET_assert, GNUNET_CONTAINER_multishortmap_iterate(), GNUNET_DISK_directory_scan(), GNUNET_DISK_directory_test(), GNUNET_free, GNUNET_OK, GNUNET_YES, iterate_load_next_member_sessions(), iterate_sync_member_contacts(), GNUNET_MESSENGER_MemberStore::members, find_typedefs::scan_dir(), and GNUNET_MESSENGER_Member::store.

Referenced by load_room().

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

◆ save_member_store()

void save_member_store ( struct GNUNET_MESSENGER_MemberStore store,
const char *  directory 
)

Saves members from a member store into a directory.

Parameters
[in]storeMember store
[in]directoryPath to a directory

Definition at line 178 of file gnunet-service-messenger_member_store.c.

180 {
181  GNUNET_assert ((store) && (directory));
182 
183  char* save_dir;
184  GNUNET_asprintf (&save_dir, "%s%s%c", directory, "members", DIR_SEPARATOR);
185 
186  if ((GNUNET_YES == GNUNET_DISK_directory_test (save_dir, GNUNET_NO)) ||
187  (GNUNET_OK == GNUNET_DISK_directory_create (save_dir)))
189 
190  GNUNET_free(save_dir);
191 }
static int iterate_save_members(void *cls, const struct GNUNET_ShortHashCode *id, void *value)
enum GNUNET_GenericReturnValue GNUNET_DISK_directory_create(const char *dir)
Implementation of "mkdir -p".
Definition: disk.c:496

References DIR_SEPARATOR, GNUNET_asprintf(), GNUNET_assert, GNUNET_CONTAINER_multishortmap_iterate(), GNUNET_DISK_directory_create(), GNUNET_DISK_directory_test(), GNUNET_free, GNUNET_NO, GNUNET_OK, GNUNET_YES, iterate_save_members(), GNUNET_MESSENGER_MemberStore::members, and GNUNET_MESSENGER_Member::store.

Referenced by save_room().

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

◆ get_store_member()

struct GNUNET_MESSENGER_Member* get_store_member ( const struct GNUNET_MESSENGER_MemberStore store,
const struct GNUNET_ShortHashCode id 
)

Returns the member in a store identified by a given id.

If the store does not contain a member with the given id, NULL gets returned.

Parameters
[in]storeMember store
[in]idMember id
Returns
Member or NULL

Definition at line 194 of file gnunet-service-messenger_member_store.c.

196 {
197  GNUNET_assert ((store) && (store->members) && (id));
198 
199  return GNUNET_CONTAINER_multishortmap_get (store->members, id);
200 }
void * GNUNET_CONTAINER_multishortmap_get(const struct GNUNET_CONTAINER_MultiShortmap *map, const struct GNUNET_ShortHashCode *key)
Given a key find a value in the map matching the key.

References GNUNET_assert, GNUNET_CONTAINER_multishortmap_get(), GNUNET_MESSENGER_MemberStore::members, and GNUNET_MESSENGER_Member::store.

Referenced by add_store_member(), get_handle_member_session(), get_store_member_of(), handle_get_message(), load_member_session_next(), open_room(), and solve_room_member_collisions().

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

◆ get_store_member_of()

struct GNUNET_MESSENGER_Member* get_store_member_of ( struct GNUNET_MESSENGER_MemberStore store,
const struct GNUNET_MESSENGER_Message message 
)

Returns the member of a store using a sender id of a given message.

If the member does not provide a matching session, NULL gets returned.

Parameters
[in/out]store Member store
[in]messageMessage
Returns
Member or NULL

Definition at line 203 of file gnunet-service-messenger_member_store.c.

205 {
206  if ((GNUNET_MESSENGER_KIND_INFO == message->header.kind) ||
207  (GNUNET_MESSENGER_KIND_JOIN == message->header.kind))
208  return add_store_member(store, &(message->header.sender_id));
209  else
210  return get_store_member(store, &(message->header.sender_id));
211 }
struct GNUNET_MESSENGER_Member * get_store_member(const struct GNUNET_MESSENGER_MemberStore *store, const struct GNUNET_ShortHashCode *id)
Returns the member in a store identified by a given id.
struct GNUNET_MESSENGER_Member * add_store_member(struct GNUNET_MESSENGER_MemberStore *store, const struct GNUNET_ShortHashCode *id)
Adds a member to a store under a specific id and returns it on success.
@ GNUNET_MESSENGER_KIND_INFO
The info kind.
@ GNUNET_MESSENGER_KIND_JOIN
The join kind.
enum GNUNET_MESSENGER_MessageKind kind
The kind of the message.
struct GNUNET_ShortHashCode sender_id
The senders id inside of the room the message was sent in.
struct GNUNET_MESSENGER_MessageHeader header
Header.

References add_store_member(), get_store_member(), GNUNET_MESSENGER_KIND_INFO, GNUNET_MESSENGER_KIND_JOIN, GNUNET_MESSENGER_Message::header, GNUNET_MESSENGER_MessageHeader::kind, GNUNET_MESSENGER_MessageHeader::sender_id, and GNUNET_MESSENGER_Member::store.

Referenced by callback_found_message(), callback_room_handle_message(), check_room_peer_status(), handle_room_messages(), and recv_message_request().

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

◆ add_store_member()

struct GNUNET_MESSENGER_Member* add_store_member ( struct GNUNET_MESSENGER_MemberStore store,
const struct GNUNET_ShortHashCode id 
)

Adds a member to a store under a specific id and returns it on success.

Parameters
[in/out]store Member store
[in]idMember id
Returns
Member or NULL

Definition at line 214 of file gnunet-service-messenger_member_store.c.

216 {
217  GNUNET_assert ((store) && (store->members));
218 
219  struct GNUNET_MESSENGER_Member *member = id? get_store_member(store, id) : NULL;
220 
221  if (member)
222  return member;
223 
224  member = create_member(store, id);
225 
226  if (!member)
227  return NULL;
228 
231  {
232  destroy_member(member);
233  return NULL;
234  }
235 
236  return member;
237 }
struct GNUNET_MESSENGER_Member * create_member(struct GNUNET_MESSENGER_MemberStore *store, const struct GNUNET_ShortHashCode *id)
Creates and allocates a new member of a room with an optionally defined or random id.
void destroy_member(struct GNUNET_MESSENGER_Member *member)
Destroys a member and frees its memory fully.
const struct GNUNET_ShortHashCode * get_member_id(const struct GNUNET_MESSENGER_Member *member)
Returns the current id of a given member.
int GNUNET_CONTAINER_multishortmap_put(struct GNUNET_CONTAINER_MultiShortmap *map, const struct GNUNET_ShortHashCode *key, void *value, enum GNUNET_CONTAINER_MultiHashMapOption opt)
Store a key-value pair in the map.
@ GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_FAST
, ' bother checking if a value already exists (faster than GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE...
struct GNUNET_MESSENGER_MemberStore * store

References create_member(), destroy_member(), get_member_id(), get_store_member(), GNUNET_assert, GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_FAST, GNUNET_CONTAINER_multishortmap_put(), GNUNET_OK, GNUNET_MESSENGER_MemberStore::members, and GNUNET_MESSENGER_Member::store.

Referenced by get_store_member_of(), join_room_locally(), load_member(), open_room(), and switch_member_session().

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

◆ iterate_store_members()

int iterate_store_members ( struct GNUNET_MESSENGER_MemberStore store,
GNUNET_MESSENGER_MemberIteratorCallback  it,
void *  cls 
)

Iterate through all member sessions currently connected to the members of the given member store and call the provided iterator callback with a selected closure.

The function will return the amount of members it iterated through.

Parameters
[in/out]store Member store
[in]itIterator callback
[in/out]cls Closure
Returns
Amount of members iterated through

Definition at line 256 of file gnunet-service-messenger_member_store.c.

259 {
260  GNUNET_assert ((store) && (store->members) && (it));
261 
263 
264  iterate.it = it;
265  iterate.cls = cls;
266 
268 }
static int iterate_store_members_it(void *cls, const struct GNUNET_ShortHashCode *key, void *value)

References GNUNET_MESSENGER_ClosureIterateMembers::cls, GNUNET_assert, GNUNET_CONTAINER_multishortmap_iterate(), GNUNET_MESSENGER_ClosureIterateMembers::it, iterate_store_members_it(), GNUNET_MESSENGER_MemberStore::members, and GNUNET_MESSENGER_Member::store.

Referenced by callback_room_handle_message(), join_room_locally(), and recv_message_info().

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