testing_messenger_barrier.h File Reference

Pseudo-barriers for simple event handling. More...

#include "platform.h"
#include "gnunet_util_lib.h"

Include dependency graph for testing_messenger_barrier.h:

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

Go to the source code of this file.

Typedefs
typedef void(*	GNUNET_BarrierStatusCallback) (void *cls, struct GNUNET_BarrierHandle *barrier, int status)
	Functions of this type are to be given as callback argument to GNUNET_init_barrier(). More...
typedef void(*	GNUNET_BarrierWaitStatusCallback) (void *cls, struct GNUNET_BarrierWaitHandle *waiting, int status)
	Functions of this type are to be given as acallback argument to GNUNET_wait_barrier(). More...

Functions
struct GNUNET_BarrierHandle *	GNUNET_init_barrier (unsigned int requirement, GNUNET_BarrierStatusCallback cb, void *cb_cls)
	Initialise a pseudo-barrier and call the given callback when the required amount of peers (requirement) reach the pseudo-barrier OR upon error. More...
void	GNUNET_cancel_barrier (struct GNUNET_BarrierHandle *barrier)
	Cancel a pseudo-barrier. More...
struct GNUNET_BarrierWaitHandle *	GNUNET_wait_barrier (struct GNUNET_BarrierHandle *barrier, GNUNET_BarrierWaitStatusCallback cb, void *cb_cls)
	Wait for a pseudo-barrier to be crossed. More...
void	GNUNET_cancel_wait_barrier (struct GNUNET_BarrierWaitHandle *waiting)
	Cancel a pseudo-barrier wait handle. More...

Detailed Description

Pseudo-barriers for simple event handling.

Author

Tobias Frisch

Definition in file testing_messenger_barrier.h.

Typedef Documentation

GNUNET_BarrierStatusCallback

typedef void(* GNUNET_BarrierStatusCallback) (void *cls, struct GNUNET_BarrierHandle *barrier, int status)

Functions of this type are to be given as callback argument to GNUNET_init_barrier().

The callback will be called when status information is available for the pseudo-barrier.

Parameters

cls	the closure given to GNUNET_init_barrier()
barrier	the pseudo-barrier handle
status	status of the pseudo-barrier. The pseudo-barrier is removed once it has been crossed or an error occurs while processing it. Therefore it is invalid to call GNUNET_cancel_barrier() on a crossed or errored pseudo-barrier.

Definition at line 50 of file testing_messenger_barrier.h.

GNUNET_BarrierWaitStatusCallback

typedef void(* GNUNET_BarrierWaitStatusCallback) (void *cls, struct GNUNET_BarrierWaitHandle *waiting, int status)

Functions of this type are to be given as acallback argument to GNUNET_wait_barrier().

The callback will be called when the pseudo-barrier corresponding given in GNUNET_wait_barrier() is crossed or cancelled.

Parameters

cls	closure pointer given to GNUNET_wait_barrier()
waiting	the pseudo-barrier wait handle
status	GNUNET_SYSERR in case of error while waiting for the pseudo-barrier; GNUNET_OK if the pseudo-barrier is crossed

Definition at line 99 of file testing_messenger_barrier.h.

Function Documentation

GNUNET_init_barrier()

struct GNUNET_BarrierHandle* GNUNET_init_barrier	(	unsigned int	requirement,
		GNUNET_BarrierStatusCallback	cb,
		void *	cb_cls
	)

Initialise a pseudo-barrier and call the given callback when the required amount of peers (requirement) reach the pseudo-barrier OR upon error.

Parameters

requirement	the amount of peers that is required to reach the pseudo-barrier. Peers signal reaching a pseudo-barrier by calling GNUNET_wait_barrier().
cb	the callback to call when the pseudo-barrier is reached or upon error. Can be NULL.
cb_cls	closure for the above callback

Returns

pseudo-barrier handle; NULL upon error

Definition at line 42 of file testing_messenger_barrier.c.

{
  if (0 == requirement)
    return NULL;
 
  struct GNUNET_BarrierHandle *barrier = GNUNET_new(struct GNUNET_BarrierHandle);
 
  if (!barrier)
    return NULL;
 
  barrier->requirement = requirement;
  barrier->cb = cb;
  barrier->cls = cb_cls;
  barrier->head = NULL;
  barrier->tail = NULL;
  barrier->task = NULL;
 
  return barrier;
}

References GNUNET_BarrierHandle::cb, GNUNET_BarrierHandle::cls, GNUNET_new, GNUNET_BarrierHandle::head, GNUNET_BarrierHandle::requirement, GNUNET_BarrierHandle::tail, and GNUNET_BarrierHandle::task.

Referenced by barrier_cb(), and GNUNET_run_messenger_setup().

Here is the caller graph for this function:

GNUNET_cancel_barrier()

void GNUNET_cancel_barrier

(

struct GNUNET_BarrierHandle *

barrier

)

Cancel a pseudo-barrier.

Parameters

barrier

the pseudo-barrier handle

Definition at line 81 of file testing_messenger_barrier.c.

{
  if ((!barrier) || (barrier->task))
    return;
 
  barrier->task = GNUNET_SCHEDULER_add_now(cancel_barrier, barrier);
}

References cancel_barrier(), GNUNET_SCHEDULER_add_now(), and GNUNET_BarrierHandle::task.

Referenced by shutdown_cb().

Here is the call graph for this function:

Here is the caller graph for this function:

GNUNET_wait_barrier()

struct GNUNET_BarrierWaitHandle* GNUNET_wait_barrier	(	struct GNUNET_BarrierHandle *	barrier,
		GNUNET_BarrierWaitStatusCallback	cb,
		void *	cb_cls
	)

Wait for a pseudo-barrier to be crossed.

This function should be called for the peers which have been started by the testbed.

Parameters

barrier	the pseudo-barrier handle
cb	the pseudo-barrier wait callback
cb_cls	the closure for the above callback

Returns

pseudo-barrier wait handle which can be used to cancel the waiting at anytime before the callback is called. NULL upon error.

Definition at line 125 of file testing_messenger_barrier.c.

{
  if ((!barrier) || (0 == barrier->requirement))
    return NULL;
 
  struct GNUNET_BarrierWaitHandle *waiting = GNUNET_new(struct GNUNET_BarrierWaitHandle);
 
  if (!waiting)
    return NULL;
 
  waiting->cb = cb;
  waiting->cls = cb_cls;
  waiting->prev = NULL;
  waiting->next = NULL;
  waiting->barrier = barrier;
 
  GNUNET_CONTAINER_DLL_insert_tail(barrier->head, barrier->tail, waiting);
  barrier->requirement--;
 
  if ((barrier->requirement == 0) && (!barrier->task))
    barrier->task = GNUNET_SCHEDULER_add_now(complete_barrier, barrier);
 
  return waiting;
}

References GNUNET_BarrierWaitHandle::barrier, GNUNET_BarrierWaitHandle::cb, GNUNET_BarrierWaitHandle::cls, complete_barrier(), GNUNET_CONTAINER_DLL_insert_tail, GNUNET_new, GNUNET_SCHEDULER_add_now(), GNUNET_BarrierHandle::head, GNUNET_BarrierWaitHandle::next, GNUNET_BarrierWaitHandle::prev, GNUNET_BarrierHandle::requirement, GNUNET_BarrierHandle::tail, and GNUNET_BarrierHandle::task.

Referenced by on_message(), and on_peer().

Here is the call graph for this function:

Here is the caller graph for this function:

GNUNET_cancel_wait_barrier()

void GNUNET_cancel_wait_barrier

(

struct GNUNET_BarrierWaitHandle *

waiting

)

Cancel a pseudo-barrier wait handle.

Should not be called in or after the callback given to GNUNET_wait_barrier() has been called.

Parameters

waiting

the pseudo-barrier wait handle

Definition at line 153 of file testing_messenger_barrier.c.

{
  if (!waiting)
    return;
 
  struct GNUNET_BarrierHandle *barrier = waiting->barrier;
 
  if (!barrier)
    return;
 
  if ((barrier->requirement == 0) && (barrier->task))
  {
    GNUNET_SCHEDULER_cancel(barrier->task);
    barrier->task = NULL;
  }
 
  barrier->requirement++;
  GNUNET_CONTAINER_DLL_remove(barrier->head, barrier->tail, waiting);
 
  GNUNET_free(waiting);
}

References GNUNET_BarrierWaitHandle::barrier, GNUNET_CONTAINER_DLL_remove, GNUNET_free, GNUNET_SCHEDULER_cancel(), GNUNET_BarrierHandle::head, GNUNET_BarrierHandle::requirement, GNUNET_BarrierHandle::tail, and GNUNET_BarrierHandle::task.

Referenced by on_message(), and shutdown_cb().

Here is the call graph for this function:

Here is the caller graph for this function: