gnunet_op_lib.h File Reference

Asynchronous operations; register callbacks for operations and call them when a response arrives. More...

#include "gnunet_util_lib.h"

Include dependency graph for gnunet_op_lib.h:

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

Go to the source code of this file.

Functions
struct GNUNET_OP_Handle *	GNUNET_OP_create ()
	Create new operations handle. More...
void	GNUNET_OP_destroy (struct GNUNET_OP_Handle *h)
	Destroy operations handle. More...
uint64_t	GNUNET_OP_get_next_id (struct GNUNET_OP_Handle *h)
	Get a unique operation ID to distinguish between asynchronous requests. More...
int	GNUNET_OP_get (struct GNUNET_OP_Handle *h, uint64_t op_id, GNUNET_ResultCallback *result_cb, void **cls, void **ctx)
	Find operation by ID. More...
uint64_t	GNUNET_OP_add (struct GNUNET_OP_Handle *h, GNUNET_ResultCallback result_cb, void *cls, void *ctx)
	Add a new operation. More...
int	GNUNET_OP_result (struct GNUNET_OP_Handle *h, uint64_t op_id, int64_t result_code, const void *data, uint16_t data_size, void **ctx)
	Call the result callback of an operation and remove it. More...
int	GNUNET_OP_remove (struct GNUNET_OP_Handle *h, uint64_t op_id)
	Remove / cancel an operation. More...

Detailed Description

Asynchronous operations; register callbacks for operations and call them when a response arrives.

Author

Gabor X Toth

Definition in file gnunet_op_lib.h.

Function Documentation

GNUNET_OP_create()

struct GNUNET_OP_Handle* GNUNET_OP_create

(

)

Create new operations handle.

Definition at line 89 of file op.c.

References GNUNET_new.

{
  return GNUNET_new (struct GNUNET_OP_Handle);
}

GNUNET_OP_destroy()

void GNUNET_OP_destroy

(

struct GNUNET_OP_Handle *

h

)

Destroy operations handle.

Definition at line 99 of file op.c.

References GNUNET_free.

{
  GNUNET_free (h);
}

GNUNET_OP_get_next_id()

uint64_t GNUNET_OP_get_next_id

(

struct GNUNET_OP_Handle *

h

)

Get a unique operation ID to distinguish between asynchronous requests.

Parameters

h	Operations handle.

Returns

Operation ID to use.

Definition at line 114 of file op.c.

References GNUNET_OP_Handle::last_op_id.

Referenced by GNUNET_OP_add().

{
  return ++h->last_op_id;
}

Here is the caller graph for this function:

GNUNET_OP_get()

int GNUNET_OP_get	(	struct GNUNET_OP_Handle *	h,
		uint64_t	op_id,
		GNUNET_ResultCallback *	result_cb,
		void **	cls,
		void **	ctx
	)

Find operation by ID.

Parameters

	h	Operations handle.
	op_id	Operation ID to look up.
[out]	result_cb	If an operation was found, its result callback is returned here.
[out]	cls	If an operation was found, its closure is returned here.
[out]	ctx	User context.

Returns

GNUNET_YES if an operation was found, GNUNET_NO if not found.

Parameters

	h	Operations handle.
	op_id	Operation ID to look up.
[out]	result_cb	If an operation was found, its result callback is returned here.
[out]	cls	If an operation was found, its closure is returned here.
[out]	ctx	If an operation was found, its user context is returned here.

Returns

GNUNET_YES if an operation was found, GNUNET_NO if not found.

Definition at line 161 of file op.c.

References OperationListItem::cls, OperationListItem::ctx, GNUNET_NO, GNUNET_YES, op, op_find(), and OperationListItem::result_cb.

{
  struct OperationListItem *op = op_find (h, op_id);

  if (NULL != op)
  {
    if (NULL != result_cb)
      *result_cb = op->result_cb;
    if (NULL != cls)
      *cls = op->cls;
    if (NULL != ctx)
      *ctx = op->ctx;
    return GNUNET_YES;
  }
  return GNUNET_NO;
}

Here is the call graph for this function:

GNUNET_OP_add()

uint64_t GNUNET_OP_add	(	struct GNUNET_OP_Handle *	h,
		GNUNET_ResultCallback	result_cb,
		void *	cls,
		void *	ctx
	)

Add a new operation.

Parameters

h	Operations handle.
result_cb	Function to call with the result of the operation.
cls	Closure for result_cb.
ctx	User context.

Returns

ID of the new operation.

Definition at line 198 of file op.c.

References OperationListItem::cls, OperationListItem::ctx, GNUNET_CONTAINER_DLL_insert_tail, GNUNET_ERROR_TYPE_DEBUG, GNUNET_new, GNUNET_OP_get_next_id(), LOG, op, GNUNET_OP_Handle::op_head, OperationListItem::op_id, GNUNET_OP_Handle::op_tail, and OperationListItem::result_cb.

{
  struct OperationListItem *op;

  op = GNUNET_new (struct OperationListItem);
  op->op_id = GNUNET_OP_get_next_id (h);
  op->result_cb = result_cb;
  op->cls = cls;
  op->ctx = ctx;
  GNUNET_CONTAINER_DLL_insert_tail (h->op_head,
                                    h->op_tail,
                                    op);
  LOG (GNUNET_ERROR_TYPE_DEBUG,
       "%p Added operation #%" PRIu64 "\n",
       h, op->op_id);
  return op->op_id;
}

Here is the call graph for this function:

GNUNET_OP_result()

int GNUNET_OP_result	(	struct GNUNET_OP_Handle *	h,
		uint64_t	op_id,
		int64_t	result_code,
		const void *	data,
		uint16_t	data_size,
		void **	ctx
	)

Call the result callback of an operation and remove it.

Parameters

	h	Operations handle.
	op_id	Operation ID.
	result_code	Result of the operation.
	data	Data result of the operation.
	data_size	Size of data.
[out]	ctx	User context.

Returns

GNUNET_YES if the operation was found and removed, GNUNET_NO if the operation was not found.

Definition at line 301 of file op.c.

References GNUNET_ERROR_TYPE_DEBUG, GNUNET_NO, LOG, and op_result().

{
  LOG (GNUNET_ERROR_TYPE_DEBUG,
       "%p Received result for operation #%" PRIu64 ": %" PRId64 " (size: %u)\n",
       h, op_id, result_code, data_size);
  return op_result (h, op_id, result_code, data, data_size, ctx, GNUNET_NO);
}

Here is the call graph for this function:

GNUNET_OP_remove()

int GNUNET_OP_remove	(	struct GNUNET_OP_Handle *	h,
		uint64_t	op_id
	)

Remove / cancel an operation.

Parameters

h	Operations handle.
op_id	Operation ID.

Returns

GNUNET_YES if the operation was found and removed, GNUNET_NO if the operation was not found.

Definition at line 327 of file op.c.

References GNUNET_ERROR_TYPE_DEBUG, GNUNET_YES, LOG, and op_result().

{
  LOG (GNUNET_ERROR_TYPE_DEBUG,
       "%p Cancelling operation #%" PRIu64  "\n",
       h, op_id);
  return op_result (h, op_id, 0, NULL, 0, NULL, GNUNET_YES);
}

Here is the call graph for this function: