gnunet-service-messenger_service.h File Reference

GNUnet MESSENGER service. More...

#include "platform.h"
#include "gnunet_configuration_lib.h"
#include "gnunet_util_lib.h"
#include "gnunet_identity_service.h"
#include "gnunet-service-messenger_ego_store.h"
#include "gnunet-service-messenger_list_handles.h"
#include "messenger_api_contact_store.h"
#include "gnunet-service-messenger_room.h"
#include "gnunet-service-messenger_member_session.h"

Include dependency graph for gnunet-service-messenger_service.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_Service

Functions
struct GNUNET_MESSENGER_Service *	create_service (const struct GNUNET_CONFIGURATION_Handle *config, struct GNUNET_SERVICE_Handle *service_handle)
	Creates and allocates a new service using a given config and a GNUnet service handle. More...
void	destroy_service (struct GNUNET_MESSENGER_Service *service)
	Destroys a service and frees its memory fully. More...
struct GNUNET_MESSENGER_EgoStore *	get_service_ego_store (struct GNUNET_MESSENGER_Service *service)
	Returns the used EGO-store of a given service. More...
struct GNUNET_MESSENGER_ContactStore *	get_service_contact_store (struct GNUNET_MESSENGER_Service *service)
	Returns the used contact store of a given service. More...
struct GNUNET_MESSENGER_SrvHandle *	add_service_handle (struct GNUNET_MESSENGER_Service *service, struct GNUNET_MQ_Handle *mq)
	Creates and adds a new handle to a service using a given message queue. More...
void	remove_service_handle (struct GNUNET_MESSENGER_Service *service, struct GNUNET_MESSENGER_SrvHandle *handle)
	Removes a handle from a service and destroys it. More...
int	get_service_peer_identity (const struct GNUNET_MESSENGER_Service *service, struct GNUNET_PeerIdentity *peer)
	Tries to write the peer identity of the peer running a service on to the peer parameter. More...
struct GNUNET_MESSENGER_SrvRoom *	get_service_room (const struct GNUNET_MESSENGER_Service *service, const struct GNUNET_HashCode *key)
	Returns the room identified by a given key for a service. More...
int	open_service_room (struct GNUNET_MESSENGER_Service *service, struct GNUNET_MESSENGER_SrvHandle *handle, const struct GNUNET_HashCode *key)
	Tries to open a room using a given key for a service by a specific handle. More...
int	entry_service_room (struct GNUNET_MESSENGER_Service *service, struct GNUNET_MESSENGER_SrvHandle *handle, const struct GNUNET_PeerIdentity *door, const struct GNUNET_HashCode *key)
	Tries to enter a room using a given key for a service by a specific handle. More...
int	close_service_room (struct GNUNET_MESSENGER_Service *service, struct GNUNET_MESSENGER_SrvHandle *handle, const struct GNUNET_HashCode *key)
	Tries to close a room using a given key for a service by a specific handle. More...
void	handle_service_message (struct GNUNET_MESSENGER_Service *service, struct GNUNET_MESSENGER_SrvRoom *room, const struct GNUNET_MESSENGER_MemberSession *session, const struct GNUNET_MESSENGER_Message *message, const struct GNUNET_HashCode *hash)
	Sends a received or sent message with a given hash to each handle of a service which is currently member of a specific room for handling it in the client API. More...

Detailed Description

GNUnet MESSENGER service.

Author

Tobias Frisch

Definition in file gnunet-service-messenger_service.h.

Function Documentation

create_service()

struct GNUNET_MESSENGER_Service* create_service	(	const struct GNUNET_CONFIGURATION_Handle *	config,
		struct GNUNET_SERVICE_Handle *	service_handle
	)

Creates and allocates a new service using a given config and a GNUnet service handle.

Parameters

[in]	config	Configuration
[in,out]	service_handle	GNUnet service handle

Returns

New service

Definition at line 45 of file gnunet-service-messenger_service.c.

{
  GNUNET_assert((config) && (service_handle));
 
  struct GNUNET_MESSENGER_Service *service = GNUNET_new(struct GNUNET_MESSENGER_Service);
 
  service->config = config;
  service->service = service_handle;
 
  service->shutdown = GNUNET_SCHEDULER_add_shutdown (&callback_shutdown_service, service);
 
  service->dir = NULL;
 
  if (GNUNET_OK != GNUNET_CONFIGURATION_get_value_filename (service->config,
  GNUNET_MESSENGER_SERVICE_NAME,
                                                            "MESSENGER_DIR", &(service->dir)))
  {
    if (service->dir)
      GNUNET_free(service->dir);
 
    service->dir = NULL;
  }
  else
  {
    if ((GNUNET_YES != GNUNET_DISK_directory_test (service->dir, GNUNET_YES)) && (GNUNET_OK
        != GNUNET_DISK_directory_create (service->dir)))
    {
      GNUNET_free(service->dir);
 
      service->dir = NULL;
    }
  }
 
  service->cadet = GNUNET_CADET_connect (service->config);
 
  init_ego_store(get_service_ego_store(service), service->config);
 
  init_list_handles (&(service->handles));
 
  service->rooms = GNUNET_CONTAINER_multihashmap_create (8, GNUNET_NO);
 
  init_contact_store(get_service_contact_store(service));
 
  return service;
}

References callback_shutdown_service(), config, get_service_contact_store(), get_service_ego_store(), GNUNET_assert, GNUNET_CADET_connect(), GNUNET_CONFIGURATION_get_value_filename(), GNUNET_CONTAINER_multihashmap_create(), GNUNET_DISK_directory_create(), GNUNET_DISK_directory_test(), GNUNET_free, GNUNET_MESSENGER_SERVICE_NAME, GNUNET_new, GNUNET_NO, GNUNET_OK, GNUNET_SCHEDULER_add_shutdown(), GNUNET_YES, init_contact_store(), init_ego_store(), init_list_handles(), and service.

Referenced by run().

Here is the call graph for this function:

Here is the caller graph for this function:

destroy_service()

void destroy_service

(

struct GNUNET_MESSENGER_Service *

service

)

Destroys a service and frees its memory fully.

Parameters

[in,out]

service

Service

Definition at line 103 of file gnunet-service-messenger_service.c.

{
  GNUNET_assert(service);
 
  if (service->shutdown)
  {
    GNUNET_SCHEDULER_cancel (service->shutdown);
 
    service->shutdown = NULL;
  }
 
  clear_ego_store(get_service_ego_store(service));
  clear_list_handles (&(service->handles));
 
  GNUNET_CONTAINER_multihashmap_iterate (service->rooms, iterate_destroy_rooms, NULL);
  GNUNET_CONTAINER_multihashmap_destroy (service->rooms);
 
  clear_contact_store(get_service_contact_store(service));
 
  if (service->cadet)
  {
    GNUNET_CADET_disconnect (service->cadet);
 
    service->cadet = NULL;
  }
 
  if (service->dir)
  {
    GNUNET_free(service->dir);
 
    service->dir = NULL;
  }
 
  GNUNET_SERVICE_shutdown (service->service);
 
  GNUNET_free(service);
}

References clear_contact_store(), clear_ego_store(), clear_list_handles(), get_service_contact_store(), get_service_ego_store(), GNUNET_assert, GNUNET_CADET_disconnect(), GNUNET_CONTAINER_multihashmap_destroy(), GNUNET_CONTAINER_multihashmap_iterate(), GNUNET_free, GNUNET_SCHEDULER_cancel(), GNUNET_SERVICE_shutdown(), iterate_destroy_rooms(), and service.

Referenced by callback_shutdown_service().

Here is the call graph for this function:

Here is the caller graph for this function:

get_service_ego_store()

struct GNUNET_MESSENGER_EgoStore* get_service_ego_store

(

struct GNUNET_MESSENGER_Service *

service

)

Returns the used EGO-store of a given service.

Parameters

[in,out]

service

Service

Returns

EGO-store

Definition at line 142 of file gnunet-service-messenger_service.c.

{
  GNUNET_assert(service);
 
  return &(service->ego_store);
}

References GNUNET_assert, and service.

Referenced by callback_set_handle_name(), callback_update_handle(), create_service(), destroy_service(), destroy_srv_handle(), set_srv_handle_name(), setup_srv_handle_name(), and update_srv_handle().

Here is the caller graph for this function:

get_service_contact_store()

struct GNUNET_MESSENGER_ContactStore* get_service_contact_store

(

struct GNUNET_MESSENGER_Service *

service

)

Returns the used contact store of a given service.

Parameters

[in,out]

service

Service

Returns

Contact store

Definition at line 150 of file gnunet-service-messenger_service.c.

{
  GNUNET_assert(service);
 
  return &(service->contact_store);
}

References GNUNET_assert, and service.

Referenced by create_service(), destroy_service(), and get_member_contact_store().

Here is the caller graph for this function:

add_service_handle()

struct GNUNET_MESSENGER_SrvHandle* add_service_handle	(	struct GNUNET_MESSENGER_Service *	service,
		struct GNUNET_MQ_Handle *	mq
	)

Creates and adds a new handle to a service using a given message queue.

Parameters

[in,out]	service	Service
[in,out]	mq	Message queue

Returns

New handle

Definition at line 158 of file gnunet-service-messenger_service.c.

{
  GNUNET_assert((service) && (mq));
 
  struct GNUNET_MESSENGER_SrvHandle *handle = create_srv_handle (service, mq);
 
  if (handle)
  {
    add_list_handle (&(service->handles), handle);
  }
 
  return handle;
}

References add_list_handle(), create_srv_handle(), GNUNET_assert, handle, mq, and service.

Referenced by callback_client_connect().

Here is the call graph for this function:

Here is the caller graph for this function:

remove_service_handle()

void remove_service_handle	(	struct GNUNET_MESSENGER_Service *	service,
		struct GNUNET_MESSENGER_SrvHandle *	handle
	)

Removes a handle from a service and destroys it.

Parameters

[in,out]	service	Service
[in,out]	handle	Handle

Definition at line 174 of file gnunet-service-messenger_service.c.

{
  GNUNET_assert((service) && (handle));
 
  if (!handle)
    return;
 
  if (GNUNET_YES == remove_list_handle (&(service->handles), handle))
    destroy_srv_handle (handle);
}

References destroy_srv_handle(), GNUNET_assert, GNUNET_YES, handle, remove_list_handle(), and service.

Referenced by callback_client_disconnect().

Here is the call graph for this function:

Here is the caller graph for this function:

get_service_peer_identity()

int get_service_peer_identity	(	const struct GNUNET_MESSENGER_Service *	service,
		struct GNUNET_PeerIdentity *	peer
	)

Tries to write the peer identity of the peer running a service on to the peer parameter.

The functions returns GNUNET_OK on success, otherwise GNUNET_SYSERR.

Parameters

[in]	service	Service
[out]	peer	Peer identity

Returns

GNUNET_OK on success, otherwise GNUNET_SYSERR

Definition at line 187 of file gnunet-service-messenger_service.c.

{
  GNUNET_assert((service) && (peer));
 
  return GNUNET_CRYPTO_get_peer_identity (service->config, peer);
}

References GNUNET_assert, GNUNET_CRYPTO_get_peer_identity(), peer, and service.

Referenced by create_message_peer(), enter_srv_room_at(), and rebuild_srv_room_basement_structure().

Here is the call graph for this function:

Here is the caller graph for this function:

get_service_room()

struct GNUNET_MESSENGER_SrvRoom* get_service_room	(	const struct GNUNET_MESSENGER_Service *	service,
		const struct GNUNET_HashCode *	key
	)

Returns the room identified by a given key for a service.

If the service doesn't know any room using the given key, NULL gets returned.

Parameters

[in]	service	Service
[in]	key	Key of room

Returns

Room or NULL

Definition at line 196 of file gnunet-service-messenger_service.c.

{
  GNUNET_assert((service) && (key));
 
  return GNUNET_CONTAINER_multihashmap_get (service->rooms, key);
}

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

Referenced by close_service_room(), entry_service_room(), handle_get_message(), open_service_room(), and send_srv_handle_message().

Here is the call graph for this function:

Here is the caller graph for this function:

open_service_room()

int open_service_room	(	struct GNUNET_MESSENGER_Service *	service,
		struct GNUNET_MESSENGER_SrvHandle *	handle,
		const struct GNUNET_HashCode *	key
	)

Tries to open a room using a given key for a service by a specific handle.

The room will be created if necessary. If the function is successful, it returns GNUNET_YES, otherwise GNUNET_NO.

Parameters

[in,out]	service	Service
[in,out]	handle	Handle
[in]	key	Key of room

Returns

GNUNET_YES on success, otherwise GNUNET_NO

Definition at line 205 of file gnunet-service-messenger_service.c.

{
  GNUNET_assert((service) && (handle) && (key));
 
  struct GNUNET_MESSENGER_SrvRoom *room = get_service_room (service, key);
 
  if (room)
    return open_srv_room (room, handle);
 
  room = create_srv_room (handle, key);
 
  if ((GNUNET_YES == open_srv_room (room, handle)) &&
      (GNUNET_OK == GNUNET_CONTAINER_multihashmap_put (service->rooms,
                                                       key, room,
                                                       GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_FAST)))
    return GNUNET_YES;
 
  destroy_srv_room (room, GNUNET_YES);
  return GNUNET_NO;
}

References create_srv_room(), destroy_srv_room(), get_service_room(), GNUNET_assert, GNUNET_CONTAINER_multihashmap_put(), GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_FAST, GNUNET_NO, GNUNET_OK, GNUNET_YES, handle, key, open_srv_room(), and service.

Referenced by open_srv_handle_room().

Here is the call graph for this function:

Here is the caller graph for this function:

entry_service_room()

int entry_service_room	(	struct GNUNET_MESSENGER_Service *	service,
		struct GNUNET_MESSENGER_SrvHandle *	handle,
		const struct GNUNET_PeerIdentity *	door,
		const struct GNUNET_HashCode *	key
	)

Tries to enter a room using a given key for a service by a specific handle.

The room will be created if necessary. If the function is successful, it returns GNUNET_YES, otherwise GNUNET_NO.

The room will be entered through the peer identitied by the peer identity provided as door parameter and a new connection will be made.

Parameters

[in,out]	service	Service
[in,out]	handle	Handle
[in]	door	Peer identity
[in]	key	Key of room

Returns

GNUNET_YES on success, otherwise GNUNET_NO

Definition at line 229 of file gnunet-service-messenger_service.c.

{
  GNUNET_assert((service) && (handle) && (door) && (key));
 
  struct GNUNET_MESSENGER_SrvRoom *room = get_service_room (service, key);
 
  if (room)
  {
    if (GNUNET_YES == enter_srv_room_at (room, handle, door))
      return GNUNET_YES;
    else
      return GNUNET_NO;
  }
 
  room = create_srv_room (handle, key);
 
  if ((GNUNET_YES == enter_srv_room_at (room, handle, door)) &&
      (GNUNET_OK == GNUNET_CONTAINER_multihashmap_put (service->rooms,
                                                       key, room,
                                                       GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_FAST)))
  {
    return GNUNET_YES;
  }
  else
  {
    destroy_srv_room (room, GNUNET_YES);
    return GNUNET_NO;
  }
 
}

References create_srv_room(), destroy_srv_room(), enter_srv_room_at(), get_service_room(), GNUNET_assert, GNUNET_CONTAINER_multihashmap_put(), GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_FAST, GNUNET_NO, GNUNET_OK, GNUNET_YES, handle, key, and service.

Referenced by entry_srv_handle_room().

Here is the call graph for this function:

Here is the caller graph for this function:

close_service_room()

int close_service_room	(	struct GNUNET_MESSENGER_Service *	service,
		struct GNUNET_MESSENGER_SrvHandle *	handle,
		const struct GNUNET_HashCode *	key
	)

Tries to close a room using a given key for a service by a specific handle.

The room will be created if necessary. If the function is successful, it returns GNUNET_YES, otherwise GNUNET_NO.

If the specific handle is currently the host of the room for this service, a new handle which is a member will take its place. Otherwise the room will be destroyed for this service.

Parameters

[in,out]	service	Service
[in,out]	handle	Handle
[in]	key	Key of room

Returns

GNUNET_YES on success, otherwise GNUNET_NO

Definition at line 264 of file gnunet-service-messenger_service.c.

{
  GNUNET_assert((service) && (handle) && (key));
 
  struct GNUNET_MESSENGER_SrvRoom *room = get_service_room (service, key);
 
  if (!room)
    return GNUNET_NO;
 
  send_srv_room_message (room, handle, create_message_leave ());
 
  const struct GNUNET_ShortHashCode *id = get_srv_handle_member_id (handle, key);
 
  GNUNET_assert(id);
 
  if (GNUNET_YES != GNUNET_CONTAINER_multihashmap_remove (handle->member_ids, key, id))
    return GNUNET_NO;
 
  struct GNUNET_MESSENGER_SrvHandle *member_handle = (struct GNUNET_MESSENGER_SrvHandle*) find_list_handle_by_member (
      &(service->handles), key);
 
  if (!member_handle)
  {
    if (GNUNET_OK == GNUNET_CONTAINER_multihashmap_remove (service->rooms, key, room))
    {
      destroy_srv_room (room, GNUNET_YES);
      return GNUNET_YES;
    }
    else
      return GNUNET_NO;
  }
 
  if (room->host == handle)
    room->host = member_handle;
 
  return GNUNET_YES;
}

References create_message_leave(), destroy_srv_room(), find_list_handle_by_member(), get_service_room(), get_srv_handle_member_id(), GNUNET_assert, GNUNET_CONTAINER_multihashmap_remove(), GNUNET_NO, GNUNET_OK, GNUNET_YES, handle, GNUNET_MESSENGER_SrvRoom::host, key, send_srv_room_message(), and service.

Referenced by close_srv_handle_room().

Here is the call graph for this function:

Here is the caller graph for this function:

handle_service_message()

void handle_service_message	(	struct GNUNET_MESSENGER_Service *	service,
		struct GNUNET_MESSENGER_SrvRoom *	room,
		const struct GNUNET_MESSENGER_MemberSession *	session,
		const struct GNUNET_MESSENGER_Message *	message,
		const struct GNUNET_HashCode *	hash
	)

Sends a received or sent message with a given hash to each handle of a service which is currently member of a specific room for handling it in the client API.

Parameters

[in,out]	service	Service
[in,out]	room	Room
[in]	session	Member session
[in]	message	Message
[in]	hash	Hash of message

Definition at line 305 of file gnunet-service-messenger_service.c.

{
  GNUNET_assert((service) && (room) && (session) && (message) && (hash));
 
  struct GNUNET_MESSENGER_ListHandle *element = service->handles.head;
 
  while (element)
  {
    notify_srv_handle_message (element->handle, room, session, message, hash);
    element = element->next;
  }
}

References GNUNET_assert, GNUNET_MESSENGER_ListHandle::handle, GNUNET_MESSENGER_ListHandle::next, notify_srv_handle_message(), and service.

Referenced by handle_room_messages().

Here is the call graph for this function:

Here is the caller graph for this function: