messenger_api_handle.c File Reference

messenger api: client implementation of GNUnet MESSENGER service More...

#include "messenger_api_handle.h"

Include dependency graph for messenger_api_handle.c:

Go to the source code of this file.

Functions
struct GNUNET_MESSENGER_Handle *	create_handle (const struct GNUNET_CONFIGURATION_Handle *cfg, GNUNET_MESSENGER_IdentityCallback identity_callback, void *identity_cls, 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...
static int	iterate_destroy_room (void *cls, const struct GNUNET_HashCode *key, void *value)
static int	iterate_destroy_contact (void *cls, const struct GNUNET_HashCode *key, void *value)
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_IDENTITY_PublicKey *pubkey)
	Sets the public key of a given handle to a specific public key. More...
const struct GNUNET_IDENTITY_PublicKey *	get_handle_key (const struct GNUNET_MESSENGER_Handle *handle)
	Returns the public key of a given handle. More...
struct GNUNET_MESSENGER_Contact *	get_handle_contact_by_pubkey (const struct GNUNET_MESSENGER_Handle *handle, const struct GNUNET_IDENTITY_PublicKey *pubkey)
	Returns a contact known to a handle identified by a given public key. More...
void	swap_handle_contact_by_pubkey (struct GNUNET_MESSENGER_Handle *handle, struct GNUNET_MESSENGER_Contact *contact, const struct GNUNET_IDENTITY_PublicKey *pubkey)
	Changes the public key for a contact known to a handle to a specific public key and updates local map entries to access the contact by its updated 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...

Detailed Description

messenger api: client implementation of GNUnet MESSENGER service

Author

Tobias Frisch

Definition in file messenger_api_handle.c.

Function Documentation

create_handle()

struct GNUNET_MESSENGER_Handle* create_handle	(	const struct GNUNET_CONFIGURATION_Handle *	cfg,
		GNUNET_MESSENGER_IdentityCallback	identity_callback,
		void *	identity_cls,
		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

cfg	Configuration
msg_callback	Message callback
msg_cls	Closure

Returns

New handle

Definition at line 29 of file messenger_api_handle.c.

References cfg, GNUNET_MESSENGER_Handle::cfg, GNUNET_MESSENGER_Handle::contacts, GNUNET_CONTAINER_multihashmap_create(), GNUNET_new, GNUNET_NO, GNUNET_TIME_relative_get_zero_(), handle, GNUNET_MESSENGER_Handle::identity_callback, GNUNET_MESSENGER_Handle::identity_cls, GNUNET_MESSENGER_Handle::mq, GNUNET_MESSENGER_Handle::msg_callback, GNUNET_MESSENGER_Handle::msg_cls, GNUNET_MESSENGER_Handle::name, GNUNET_MESSENGER_Handle::pubkey, GNUNET_MESSENGER_Handle::reconnect_task, GNUNET_MESSENGER_Handle::reconnect_time, and GNUNET_MESSENGER_Handle::rooms.

{
  struct GNUNET_MESSENGER_Handle *handle = GNUNET_new(struct GNUNET_MESSENGER_Handle);

  handle->cfg = cfg;
  handle->mq = NULL;

  handle->identity_callback = identity_callback;
  handle->identity_cls = identity_cls;

  handle->msg_callback = msg_callback;
  handle->msg_cls = msg_cls;

  handle->name = NULL;
  handle->pubkey = NULL;

  handle->reconnect_time = GNUNET_TIME_relative_get_zero_ ();
  handle->reconnect_task = NULL;

  handle->rooms = GNUNET_CONTAINER_multihashmap_create (8, GNUNET_NO);
  handle->contacts = GNUNET_CONTAINER_multihashmap_create (8, GNUNET_NO);

  return handle;
}

Here is the call graph for this function:

iterate_destroy_room()

static int iterate_destroy_room ( void *  cls, const struct GNUNET_HashCode *  key, void *  value  )

static

Definition at line 56 of file messenger_api_handle.c.

References destroy_room(), GNUNET_YES, and value.

Referenced by destroy_handle().

{
  struct GNUNET_MESSENGER_Room *room = value;

  destroy_room (room);

  return GNUNET_YES;
}

Here is the call graph for this function:

Here is the caller graph for this function:

iterate_destroy_contact()

static int iterate_destroy_contact ( void *  cls, const struct GNUNET_HashCode *  key, void *  value  )

static

Definition at line 66 of file messenger_api_handle.c.

References destroy_contact(), GNUNET_YES, and value.

Referenced by destroy_handle().

{
  struct GNUNET_MESSENGER_Contact *contact = value;

  destroy_contact (contact);

  return GNUNET_YES;
}

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

handle

Handle

Definition at line 76 of file messenger_api_handle.c.

References GNUNET_MESSENGER_Handle::contacts, GNUNET_CONTAINER_multihashmap_destroy(), GNUNET_CONTAINER_multihashmap_iterate(), GNUNET_free, GNUNET_MQ_destroy(), GNUNET_SCHEDULER_cancel(), iterate_destroy_contact(), iterate_destroy_room(), GNUNET_MESSENGER_Handle::mq, GNUNET_MESSENGER_Handle::name, GNUNET_MESSENGER_Handle::pubkey, GNUNET_MESSENGER_Handle::reconnect_task, and GNUNET_MESSENGER_Handle::rooms.

{
  if (handle->reconnect_task)
    GNUNET_SCHEDULER_cancel (handle->reconnect_task);

  if (handle->mq)
    GNUNET_MQ_destroy (handle->mq);

  if (handle->name)
    GNUNET_free(handle->name);

  if (handle->pubkey)
    GNUNET_free(handle->pubkey);

  if (handle->rooms)
  {
    GNUNET_CONTAINER_multihashmap_iterate (handle->rooms, iterate_destroy_room, NULL);

    GNUNET_CONTAINER_multihashmap_destroy (handle->rooms);
  }

  if (handle->contacts)
  {
    GNUNET_CONTAINER_multihashmap_iterate (handle->contacts, iterate_destroy_contact, NULL);

    GNUNET_CONTAINER_multihashmap_destroy (handle->contacts);
  }

  GNUNET_free(handle->name);
}

Here is the call 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

handle	Handle
name	New name

Definition at line 108 of file messenger_api_handle.c.

References GNUNET_free, GNUNET_strdup, and GNUNET_MESSENGER_Handle::name.

{
  if (handle->name)
    GNUNET_free(handle->name);

  handle->name = name? GNUNET_strdup(name) : NULL;
}

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

handle

Handle

Returns

Name of the handle or NULL

Definition at line 117 of file messenger_api_handle.c.

References GNUNET_MESSENGER_Handle::name.

Referenced by GNUNET_MESSENGER_get_name(), and GNUNET_MESSENGER_update().

{
  return handle->name;
}

Here is the caller graph for this function:

set_handle_key()

void set_handle_key	(	struct GNUNET_MESSENGER_Handle *	handle,
		const struct GNUNET_IDENTITY_PublicKey *	pubkey
	)

Sets the public key of a given handle to a specific public key.

Parameters

handle	Handle
pubkey	Public key

Definition at line 123 of file messenger_api_handle.c.

References GNUNET_memcpy, GNUNET_new, and GNUNET_MESSENGER_Handle::pubkey.

Referenced by handle_get_key().

{
  if (!handle->pubkey)
    handle->pubkey = GNUNET_new(struct GNUNET_IDENTITY_PublicKey);

  GNUNET_memcpy(handle->pubkey, pubkey, sizeof(*pubkey));
}

Here is the caller graph for this function:

get_handle_key()

const struct GNUNET_IDENTITY_PublicKey* get_handle_key

(

const struct GNUNET_MESSENGER_Handle *

handle

)

Returns the public key of a given handle.

Parameters

handle

Handle

Returns

Public key of the handle

Definition at line 132 of file messenger_api_handle.c.

References GNUNET_IDENTITY_ego_get_anonymous(), GNUNET_IDENTITY_ego_get_public_key(), pubkey, and GNUNET_MESSENGER_Handle::pubkey.

Referenced by GNUNET_MESSENGER_get_key().

{
  if (!handle->pubkey)
  {
    struct GNUNET_IDENTITY_Ego *anonymous = GNUNET_IDENTITY_ego_get_anonymous ();
    static struct GNUNET_IDENTITY_PublicKey pubkey;

    GNUNET_IDENTITY_ego_get_public_key (anonymous, &pubkey);

    return &pubkey;
  }

  return handle->pubkey;
}

Here is the call graph for this function:

Here is the caller graph for this function:

get_handle_contact_by_pubkey()

struct GNUNET_MESSENGER_Contact* get_handle_contact_by_pubkey	(	const struct GNUNET_MESSENGER_Handle *	handle,
		const struct GNUNET_IDENTITY_PublicKey *	pubkey
	)

Returns a contact known to a handle identified by a given public key.

If not matching contact is found, NULL gets returned.

Parameters

handle	Handle
pubkey	Public key of EGO

Returns

Contact or NULL

Definition at line 148 of file messenger_api_handle.c.

References GNUNET_MESSENGER_Handle::contacts, create_contact(), destroy_contact(), GNUNET_CONTAINER_multihashmap_get(), GNUNET_CONTAINER_multihashmap_put(), GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_FAST, GNUNET_CRYPTO_hash(), and GNUNET_OK.

Referenced by handle_join_message().

{
  struct GNUNET_HashCode hash;

  GNUNET_CRYPTO_hash (pubkey, sizeof(*pubkey), &hash);

  struct GNUNET_MESSENGER_Contact *contact = GNUNET_CONTAINER_multihashmap_get (handle->contacts, &hash);

  if (contact)
    return contact;

  contact = create_contact (pubkey);

  if (GNUNET_OK == GNUNET_CONTAINER_multihashmap_put (handle->contacts, &hash, contact,
                                                      GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_FAST))
    return contact;

  destroy_contact (contact);
  return NULL;
}

Here is the call graph for this function:

Here is the caller graph for this function:

swap_handle_contact_by_pubkey()

void swap_handle_contact_by_pubkey	(	struct GNUNET_MESSENGER_Handle *	handle,
		struct GNUNET_MESSENGER_Contact *	contact,
		const struct GNUNET_IDENTITY_PublicKey *	pubkey
	)

Changes the public key for a contact known to a handle to a specific public key and updates local map entries to access the contact by its updated key.

Parameters

handle	Handle
contact	Contact
pubkey	Public key of EGO

Definition at line 171 of file messenger_api_handle.c.

References GNUNET_MESSENGER_Handle::contacts, get_contact_id_from_key(), GNUNET_CONTAINER_multihashmap_put(), GNUNET_CONTAINER_multihashmap_remove(), GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_FAST, GNUNET_memcpy, GNUNET_YES, and GNUNET_MESSENGER_Contact::public_key.

Referenced by handle_key_message().

{
  const struct GNUNET_HashCode *hash = get_contact_id_from_key (contact);

  if (GNUNET_YES == GNUNET_CONTAINER_multihashmap_remove (handle->contacts, hash, contact))
  {
    GNUNET_memcpy(&(contact->public_key), pubkey, sizeof(*pubkey));

    hash = get_contact_id_from_key (contact);

    GNUNET_CONTAINER_multihashmap_put (handle->contacts, hash, contact,
                                       GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_FAST);
  }
}

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

handle	Handle
key	Key of room

Definition at line 188 of file messenger_api_handle.c.

References GNUNET_CONTAINER_multihashmap_get(), GNUNET_YES, GNUNET_MESSENGER_Room::opened, and GNUNET_MESSENGER_Handle::rooms.

{
  struct GNUNET_MESSENGER_Room *room = GNUNET_CONTAINER_multihashmap_get (handle->rooms, key);

  if (room)
    room->opened = GNUNET_YES;
}

Here is the call 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

handle	Handle
door	Peer identity
key	Key of room

Definition at line 197 of file messenger_api_handle.c.

References add_to_list_tunnels(), GNUNET_MESSENGER_Room::entries, GNUNET_CONTAINER_multihashmap_get(), and GNUNET_MESSENGER_Handle::rooms.

Referenced by handle_room_entry().

{
  struct GNUNET_MESSENGER_Room *room = GNUNET_CONTAINER_multihashmap_get (handle->rooms, key);

  if (room)
    add_to_list_tunnels (&(room->entries), door);
}

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

handle	Handle
key	Key of room

Definition at line 207 of file messenger_api_handle.c.

References destroy_room(), GNUNET_CONTAINER_multihashmap_get(), GNUNET_CONTAINER_multihashmap_remove(), GNUNET_YES, and GNUNET_MESSENGER_Handle::rooms.

{
  struct GNUNET_MESSENGER_Room *room = GNUNET_CONTAINER_multihashmap_get (handle->rooms, key);

  if ((room) && (GNUNET_YES == GNUNET_CONTAINER_multihashmap_remove (handle->rooms, key, room)))
    destroy_room (room);
}

Here is the call graph for this function: