GNUnet  0.11.x
Data Structures | Functions
gnunet-service-messenger_operation_store.h File Reference

GNUnet MESSENGER service. More...

#include "platform.h"
#include "gnunet_container_lib.h"
#include "gnunet_crypto_lib.h"
#include "gnunet_scheduler_lib.h"
#include "gnunet_time_lib.h"
Include dependency graph for gnunet-service-messenger_operation_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_OperationStore
 

Functions

void init_operation_store (struct GNUNET_MESSENGER_OperationStore *store, struct GNUNET_MESSENGER_SrvRoom *room)
 Initializes an operation store as fully empty with a given room. More...
 
void clear_operation_store (struct GNUNET_MESSENGER_OperationStore *store)
 Clears an operation store, stops all operations and deallocates its memory. More...
 
void load_operation_store (struct GNUNET_MESSENGER_OperationStore *store, const char *directory)
 Loads operations from a directory into an operation store. More...
 
void save_operation_store (const struct GNUNET_MESSENGER_OperationStore *store, const char *directory)
 Saves operations from an operation store into a directory. More...
 
enum GNUNET_MESSENGER_OperationType get_store_operation_type (const struct GNUNET_MESSENGER_OperationStore *store, const struct GNUNET_HashCode *hash)
 Returns the type of the active operation under a given hash in a specific operation store. More...
 
int use_store_operation (struct GNUNET_MESSENGER_OperationStore *store, const struct GNUNET_HashCode *hash, enum GNUNET_MESSENGER_OperationType type, struct GNUNET_TIME_Relative delay)
 Tries to use an operation under a given hash in a specific operation store. More...
 
void cancel_store_operation (struct GNUNET_MESSENGER_OperationStore *store, const struct GNUNET_HashCode *hash)
 Stops any active operation under a given hash in a specific operation store. More...
 

Detailed Description

GNUnet MESSENGER service.

Author
Tobias Frisch

Definition in file gnunet-service-messenger_operation_store.h.

Function Documentation

◆ init_operation_store()

void init_operation_store ( struct GNUNET_MESSENGER_OperationStore store,
struct GNUNET_MESSENGER_SrvRoom room 
)

Initializes an operation store as fully empty with a given room.

Parameters
[out]storeOperation store
[in/out]room Room

Definition at line 32 of file gnunet-service-messenger_operation_store.c.

34 {
35  GNUNET_assert((store) && (room));
36 
37  store->room = room;
39 }
@ GNUNET_NO
Definition: gnunet_common.h:94
struct GNUNET_CONTAINER_MultiHashMap * GNUNET_CONTAINER_multihashmap_create(unsigned int len, int do_not_copy_keys)
Create a multi hash map.
#define GNUNET_assert(cond)
Use this for fatal errors that cannot be handled.
struct GNUNET_CONTAINER_MultiHashMap * operations

References GNUNET_assert, GNUNET_CONTAINER_multihashmap_create(), GNUNET_NO, GNUNET_MESSENGER_OperationStore::operations, and GNUNET_MESSENGER_OperationStore::room.

Referenced by create_room().

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

◆ clear_operation_store()

void clear_operation_store ( struct GNUNET_MESSENGER_OperationStore store)

Clears an operation store, stops all operations and deallocates its memory.

Parameters
[in/out]store Operation store

Definition at line 54 of file gnunet-service-messenger_operation_store.c.

55 {
56  GNUNET_assert(store);
57 
60 }
static int iterate_destroy_operations(void *cls, const struct GNUNET_HashCode *key, void *value)
int GNUNET_CONTAINER_multihashmap_iterate(struct GNUNET_CONTAINER_MultiHashMap *map, GNUNET_CONTAINER_MulitHashMapIteratorCallback it, void *it_cls)
Iterate over all entries in the map.
void GNUNET_CONTAINER_multihashmap_destroy(struct GNUNET_CONTAINER_MultiHashMap *map)
Destroy a hash map.

References GNUNET_assert, GNUNET_CONTAINER_multihashmap_destroy(), GNUNET_CONTAINER_multihashmap_iterate(), iterate_destroy_operations(), GNUNET_MESSENGER_OperationStore::operations, and GNUNET_MESSENGER_Operation::store.

Referenced by destroy_room().

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

◆ load_operation_store()

void load_operation_store ( struct GNUNET_MESSENGER_OperationStore store,
const char *  directory 
)

Loads operations from a directory into an operation store.

Parameters
[out]storeOperation store
[in]directoryPath to a directory

Definition at line 91 of file gnunet-service-messenger_operation_store.c.

93 {
94  GNUNET_assert ((store) && (directory));
95 
98 }
static int callback_scan_for_operations(void *cls, const char *filename)
@ GNUNET_OK
Definition: gnunet_common.h:95
@ GNUNET_YES
Definition: gnunet_common.h:97
enum GNUNET_GenericReturnValue GNUNET_DISK_directory_test(const char *fil, int is_readable)
Test if fil is a directory and listable.
Definition: disk.c:404
int GNUNET_DISK_directory_scan(const char *dir_name, GNUNET_FileNameCallback callback, void *callback_cls)
Scan a directory for files.
Definition: disk.c:814

References callback_scan_for_operations(), GNUNET_assert, GNUNET_DISK_directory_scan(), GNUNET_DISK_directory_test(), GNUNET_OK, GNUNET_YES, and GNUNET_MESSENGER_Operation::store.

Referenced by load_room().

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

◆ save_operation_store()

void save_operation_store ( const struct GNUNET_MESSENGER_OperationStore store,
const char *  directory 
)

Saves operations from an operation store into a directory.

Parameters
[in]storeOperation store
[in]directoryPath to a directory

Definition at line 121 of file gnunet-service-messenger_operation_store.c.

123 {
124  GNUNET_assert ((store) && (directory));
125 
126  char* save_dir;
127  GNUNET_asprintf (&save_dir, "%s%s%c", directory, "operations", DIR_SEPARATOR);
128 
129  if ((GNUNET_YES == GNUNET_DISK_directory_test (save_dir, GNUNET_NO)) ||
130  (GNUNET_OK == GNUNET_DISK_directory_create (save_dir)))
132 
133  GNUNET_free(save_dir);
134 }
static int iterate_save_operations(void *cls, const struct GNUNET_HashCode *key, void *value)
enum GNUNET_GenericReturnValue GNUNET_DISK_directory_create(const char *dir)
Implementation of "mkdir -p".
Definition: disk.c:496
int int GNUNET_asprintf(char **buf, const char *format,...) __attribute__((format(printf
Like asprintf, just portable.
#define GNUNET_free(ptr)
Wrapper around free.
#define DIR_SEPARATOR
Definition: platform.h:164

Referenced by save_room().

Here is the caller graph for this function:

◆ get_store_operation_type()

enum GNUNET_MESSENGER_OperationType get_store_operation_type ( const struct GNUNET_MESSENGER_OperationStore store,
const struct GNUNET_HashCode hash 
)

Returns the type of the active operation under a given hash in a specific operation store.

If there is no active operation under the given hash, GNUNET_MESSENGER_OP_UNKNOWN gets returned instead.

Parameters
[in]storeOperation store
[in]hashHash of message
Returns
Type of operation or GNUNET_MESSENGER_OP_UNKNOWN

Definition at line 121 of file gnunet-service-messenger_operation_store.c.

139 {
140  GNUNET_assert((store) && (hash));
141 
143 
144  if (!op)
146 
147  return op->type;
148 }
static struct GNUNET_ARM_Operation * op
Current operation.
Definition: gnunet-arm.c:144
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.
struct GNUNET_MESSENGER_OperationStore * store

References DIR_SEPARATOR, GNUNET_asprintf(), GNUNET_assert, GNUNET_CONTAINER_multihashmap_iterate(), GNUNET_DISK_directory_create(), GNUNET_DISK_directory_test(), GNUNET_free, GNUNET_NO, GNUNET_OK, GNUNET_YES, iterate_save_operations(), GNUNET_MESSENGER_OperationStore::operations, and GNUNET_MESSENGER_Operation::store.

Referenced by idle_request_room_messages(), update_room_message(), and update_tunnel_last_message().

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

◆ use_store_operation()

int use_store_operation ( struct GNUNET_MESSENGER_OperationStore store,
const struct GNUNET_HashCode hash,
enum GNUNET_MESSENGER_OperationType  type,
struct GNUNET_TIME_Relative  delay 
)

Tries to use an operation under a given hash in a specific operation store.

The operation will use the selected type if successful. The operation will be delayed by a given delay.

If the selected type is GNUNET_MESSENGER_OP_DELETE any active operation under the given hash will be stopped and replaced.

If the new operation could be started successfully the method returns GNUNET_OK, otherwise GNUNET_SYSERR.

Parameters
[in/out]store Operation store
[in]hashHash of message
[in]typeOperation type
[in]delayDelay
Returns
GNUNET_OK on success, otherwise GNUNET_SYSERR

Definition at line 151 of file gnunet-service-messenger_operation_store.c.

155 {
156  GNUNET_assert((store) && (hash));
157 
159 
160  if (op)
161  goto use_op;
162 
164 
166  {
168 
169  return GNUNET_SYSERR;
170  }
171 
172 use_op:
173  if ((op->type != GNUNET_MESSENGER_OP_UNKNOWN) &&
175  stop_operation (op);
176 
177  return start_operation(op, type, store, delay);
178 }
static struct GNUNET_TIME_Relative delay
When should dkg communication start?
int start_operation(struct GNUNET_MESSENGER_Operation *op, enum GNUNET_MESSENGER_OperationType type, struct GNUNET_MESSENGER_OperationStore *store, struct GNUNET_TIME_Relative delay)
Starts an inactive operation with a given delay in a specific operation store.
int stop_operation(struct GNUNET_MESSENGER_Operation *op)
Stops an active operation and resets its type to be GNUNET_MESSENGER_OP_UNKNOWN.
void destroy_operation(struct GNUNET_MESSENGER_Operation *op)
Destroys an operation and frees its memory fully.
struct GNUNET_MESSENGER_Operation * create_operation(const struct GNUNET_HashCode *hash)
Creates and allocates a new operation under a given hash.
@ GNUNET_SYSERR
Definition: gnunet_common.h:93
int 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.
@ GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_FAST
, ' bother checking if a value already exists (faster than GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE...
enum GNUNET_TESTBED_UnderlayLinkModelType type
the type of this model

References create_operation(), delay, destroy_operation(), GNUNET_assert, GNUNET_CONTAINER_multihashmap_get(), GNUNET_CONTAINER_multihashmap_put(), GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_FAST, GNUNET_MESSENGER_OP_DELETE, GNUNET_MESSENGER_OP_UNKNOWN, GNUNET_OK, GNUNET_SYSERR, GNUNET_MESSENGER_Operation::hash, op, GNUNET_MESSENGER_OperationStore::operations, start_operation(), stop_operation(), GNUNET_MESSENGER_Operation::store, and type.

Referenced by callback_found_message(), delete_room_message(), idle_request_room_messages(), and send_message_request().

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

◆ cancel_store_operation()

void cancel_store_operation ( struct GNUNET_MESSENGER_OperationStore store,
const struct GNUNET_HashCode hash 
)

Stops any active operation under a given hash in a specific operation store.

Beware that calling this method will also implicitly free the memory of any active operation under the given hash!

Parameters
[in/out]store Operation store
[in]hashHash of message

Definition at line 181 of file gnunet-service-messenger_operation_store.c.

183 {
184  GNUNET_assert((store) && (hash));
185 
187 
188  if (!op)
189  return;
190 
192 
194  GNUNET_log(GNUNET_ERROR_TYPE_WARNING, "Canceled operation could not be removed: %s\n",
195  GNUNET_h2s(hash));
196 
198 }
#define GNUNET_log(kind,...)
int 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.
const char * GNUNET_h2s(const struct GNUNET_HashCode *hc)
Convert a hash value to a string (for printing debug messages).
@ GNUNET_ERROR_TYPE_WARNING

References destroy_operation(), GNUNET_assert, GNUNET_CONTAINER_multihashmap_get(), GNUNET_CONTAINER_multihashmap_remove(), GNUNET_ERROR_TYPE_WARNING, GNUNET_h2s(), GNUNET_log, GNUNET_YES, GNUNET_MESSENGER_Operation::hash, op, GNUNET_MESSENGER_OperationStore::operations, stop_operation(), and GNUNET_MESSENGER_Operation::store.

Referenced by callback_store_operation(), and update_room_message().

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