Testbed Logger service

Submit data to the testbed logger service. More...

Collaboration diagram for Testbed Logger service:

Typedefs
typedef void(*	GNUNET_TESTBED_LOGGER_FlushCompletion) (void *cls, size_t size)
	Functions of this type are called to notify a successful transmission of the message to the logger service. More...

Functions
struct GNUNET_TESTBED_LOGGER_Handle *	GNUNET_TESTBED_LOGGER_connect (const struct GNUNET_CONFIGURATION_Handle *cfg)
	Connect to the testbed logger service. More...
void	GNUNET_TESTBED_LOGGER_disconnect (struct GNUNET_TESTBED_LOGGER_Handle *h)
	Disconnect from the logger service. More...
void	GNUNET_TESTBED_LOGGER_write (struct GNUNET_TESTBED_LOGGER_Handle *h, const void *data, size_t size)
	Send data to be logged to the logger service. More...
void	GNUNET_TESTBED_LOGGER_flush (struct GNUNET_TESTBED_LOGGER_Handle *h, GNUNET_TESTBED_LOGGER_FlushCompletion cb, void *cb_cls)
	Flush the buffered data to the logger service. More...
void	GNUNET_TESTBED_LOGGER_flush_cancel (struct GNUNET_TESTBED_LOGGER_Handle *h)
	Cancel notification upon flush. More...

Detailed Description

Submit data to the testbed logger service.

Typedef Documentation

GNUNET_TESTBED_LOGGER_FlushCompletion

typedef void(* GNUNET_TESTBED_LOGGER_FlushCompletion) (void *cls, size_t size)

Functions of this type are called to notify a successful transmission of the message to the logger service.

Parameters

cls	the closure given to GNUNET_TESTBED_LOGGER_send()
size	the amount of data sent

Definition at line 82 of file gnunet_testbed_logger_service.h.

Function Documentation

GNUNET_TESTBED_LOGGER_connect()

struct GNUNET_TESTBED_LOGGER_Handle* GNUNET_TESTBED_LOGGER_connect

(

const struct GNUNET_CONFIGURATION_Handle *

cfg

)

Connect to the testbed logger service.

Parameters

cfg	configuration to use

Returns

the handle which can be used for sending data to the service; NULL upon any error

Definition at line 223 of file testbed_logger_api.c.

{
  struct GNUNET_TESTBED_LOGGER_Handle *h;
 
  h = GNUNET_new (struct GNUNET_TESTBED_LOGGER_Handle);
  h->mq = GNUNET_CLIENT_connect (cfg,
                                 "testbed-logger",
                                 NULL,
                                 &mq_error_handler,
                                 h);
  if (NULL == h->mq)
  {
    GNUNET_free (h);
    return NULL;
  }
  return h;
}

References cfg, GNUNET_CLIENT_connect(), GNUNET_free, GNUNET_new, h, GNUNET_ARM_Handle::mq, and mq_error_handler().

Here is the call graph for this function:

GNUNET_TESTBED_LOGGER_disconnect()

void GNUNET_TESTBED_LOGGER_disconnect

(

struct GNUNET_TESTBED_LOGGER_Handle *

h

)

Disconnect from the logger service.

Also cancels any pending send handles.

Parameters

h	the logger handle
h	the logger handle

Definition at line 248 of file testbed_logger_api.c.

{
  if (NULL != h->flush_completion_task)
  {
    GNUNET_SCHEDULER_cancel (h->flush_completion_task);
    h->flush_completion_task = NULL;
  }
  if (0 != h->mq_len)
    LOG (GNUNET_ERROR_TYPE_WARNING,
         "Disconnect lost %u logger message[s]\n",
         h->mq_len);
  if (NULL != h->mq)
  {
    GNUNET_MQ_destroy (h->mq);
    h->mq = NULL;
  }
  GNUNET_free (h);
}

References GNUNET_ERROR_TYPE_WARNING, GNUNET_free, GNUNET_MQ_destroy(), GNUNET_SCHEDULER_cancel(), h, LOG, and GNUNET_ARM_Handle::mq.

Here is the call graph for this function:

GNUNET_TESTBED_LOGGER_write()

void GNUNET_TESTBED_LOGGER_write	(	struct GNUNET_TESTBED_LOGGER_Handle *	h,
		const void *	data,
		size_t	size
	)

Send data to be logged to the logger service.

The data will be buffered and will be sent upon an explicit call to GNUNET_TESTBED_LOGGER_flush() or upon exceeding a threshold size.

Parameters

h	the logger handle
data	the data to send;
size	how many bytes of data to send

Definition at line 278 of file testbed_logger_api.c.

{
  if (NULL == h->mq)
    return;
  while (0 != size)
  {
    size_t fit_size = GNUNET_MIN (size,
                                  BUFFER_SIZE - h->buse);
    GNUNET_memcpy (&h->buf[h->buse],
                   data,
                   fit_size);
    h->buse += fit_size;
    data += fit_size;
    size -= fit_size;
    if (0 != size)
      dispatch_buffer (h);
  }
}

References BUFFER_SIZE, data, dispatch_buffer(), GNUNET_memcpy, GNUNET_MIN, h, GNUNET_ARM_Handle::mq, and size.

Referenced by handle_p2p_estimate().

Here is the call graph for this function:

Here is the caller graph for this function:

GNUNET_TESTBED_LOGGER_flush()

void GNUNET_TESTBED_LOGGER_flush	(	struct GNUNET_TESTBED_LOGGER_Handle *	h,
		GNUNET_TESTBED_LOGGER_FlushCompletion	cb,
		void *	cb_cls
	)

Flush the buffered data to the logger service.

Parameters

h	the logger handle
cb	the callback to call after the data is flushed
cb_cls	the closure for cb

Definition at line 301 of file testbed_logger_api.c.

{
  GNUNET_assert (NULL == h->cb);
  h->cb = cb;
  h->cb_cls = cb_cls;
  if ((NULL == h->mq) ||
      (0 == h->buse))
  {
    trigger_flush_notification (h);
    return;
  }
  dispatch_buffer (h);
}

References GNUNET_TESTBED_LOGGER_Handle::cb, GNUNET_TESTBED_LOGGER_Handle::cb_cls, dispatch_buffer(), GNUNET_assert, h, GNUNET_ARM_Handle::mq, and trigger_flush_notification().

Referenced by shutdown_task().

Here is the call graph for this function:

Here is the caller graph for this function:

GNUNET_TESTBED_LOGGER_flush_cancel()

void GNUNET_TESTBED_LOGGER_flush_cancel

(

struct GNUNET_TESTBED_LOGGER_Handle *

h

)

Cancel notification upon flush.

Should only be used when the flush completion callback given to GNUNET_TESTBED_LOGGER_flush() is not already called.

Parameters

h	the logger handle

Definition at line 326 of file testbed_logger_api.c.

{
  if (NULL != h->flush_completion_task)
  {
    GNUNET_SCHEDULER_cancel (h->flush_completion_task);
    h->flush_completion_task = NULL;
  }
  h->cb = NULL;
  h->cb_cls = NULL;
}

References GNUNET_SCHEDULER_cancel(), and h.

Here is the call graph for this function: