GNUnet 0.21.1
messenger_api_contact.h File Reference
#include "gnunet_util_lib.h"
Include dependency graph for messenger_api_contact.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_Contact
 

Functions

struct GNUNET_MESSENGER_Contactcreate_contact (const struct GNUNET_CRYPTO_PublicKey *key, size_t unique_id)
 Creates and allocates a new contact with a given public key. More...
 
void destroy_contact (struct GNUNET_MESSENGER_Contact *contact)
 Destroys a contact and frees its memory fully. More...
 
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. More...
 
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. More...
 
const struct GNUNET_CRYPTO_PublicKeyget_contact_key (const struct GNUNET_MESSENGER_Contact *contact)
 Returns the public key of a given contact. More...
 
void increase_contact_rc (struct GNUNET_MESSENGER_Contact *contact)
 Increases the reference counter of a given contact which is zero as default. More...
 
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. More...
 
size_t get_contact_id (const struct GNUNET_MESSENGER_Contact *contact)
 Returns the locally unique identifier of a given contact. More...
 
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. More...
 

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]keyPublic key
[in]unique_idLocally unique identifier
Returns
New contact

Definition at line 29 of file messenger_api_contact.c.

31{
33
34 struct GNUNET_MESSENGER_Contact *contact = GNUNET_new (struct
36
37 contact->name = NULL;
38 contact->rc = 0;
39 contact->id = unique_id;
40
41 GNUNET_memcpy (&(contact->public_key), key, sizeof(contact->public_key));
42
43 return contact;
44}
struct GNUNET_HashCode key
The key used in the DHT.
#define GNUNET_memcpy(dst, src, n)
Call memcpy() but check for n being 0 first.
#define GNUNET_assert(cond)
Use this for fatal errors that cannot be handled.
#define GNUNET_new(type)
Allocate a struct or union of the given type.
struct GNUNET_CRYPTO_PublicKey public_key

References GNUNET_assert, 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]contactContact

Definition at line 48 of file messenger_api_contact.c.

49{
50 GNUNET_assert (contact);
51
52 if (contact->name)
53 GNUNET_free (contact->name);
54
55 GNUNET_free (contact);
56}
#define GNUNET_free(ptr)
Wrapper around free.

References GNUNET_assert, GNUNET_free, 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]contactContact
Returns
Name of the contact or NULL

Definition at line 60 of file messenger_api_contact.c.

61{
62 GNUNET_assert (contact);
63
64 return contact->name;
65}

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]contactContact
[in]nameName

Definition at line 69 of file messenger_api_contact.c.

71{
72 GNUNET_assert (contact);
73
74 if (contact->name)
75 GNUNET_free (contact->name);
76
77 contact->name = name ? GNUNET_strdup (name) : NULL;
78}
static char * name
Name (label) of the records to list.
#define GNUNET_strdup(a)
Wrapper around GNUNET_xstrdup_.

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]contactContact
Returns
Public key of the contact

Definition at line 82 of file messenger_api_contact.c.

83{
84 GNUNET_assert (contact);
85
86 return &(contact->public_key);
87}

References GNUNET_assert, and GNUNET_MESSENGER_Contact::public_key.

Referenced by check_ticket_audience(), get_store_contact(), GNUNET_MESSENGER_contact_get_key(), GNUNET_MESSENGER_send_message(), handle_id_message(), notify_srv_handle_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]contactContact

Definition at line 91 of file messenger_api_contact.c.

92{
93 GNUNET_assert (contact);
94
95 contact->rc++;
96}

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]contactContact
Returns
GNUNET_YES or GNUNET_NO depending on the reference counter

Definition at line 100 of file messenger_api_contact.c.

101{
102 GNUNET_assert (contact);
103
104 if (contact->rc > 0)
105 contact->rc--;
106
107 return contact->rc ? GNUNET_NO : GNUNET_YES;
108}
@ GNUNET_YES
@ GNUNET_NO

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]contactcontact Contact
Returns
Locally unique identifier of contact

Definition at line 112 of file messenger_api_contact.c.

113{
114 GNUNET_assert (contact);
115
116 return contact->id;
117}

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]keyKey of room
[in]idMember id
[out]contextMember context

Definition at line 121 of file messenger_api_contact.c.

124{
125 GNUNET_assert ((key) && (id) && (context));
126
127 GNUNET_CRYPTO_hash (id, sizeof(*id), context);
129}
static pa_context * context
Pulseaudio context.
void GNUNET_CRYPTO_hash(const void *block, size_t size, struct GNUNET_HashCode *ret)
Compute hash of a given block.
Definition: crypto_hash.c:41
void GNUNET_CRYPTO_hash_xor(const struct GNUNET_HashCode *a, const struct GNUNET_HashCode *b, struct GNUNET_HashCode *result)
compute result = a ^ b
Definition: crypto_hash.c:135

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: