GNUnet 0.22.2
Data Structures | Functions
messenger_api_contact_store.h File Reference
#include "gnunet_util_lib.h"
Include dependency graph for messenger_api_contact_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_ContactStore
 

Functions

void init_contact_store (struct GNUNET_MESSENGER_ContactStore *store)
 Initializes a contact store as fully empty. More...
 
void clear_contact_store (struct GNUNET_MESSENGER_ContactStore *store)
 Clears a contact store, wipes its content and deallocates its memory. More...
 
struct GNUNET_MESSENGER_Contact * get_store_contact_raw (struct GNUNET_MESSENGER_ContactStore *store, const struct GNUNET_HashCode *context, const struct GNUNET_HashCode *key_hash)
 Returns a contact using the hash of a specific public key. More...
 
struct GNUNET_MESSENGER_Contact * get_store_contact (struct GNUNET_MESSENGER_ContactStore *store, const struct GNUNET_HashCode *context, const struct GNUNET_CRYPTO_PublicKey *pubkey)
 Returns a contact using a specific public key. More...
 
void update_store_contact (struct GNUNET_MESSENGER_ContactStore *store, struct GNUNET_MESSENGER_Contact *contact, const struct GNUNET_HashCode *context, const struct GNUNET_HashCode *next_context, const struct GNUNET_CRYPTO_PublicKey *pubkey)
 Moves a contact from the store to another location matching a given public key and member context. More...
 
void remove_store_contact (struct GNUNET_MESSENGER_ContactStore *store, struct GNUNET_MESSENGER_Contact *contact, const struct GNUNET_HashCode *context)
 Removes a contact from the store which uses a given member context. More...
 

Function Documentation

◆ init_contact_store()

void init_contact_store ( struct GNUNET_MESSENGER_ContactStore *  store)

Initializes a contact store as fully empty.

Parameters
[out]storeContact store

Definition at line 33 of file messenger_api_contact_store.c.

34{
35 GNUNET_assert (store);
36
37 store->anonymous = GNUNET_CONTAINER_multihashmap_create (8, GNUNET_NO);
38 store->contacts = GNUNET_CONTAINER_multihashmap_create (8, GNUNET_NO);
39
40 store->counter = 0;
41}
GNUNET_CONTAINER_multihashmap_create
struct GNUNET_CONTAINER_MultiHashMap * GNUNET_CONTAINER_multihashmap_create(unsigned int len, int do_not_copy_keys)
Create a multi hash map.
Definition: container_multihashmap.c:180
GNUNET_NO
@ GNUNET_NO
Definition: gnunet_common.h:110
GNUNET_assert
#define GNUNET_assert(cond)
Use this for fatal errors that cannot be handled.
Definition: gnunet_common.h:956
GNUNET_MESSENGER_ContactStore::contacts
struct GNUNET_CONTAINER_MultiHashMap * contacts
Definition: messenger_api_contact_store.h:36
GNUNET_MESSENGER_ContactStore::anonymous
struct GNUNET_CONTAINER_MultiHashMap * anonymous
Definition: messenger_api_contact_store.h:35
GNUNET_MESSENGER_ContactStore::counter
size_t counter
Definition: messenger_api_contact_store.h:38

References GNUNET_MESSENGER_ContactStore::anonymous, GNUNET_MESSENGER_ContactStore::contacts, GNUNET_MESSENGER_ContactStore::counter, GNUNET_assert, GNUNET_CONTAINER_multihashmap_create(), and GNUNET_NO.

Referenced by create_handle(), and create_service().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ clear_contact_store()

void clear_contact_store ( struct GNUNET_MESSENGER_ContactStore *  store)

Clears a contact store, wipes its content and deallocates its memory.

Parameters
[in,out]storeContact store

Definition at line 61 of file messenger_api_contact_store.c.

62{
63 GNUNET_assert ((store) && (store->contacts));
64
65 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Clear contact store\n");
66
67 GNUNET_CONTAINER_multihashmap_iterate (store->anonymous,
68 iterate_destroy_contacts, NULL);
69 GNUNET_CONTAINER_multihashmap_iterate (store->contacts,
70 iterate_destroy_contacts, NULL);
71
72 GNUNET_CONTAINER_multihashmap_destroy (store->anonymous);
73 GNUNET_CONTAINER_multihashmap_destroy (store->contacts);
74}
GNUNET_CONTAINER_multihashmap_iterate
int GNUNET_CONTAINER_multihashmap_iterate(struct GNUNET_CONTAINER_MultiHashMap *map, GNUNET_CONTAINER_MultiHashMapIteratorCallback it, void *it_cls)
Iterate over all entries in the map.
Definition: container_multihashmap.c:309
GNUNET_CONTAINER_multihashmap_destroy
void GNUNET_CONTAINER_multihashmap_destroy(struct GNUNET_CONTAINER_MultiHashMap *map)
Destroy a hash map.
Definition: container_multihashmap.c:215
GNUNET_log
#define GNUNET_log(kind,...)
Definition: gnunet_common.h:548
GNUNET_ERROR_TYPE_DEBUG
@ GNUNET_ERROR_TYPE_DEBUG
Definition: gnunet_common.h:421
iterate_destroy_contacts
static enum GNUNET_GenericReturnValue iterate_destroy_contacts(void *cls, const struct GNUNET_HashCode *key, void *value)
Definition: messenger_api_contact_store.c:45

References GNUNET_MESSENGER_ContactStore::anonymous, GNUNET_MESSENGER_ContactStore::contacts, GNUNET_assert, GNUNET_CONTAINER_multihashmap_destroy(), GNUNET_CONTAINER_multihashmap_iterate(), GNUNET_ERROR_TYPE_DEBUG, GNUNET_log, and iterate_destroy_contacts().

Referenced by destroy_handle(), and destroy_service().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ get_store_contact_raw()

struct GNUNET_MESSENGER_Contact * get_store_contact_raw ( struct GNUNET_MESSENGER_ContactStore *  store,
const struct GNUNET_HashCode *  context,
const struct GNUNET_HashCode *  key_hash 
)

Returns a contact using the hash of a specific public key.

In case the anonymous key gets used by the requested contact, it will use its provided member context to select the matching contact from the store.

In case there is no contact stored which uses the given key or context, NULL gets returned.

Parameters
[in,out]storeContact store
[in]contextMember context
[in]key_hashHash of public key

Definition at line 102 of file messenger_api_contact_store.c.

105{
106 struct GNUNET_CONTAINER_MultiHashMap *map;
107 struct GNUNET_HashCode hash;
108
109 GNUNET_assert ((store) && (store->contacts) && (context) && (key_hash));
110
111 GNUNET_memcpy (&hash, key_hash, sizeof(*key_hash));
112
113 map = select_store_contact_map (store, context, &hash);
114
115 return GNUNET_CONTAINER_multihashmap_get (map, &hash);
116}
context
static pa_context * context
Pulseaudio context.
Definition: gnunet-helper-audio-playback.c:81
GNUNET_CONTAINER_multihashmap_get
void * GNUNET_CONTAINER_multihashmap_get(const struct GNUNET_CONTAINER_MultiHashMap *map, const struct GNUNET_HashCode *key)
Given a key find a value in the map matching the key.
Definition: container_multihashmap.c:281
GNUNET_memcpy
#define GNUNET_memcpy(dst, src, n)
Call memcpy() but check for n being 0 first.
Definition: gnunet_common.h:1316
select_store_contact_map
static struct GNUNET_CONTAINER_MultiHashMap * select_store_contact_map(struct GNUNET_MESSENGER_ContactStore *store, const struct GNUNET_HashCode *context, struct GNUNET_HashCode *hash)
Definition: messenger_api_contact_store.c:78
map
static struct GNUNET_CONTAINER_MultiPeerMap * map
Peermap of PeerIdentities to "struct PeerEntry" (for fast lookup).
Definition: peer.c:63
GNUNET_CONTAINER_MultiHashMap
Internal representation of the hash map.
Definition: container_multihashmap.c:107
GNUNET_HashCode
A 512-bit hashcode.
Definition: gnunet_common.h:284

References GNUNET_MESSENGER_ContactStore::contacts, context, GNUNET_assert, GNUNET_CONTAINER_multihashmap_get(), GNUNET_memcpy, map, and select_store_contact_map().

Referenced by process_message_control(), and task_message_control().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ get_store_contact()

struct GNUNET_MESSENGER_Contact * get_store_contact ( struct GNUNET_MESSENGER_ContactStore *  store,
const struct GNUNET_HashCode *  context,
const struct GNUNET_CRYPTO_PublicKey *  pubkey 
)

Returns a contact using a specific public key.

In case the anonymous key gets used by the requested contact, it will use its provided member context to select the matching contact from the store.

In case there is no contact stored which uses the given key or context, a new contact will be created automatically.

The function returns NULL if an error occurs during allocation or validation of the contacts key.

Parameters
[in,out]storeContact store
[in]contextMember context
[in]pubkeyPublic key

Definition at line 120 of file messenger_api_contact_store.c.

123{
124 struct GNUNET_CONTAINER_MultiHashMap *map;
125 struct GNUNET_MESSENGER_Contact *contact;
126 struct GNUNET_HashCode hash;
127
128 GNUNET_assert ((store) && (store->contacts) && (pubkey));
129
130 GNUNET_CRYPTO_hash (pubkey, sizeof(*pubkey), &hash);
131
132 map = select_store_contact_map (store, context, &hash);
133 contact = GNUNET_CONTAINER_multihashmap_get (map, &hash);
134
135 if (contact)
136 {
137 if (0 != GNUNET_memcmp (pubkey, get_contact_key (contact)))
138 {
139 char *str;
140 str = GNUNET_CRYPTO_public_key_to_string (get_contact_key (contact));
141
142 GNUNET_log (GNUNET_ERROR_TYPE_INVALID,
143 "Contact in store uses wrong key: %s\n", str);
144 GNUNET_free (str);
145 return NULL;
146 }
147
148 return contact;
149 }
150
151 contact = create_contact (pubkey, ++(store->counter));
152
153 if (GNUNET_OK == GNUNET_CONTAINER_multihashmap_put (map, &hash, contact,
154 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_FAST))
155
156 return contact;
157
158 destroy_contact (contact);
159 return NULL;
160}
pubkey
static struct GNUNET_CRYPTO_PublicKey pubkey
Public key of the zone to look in.
Definition: gnunet-namecache.c:53
GNUNET_CRYPTO_hash
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
GNUNET_CONTAINER_multihashmap_put
enum GNUNET_GenericReturnValue GNUNET_CONTAINER_multihashmap_put(struct GNUNET_CONTAINER_MultiHashMap *map, const struct GNUNET_HashCode *key, void *value, enum GNUNET_CONTAINER_MultiHashMapOption opt)
Store a key-value pair in the map.
Definition: container_multihashmap.c:710
GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_FAST
@ GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_FAST
, ' bother checking if a value already exists (faster than GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE...
Definition: gnunet_container_lib.h:389
GNUNET_CRYPTO_public_key_to_string
char * GNUNET_CRYPTO_public_key_to_string(const struct GNUNET_CRYPTO_PublicKey *key)
Creates a (Base32) string representation of the public key.
Definition: crypto_pkey.c:379
GNUNET_memcmp
#define GNUNET_memcmp(a, b)
Compare memory in a and b, where both must be of the same pointer type.
Definition: gnunet_common.h:1246
GNUNET_OK
@ GNUNET_OK
Definition: gnunet_common.h:111
GNUNET_ERROR_TYPE_INVALID
@ GNUNET_ERROR_TYPE_INVALID
Definition: gnunet_common.h:422
GNUNET_free
#define GNUNET_free(ptr)
Wrapper around free.
Definition: gnunet_common.h:1411
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.
Definition: messenger_api_contact.c:83
destroy_contact
void destroy_contact(struct GNUNET_MESSENGER_Contact *contact)
Destroys a contact and frees its memory fully.
Definition: messenger_api_contact.c:49
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.
Definition: messenger_api_contact.c:29
GNUNET_MESSENGER_Contact
Definition: messenger_api_contact.h:32

References GNUNET_MESSENGER_ContactStore::contacts, context, GNUNET_MESSENGER_ContactStore::counter, create_contact(), destroy_contact(), get_contact_key(), GNUNET_assert, GNUNET_CONTAINER_multihashmap_get(), GNUNET_CONTAINER_multihashmap_put(), GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_FAST, GNUNET_CRYPTO_hash(), GNUNET_CRYPTO_public_key_to_string(), GNUNET_ERROR_TYPE_INVALID, GNUNET_free, GNUNET_log, GNUNET_memcmp, GNUNET_OK, map, pubkey, and select_store_contact_map().

Referenced by create_member_session(), get_handle_contact(), handle_join_message(), handle_transcript_message(), and reset_member_session().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ update_store_contact()

void update_store_contact ( struct GNUNET_MESSENGER_ContactStore *  store,
struct GNUNET_MESSENGER_Contact *  contact,
const struct GNUNET_HashCode *  context,
const struct GNUNET_HashCode *  next_context,
const struct GNUNET_CRYPTO_PublicKey *  pubkey 
)

Moves a contact from the store to another location matching a given public key and member context.

This function allows changes of keys or changes of member contexts!

Parameters
[in,out]storeContact store
[in,out]contactContact
[in]contextMember context
[in]next_contextMember context
[in]pubkeyPublic key

Definition at line 164 of file messenger_api_contact_store.c.

169{
170 const struct GNUNET_CRYPTO_PublicKey *oldkey;
171 struct GNUNET_CONTAINER_MultiHashMap *map;
172 struct GNUNET_HashCode hash;
173
174 GNUNET_assert ((store) && (store->contacts) && (contact) && (pubkey));
175
176 oldkey = get_contact_key (contact);
177 GNUNET_CRYPTO_hash (oldkey, sizeof(*oldkey), &hash);
178
179 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Update contact store entry: %s\n",
180 GNUNET_h2s (&hash));
181
182 map = select_store_contact_map (store, context, &hash);
183
184 if (GNUNET_YES == GNUNET_CONTAINER_multihashmap_remove (map, &hash, contact))
185 {
186 GNUNET_memcpy (&(contact->public_key), pubkey, sizeof(*pubkey));
187
188 GNUNET_CRYPTO_hash (pubkey, sizeof(*pubkey), &hash);
189
190 map = select_store_contact_map (store, next_context, &hash);
191
192 if (GNUNET_OK != GNUNET_CONTAINER_multihashmap_put (map, &hash, contact,
193 GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_FAST))
194
195 GNUNET_log (GNUNET_ERROR_TYPE_WARNING, "Updating a contact failed: %s\n",
196 GNUNET_h2s (&hash));
197 }
198}
GNUNET_CONTAINER_multihashmap_remove
enum GNUNET_GenericReturnValue GNUNET_CONTAINER_multihashmap_remove(struct GNUNET_CONTAINER_MultiHashMap *map, const struct GNUNET_HashCode *key, const void *value)
Remove the given key-value pair from the map.
Definition: container_multihashmap.c:406
GNUNET_YES
@ GNUNET_YES
Definition: gnunet_common.h:113
GNUNET_h2s
const char * GNUNET_h2s(const struct GNUNET_HashCode *hc)
Convert a hash value to a string (for printing debug messages).
Definition: common_logging.c:1166
GNUNET_ERROR_TYPE_WARNING
@ GNUNET_ERROR_TYPE_WARNING
Definition: gnunet_common.h:415
GNUNET_CRYPTO_PublicKey
An identity key as per LSD0001.
Definition: gnunet_crypto_lib.h:427
GNUNET_MESSENGER_Contact::public_key
struct GNUNET_CRYPTO_PublicKey public_key
Definition: messenger_api_contact.h:37

References GNUNET_MESSENGER_ContactStore::contacts, context, get_contact_key(), GNUNET_assert, GNUNET_CONTAINER_multihashmap_put(), GNUNET_CONTAINER_multihashmap_remove(), GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_FAST, GNUNET_CRYPTO_hash(), GNUNET_ERROR_TYPE_DEBUG, GNUNET_ERROR_TYPE_WARNING, GNUNET_h2s(), GNUNET_log, GNUNET_memcpy, GNUNET_OK, GNUNET_YES, map, pubkey, GNUNET_MESSENGER_Contact::public_key, and select_store_contact_map().

Referenced by handle_id_message(), handle_key_message(), and switch_member_session().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ remove_store_contact()

void remove_store_contact ( struct GNUNET_MESSENGER_ContactStore *  store,
struct GNUNET_MESSENGER_Contact *  contact,
const struct GNUNET_HashCode *  context 
)

Removes a contact from the store which uses a given member context.

Parameters
[in,out]storeContact store
[in,out]contactContact
[in]contextMember context

Definition at line 202 of file messenger_api_contact_store.c.

205{
206 const struct GNUNET_CRYPTO_PublicKey *pubkey;
207 struct GNUNET_CONTAINER_MultiHashMap *map;
208 struct GNUNET_HashCode hash;
209
210 GNUNET_assert ((store) && (store->contacts) && (contact));
211
212 pubkey = get_contact_key (contact);
213 GNUNET_CRYPTO_hash (pubkey, sizeof(*pubkey), &hash);
214
215 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Remove contact store entry: %s\n",
216 GNUNET_h2s (&hash));
217
218 map = select_store_contact_map (store, context, &hash);
219
220 if (GNUNET_YES != GNUNET_CONTAINER_multihashmap_remove (map, &hash, contact))
221 GNUNET_log (GNUNET_ERROR_TYPE_WARNING, "Removing a contact failed: %s\n",
222 GNUNET_h2s (&hash));
223
224 destroy_contact (contact);
225}

References GNUNET_MESSENGER_ContactStore::contacts, context, destroy_contact(), get_contact_key(), GNUNET_assert, GNUNET_CONTAINER_multihashmap_remove(), GNUNET_CRYPTO_hash(), GNUNET_ERROR_TYPE_DEBUG, GNUNET_ERROR_TYPE_WARNING, GNUNET_h2s(), GNUNET_log, GNUNET_YES, map, pubkey, and select_store_contact_map().

Referenced by check_member_session_completion(), and destroy_member_session().

Here is the call graph for this function:
Here is the caller graph for this function: