gnunet-service-messenger_operation_store.h File Reference

#include "gnunet_util_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...
enum GNUNET_GenericReturnValue	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...

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]	store	Operation store
[in,out]	room	Room

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

{
  GNUNET_assert ((store) && (room));
 
  store->room = room;
  store->operations = GNUNET_CONTAINER_multihashmap_create (8, GNUNET_NO);
}

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

Referenced by create_srv_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 57 of file gnunet-service-messenger_operation_store.c.

{
  GNUNET_assert (store);
 
  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Clear operation store of room: %s\n",
              GNUNET_h2s (get_srv_room_key (store->room)));
 
  GNUNET_CONTAINER_multihashmap_iterate (store->operations,
                                         iterate_destroy_operations, NULL);
  GNUNET_CONTAINER_multihashmap_destroy (store->operations);
}

References get_srv_room_key(), GNUNET_assert, GNUNET_CONTAINER_multihashmap_destroy(), GNUNET_CONTAINER_multihashmap_iterate(), GNUNET_ERROR_TYPE_DEBUG, GNUNET_h2s(), GNUNET_log, iterate_destroy_operations(), GNUNET_MESSENGER_OperationStore::operations, GNUNET_MESSENGER_OperationStore::room, and GNUNET_MESSENGER_Operation::store.

Referenced by destroy_srv_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]	store	Operation store
[in]	directory	Path to a directory

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

{
  GNUNET_assert ((store) && (directory));
 
  char *load_dir;
  GNUNET_asprintf (&load_dir, "%s%s%c", directory, "operations", DIR_SEPARATOR);
 
  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
              "Load operation store from directory: %s\n",
              load_dir);
 
  if (GNUNET_OK == GNUNET_DISK_directory_test (load_dir, GNUNET_YES))
    GNUNET_DISK_directory_scan (load_dir, callback_scan_for_operations, store);
 
  GNUNET_free (load_dir);
}

References callback_scan_for_operations(), DIR_SEPARATOR, GNUNET_asprintf(), GNUNET_assert, GNUNET_DISK_directory_scan(), GNUNET_DISK_directory_test(), GNUNET_ERROR_TYPE_DEBUG, GNUNET_free, GNUNET_log, GNUNET_OK, GNUNET_YES, and GNUNET_MESSENGER_Operation::store.

Referenced by load_srv_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]	store	Operation store
[in]	directory	Path to a directory

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

{
  GNUNET_assert ((store) && (directory));
 
  char *save_dir;
  GNUNET_asprintf (&save_dir, "%s%s%c", directory, "operations", DIR_SEPARATOR);
 
  GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
              "Save operation store to directory: %s\n",
              save_dir);
 
  if ((GNUNET_YES == GNUNET_DISK_directory_test (save_dir, GNUNET_NO)) ||
      (GNUNET_OK == GNUNET_DISK_directory_create (save_dir)))
    GNUNET_CONTAINER_multihashmap_iterate (store->operations,
                                           iterate_save_operations, save_dir);
 
  GNUNET_free (save_dir);
}

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

Referenced by save_srv_room().

Here is the call graph for this function:

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]	store	Operation store
[in]	hash	Hash of message

Returns

Type of operation or GNUNET_MESSENGER_OP_UNKNOWN

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

{
  GNUNET_assert ((store) && (hash));
 
  struct GNUNET_MESSENGER_Operation *op = GNUNET_CONTAINER_multihashmap_get (
    store->operations, hash);
 
  if (! op)
    return GNUNET_MESSENGER_OP_UNKNOWN;
 
  return op->type;
}

References GNUNET_assert, GNUNET_CONTAINER_multihashmap_get(), GNUNET_MESSENGER_OP_UNKNOWN, GNUNET_MESSENGER_Operation::hash, op, 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()

enum GNUNET_GenericReturnValue 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]	hash	Hash of message
[in]	type	Operation type
[in]	delay	Delay

Returns

GNUNET_OK on success, otherwise GNUNET_SYSERR

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

{
  GNUNET_assert ((store) && (hash));
 
  struct GNUNET_MESSENGER_Operation *op = GNUNET_CONTAINER_multihashmap_get (
    store->operations, hash);
 
  if (op)
    goto use_op;
 
  op = create_operation (hash);
 
  if (GNUNET_OK != GNUNET_CONTAINER_multihashmap_put (store->operations, hash,
                                                      op,
                                                      GNUNET_CONTAINER_MULTIHASHMAPOPTION_UNIQUE_FAST))
  {
    destroy_operation (op);
 
    return GNUNET_SYSERR;
  }
 
use_op:
  if ((op->type != GNUNET_MESSENGER_OP_UNKNOWN) &&
      (type == GNUNET_MESSENGER_OP_DELETE))
    stop_operation (op);
 
  return start_operation (op, type, store, delay);
}

References create_operation(), 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_srv_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]	hash	Hash of message

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

{
  GNUNET_assert ((store) && (hash));
 
  struct GNUNET_MESSENGER_Operation *op = GNUNET_CONTAINER_multihashmap_get (
    store->operations, hash);
 
  if (! op)
    return;
 
  stop_operation (op);
 
  if (GNUNET_YES != GNUNET_CONTAINER_multihashmap_remove (store->operations,
                                                          hash, op))
    GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
                "Canceled operation could not be removed: %s\n",
                GNUNET_h2s (hash));
 
  destroy_operation (op);
}

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: