gnunet-service-messenger_member_store.h File Reference

#include "gnunet_util_lib.h"
#include "gnunet_messenger_service.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 enum GNUNET_GenericReturnValue(*	GNUNET_MESSENGER_MemberIteratorCallback) (void *cls, const struct GNUNET_CRYPTO_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_ContactStore *	get_member_contact_store (struct GNUNET_MESSENGER_MemberStore *store)
	Returns the used contact store of a given member store. More...
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. 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_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. More...
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. More...
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. 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...

Typedef Documentation

GNUNET_MESSENGER_MemberIteratorCallback

typedef enum GNUNET_GenericReturnValue(* GNUNET_MESSENGER_MemberIteratorCallback) (void *cls, const struct GNUNET_CRYPTO_PublicKey *public_key, struct GNUNET_MESSENGER_MemberSession *session)

Definition at line 1 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]	store	Member store
	room	Room

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

{
  GNUNET_assert ((store) && (room));
 
  store->room = room;
  store->members = GNUNET_CONTAINER_multishortmap_create (8, GNUNET_NO);
}

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

Referenced by create_srv_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 58 of file gnunet-service-messenger_member_store.c.

{
  GNUNET_assert ((store) && (store->members));
 
  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Clear member store of room: %s\n",
              GNUNET_h2s (get_srv_room_key (store->room)));
 
  GNUNET_CONTAINER_multishortmap_iterate (store->members,
                                          iterate_destroy_members, NULL);
  GNUNET_CONTAINER_multishortmap_destroy (store->members);
}

References get_srv_room_key(), GNUNET_assert, GNUNET_CONTAINER_multishortmap_destroy(), GNUNET_CONTAINER_multishortmap_iterate(), GNUNET_ERROR_TYPE_DEBUG, GNUNET_h2s(), GNUNET_log, iterate_destroy_members(), GNUNET_MESSENGER_MemberStore::members, GNUNET_MESSENGER_MemberStore::room, and GNUNET_MESSENGER_Member::store.

Referenced by destroy_srv_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 72 of file gnunet-service-messenger_member_store.c.

{
  GNUNET_assert ((store) && (store->room));
 
  struct GNUNET_MESSENGER_SrvRoom *room = store->room;
 
  return get_service_contact_store (room->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]

store

Member store

Returns

Shared secret

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

{
  GNUNET_assert (store);
 
  return get_srv_room_key ((const struct
                            GNUNET_MESSENGER_SrvRoom*) store->room);
}

References get_srv_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]	store	Member store
[in]	directory	Path to a directory

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

{
  GNUNET_assert ((store) && (directory));
 
  char *scan_dir;
  GNUNET_asprintf (&scan_dir, "%s%s%c", directory, "members", DIR_SEPARATOR);
 
  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Load member store from directory: %s\n",
              scan_dir);
 
  if (GNUNET_OK == GNUNET_DISK_directory_test (scan_dir, GNUNET_YES))
    GNUNET_DISK_directory_scan (scan_dir, callback_scan_for_members, store);
 
  GNUNET_CONTAINER_multishortmap_iterate (store->members,
                                          iterate_load_next_member_sessions,
                                          scan_dir);
  GNUNET_CONTAINER_multishortmap_iterate (store->members,
                                          iterate_sync_member_contacts, NULL);
 
  GNUNET_free (scan_dir);
}

References callback_scan_for_members(), DIR_SEPARATOR, GNUNET_asprintf(), GNUNET_assert, GNUNET_CONTAINER_multishortmap_iterate(), GNUNET_DISK_directory_scan(), GNUNET_DISK_directory_test(), GNUNET_ERROR_TYPE_DEBUG, GNUNET_free, GNUNET_log, 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_srv_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]	store	Member store
[in]	directory	Path to a directory

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

{
  GNUNET_assert ((store) && (directory));
 
  char *save_dir;
  GNUNET_asprintf (&save_dir, "%s%s%c", directory, "members", DIR_SEPARATOR);
 
  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Save member store to directory: %s\n",
              save_dir);
 
  if ((GNUNET_YES == GNUNET_DISK_directory_test (save_dir, GNUNET_NO)) ||
      (GNUNET_OK == GNUNET_DISK_directory_create (save_dir)))
    GNUNET_CONTAINER_multishortmap_iterate (store->members,
                                            iterate_save_members, save_dir);
 
  GNUNET_free (save_dir);
}

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

Referenced by save_srv_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]	store	Member store
[in]	id	Member id

Returns

Member or NULL

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

{
  GNUNET_assert ((store) && (store->members) && (id));
 
  return GNUNET_CONTAINER_multishortmap_get (store->members, id);
}

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(), and solve_srv_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 message is a peer message or the member does not provide a matching session, NULL gets returned.

Parameters

[in,out]	store	Member store
[in]	message	Message

Returns

Member or NULL

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

{
  GNUNET_assert ((store) && (message));
 
  if (GNUNET_YES == is_peer_message (message))
    return NULL;
 
  if (GNUNET_MESSENGER_KIND_JOIN == message->header.kind)
    return add_store_member (store, &(message->header.sender_id));
  else
    return get_store_member (store, &(message->header.sender_id));
}

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

Referenced by callback_found_message(), callback_room_handle_message(), 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]	id	Member id

Returns

Member or NULL

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

{
  GNUNET_assert ((store) && (store->members));
 
  struct GNUNET_MESSENGER_Member *member = id? get_store_member (store, id) :
                                           NULL;
 
  if (member)
    return member;
 
  member = create_member (store, id);
 
  if (! member)
    return NULL;
 
  if (GNUNET_OK != GNUNET_CONTAINER_multishortmap_put (store->members,
                                                       get_member_id (member),
                                                       member,
                                                       GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_FAST))
  {
    destroy_member (member);
    return NULL;
  }
 
  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Added store member with id: %s\n",
              GNUNET_sh2s (get_member_id (member)));
 
  return member;
}

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

Referenced by get_store_member_of(), join_room_locally(), load_member(), open_srv_room(), send_message_join(), 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]	it	Iterator callback
[in,out]	cls	Closure

Returns

Amount of members iterated through

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

{
  GNUNET_assert ((store) && (store->members) && (it));
 
  struct GNUNET_MESSENGER_ClosureIterateMembers iterate;
 
  iterate.it = it;
  iterate.cls = cls;
 
  return GNUNET_CONTAINER_multishortmap_iterate (store->members,
                                                 iterate_store_members_it,
                                                 &iterate);
}

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(), initialize_service_handle(), recv_message_info(), and send_message_join().

Here is the call graph for this function:

Here is the caller graph for this function: