#include "gnunet_util_lib.h"

Include dependency graph for messenger_api_contact.h:

This graph shows which files directly or indirectly include this file:

Data Structures
struct	GNUNET_MESSENGER_Contact

Functions
struct GNUNET_MESSENGER_Contact *	create_contact (const struct GNUNET_CRYPTO_PublicKey *key, size_t unique_id)
	Creates and allocates a new contact with a given public key.

void	destroy_contact (struct GNUNET_MESSENGER_Contact *contact)
	Destroys a contact and frees its memory fully.

const char *	get_contact_name (const struct GNUNET_MESSENGER_Contact *contact)
	Returns the current name of a given contact or NULL if no valid name was assigned yet.

void	set_contact_name (struct GNUNET_MESSENGER_Contact contact, const char name)
	Changes the current name of a given contact by copying it from the parameter name.

const struct GNUNET_CRYPTO_PublicKey *	get_contact_key (const struct GNUNET_MESSENGER_Contact *contact)
	Returns the public key of a given contact.

void	increase_contact_rc (struct GNUNET_MESSENGER_Contact *contact)
	Increases the reference counter of a given contact which is zero as default.

enum GNUNET_GenericReturnValue	decrease_contact_rc (struct GNUNET_MESSENGER_Contact *contact)
	Decreases the reference counter if possible (can not underflow!) of a given contact and returns GNUNET_YES if the counter is equal to zero, otherwise GNUNET_NO.

size_t	get_contact_id (const struct GNUNET_MESSENGER_Contact *contact)
	Returns the locally unique identifier of a given contact.

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.

Function Documentation

◆ create_contact()

struct GNUNET_MESSENGER_Contact * create_contact	(	const struct GNUNET_CRYPTO_PublicKey *	key,
		size_t	unique_id
	)

Creates and allocates a new contact with a given public key.

Parameters

[in]	key	Public key
[in]	unique_id	Locally unique identifier

Returns: New contact

Definition at line 29 of file messenger_api_contact.c.

{
  struct GNUNET_MESSENGER_Contact *contact;
 
  GNUNET_assert (key);
 
  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Create new contact: %lu\n",
              unique_id);
 
  contact = GNUNET_new (struct GNUNET_MESSENGER_Contact);
 
  contact->name = NULL;
  contact->rc = 0;
  contact->id = unique_id;
 
  GNUNET_memcpy (&(contact->public_key), key, sizeof(contact->public_key));
 
  return contact;
}

References GNUNET_assert, GNUNET_ERROR_TYPE_DEBUG, GNUNET_log, GNUNET_memcpy, GNUNET_new, GNUNET_MESSENGER_Contact::id, key, GNUNET_MESSENGER_Contact::name, GNUNET_MESSENGER_Contact::public_key, and GNUNET_MESSENGER_Contact::rc.

Referenced by get_store_contact().

Here is the caller graph for this function:

◆ destroy_contact()

void destroy_contact ( struct GNUNET_MESSENGER_Contact * contact )

Destroys a contact and frees its memory fully.

Parameters

[in,out] contact Contact

Definition at line 52 of file messenger_api_contact.c.

{
  GNUNET_assert (contact);
 
  if (contact->name)
    GNUNET_free (contact->name);
 
  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Free contact: %lu\n",
              contact->id);
 
  GNUNET_free (contact);
}

References GNUNET_assert, GNUNET_ERROR_TYPE_DEBUG, GNUNET_free, GNUNET_log, GNUNET_MESSENGER_Contact::id, and GNUNET_MESSENGER_Contact::name.

Referenced by get_store_contact(), iterate_destroy_contacts(), and remove_store_contact().

Here is the caller graph for this function:

◆ get_contact_name()

const char * get_contact_name ( const struct GNUNET_MESSENGER_Contact * contact )

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

Parameters

[in] contact Contact

Returns: Name of the contact or NULL

Definition at line 67 of file messenger_api_contact.c.

{
  GNUNET_assert (contact);
 
  return contact->name;
}

References GNUNET_assert, and GNUNET_MESSENGER_Contact::name.

Referenced by GNUNET_MESSENGER_contact_get_name().

Here is the caller graph for this function:

◆ set_contact_name()

void set_contact_name	(	struct GNUNET_MESSENGER_Contact *	contact,
		const char *	name
	)

Changes the current name of a given contact by copying it from the parameter name.

Parameters

[in,out]	contact	Contact
[in]	name	Name

Definition at line 76 of file messenger_api_contact.c.

{
  GNUNET_assert (contact);
 
  if (contact->name)
    GNUNET_free (contact->name);
 
  contact->name = name ? GNUNET_strdup (name) : NULL;
}

References GNUNET_assert, GNUNET_free, GNUNET_strdup, name, and GNUNET_MESSENGER_Contact::name.

Referenced by handle_name_message().

Here is the caller graph for this function:

◆ get_contact_key()

const struct GNUNET_CRYPTO_PublicKey * get_contact_key ( const struct GNUNET_MESSENGER_Contact * contact )

Returns the public key of a given contact.

Parameters

[in] contact Contact

Returns: Public key of the contact

Definition at line 89 of file messenger_api_contact.c.

{
  GNUNET_assert (contact);
 
  return &(contact->public_key);
}

References GNUNET_assert, and GNUNET_MESSENGER_Contact::public_key.

Referenced by get_epoch_member_position(), get_store_contact(), GNUNET_MESSENGER_contact_get_key(), GNUNET_MESSENGER_send_message(), handle_id_message(), remove_store_contact(), and update_store_contact().

Here is the caller graph for this function:

◆ increase_contact_rc()

void increase_contact_rc ( struct GNUNET_MESSENGER_Contact * contact )

Increases the reference counter of a given contact which is zero as default.

Parameters

[in,out] contact Contact

Definition at line 98 of file messenger_api_contact.c.

{
  GNUNET_assert (contact);
 
  contact->rc++;
}

References GNUNET_assert, and GNUNET_MESSENGER_Contact::rc.

Referenced by create_member_session(), handle_join_message(), reset_member_session(), and switch_member_session().

Here is the caller graph for this function:

◆ decrease_contact_rc()

enum GNUNET_GenericReturnValue decrease_contact_rc ( struct GNUNET_MESSENGER_Contact * contact )

Decreases the reference counter if possible (can not underflow!) of a given contact and returns GNUNET_YES if the counter is equal to zero, otherwise GNUNET_NO.

Parameters

[in,out] contact Contact

Returns: GNUNET_YES or GNUNET_NO depending on the reference counter

Definition at line 107 of file messenger_api_contact.c.

{
  GNUNET_assert (contact);
 
  if (contact->rc > 0)
    contact->rc--;
 
  return contact->rc ? GNUNET_NO : GNUNET_YES;
}

References GNUNET_assert, GNUNET_NO, GNUNET_YES, and GNUNET_MESSENGER_Contact::rc.

Referenced by check_member_session_completion(), destroy_member_session(), and handle_leave_message().

Here is the caller graph for this function:

◆ get_contact_id()

size_t get_contact_id ( const struct GNUNET_MESSENGER_Contact * contact )

Returns the locally unique identifier of a given contact.

Parameters

[in] contact contact Contact

Returns: Locally unique identifier of contact

Definition at line 119 of file messenger_api_contact.c.

{
  GNUNET_assert (contact);
 
  return contact->id;
}

References GNUNET_assert, and GNUNET_MESSENGER_Contact::id.

Referenced by GNUNET_MESSENGER_contact_get_id().

Here is the caller graph for this function:

◆ 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.

Parameters

[in]	key	Key of room
[in]	id	Member id
[out]	context	Member context

Definition at line 128 of file messenger_api_contact.c.

{
  GNUNET_assert ((key) && (id) && (context));
 
  GNUNET_CRYPTO_hash (id, sizeof(*id), context);
  GNUNET_CRYPTO_hash_xor (key, context, context);
}

References context, GNUNET_assert, GNUNET_CRYPTO_hash(), GNUNET_CRYPTO_hash_xor(), and key.

Referenced by create_member_session(), get_handle_contact(), handle_id_message(), handle_join_message(), handle_key_message(), and switch_member_session().

Here is the call graph for this function:

Here is the caller graph for this function:

Data Structures

Functions

Function Documentation

◆ create_contact()

◆ destroy_contact()

◆ get_contact_name()

◆ set_contact_name()

◆ get_contact_key()

◆ increase_contact_rc()

◆ decrease_contact_rc()

◆ get_contact_id()

◆ get_context_from_member()