/*
This file is part of GNUnet
- (C) 2008--2013 Christian Grothoff (and other contributing authors)
+ Copyright (C) 2008--2013 GNUnet e.V.
GNUnet is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published
You should have received a copy of the GNU General Public License
along with GNUnet; see the file COPYING. If not, write to the
- Free Software Foundation, Inc., 59 Temple Place - Suite 330,
- Boston, MA 02111-1307, USA.
+ Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+ Boston, MA 02110-1301, USA.
*/
/**
- * @file include/gnunet_testbed_logger_service.h
- * @brief API for submitting data to the testbed logger service
- * @author Sree Harsha Totakura <sreeharsha@totakura.in>
+ * @author Sree Harsha Totakura <sreeharsha@totakura.in>
+ *
+ * @file
+ * API for submitting data to the testbed logger service
+ *
+ * @defgroup testbed-logger Testbed Logger service
+ * Submit data to the testbed logger service.
+ * @{
*/
#ifndef GNUNET_TESTBED_LOGGER_SERVICE_H
#endif
#endif
-#include "gnunet_configuration_lib.h"
+#include "gnunet_util_lib.h"
/**
* Opaque handle for the logging service
/**
* Functions of this type are called to notify a successful transmission of the
- * message to the logger service
+ * message to the logger service.
*
* @param cls the closure given to GNUNET_TESTBED_LOGGER_send()
* @param size the amount of data sent
*/
-typedef void (*GNUNET_TESTBED_LOGGER_FlushCompletion) (void *cls, size_t size);
+typedef void
+(*GNUNET_TESTBED_LOGGER_FlushCompletion) (void *cls,
+ size_t size);
/**
*
* @param h the logger handle
* @param data the data to send;
- * @param size how many bytes of data to send
+ * @param size how many bytes of @a data to send
*/
void
GNUNET_TESTBED_LOGGER_write (struct GNUNET_TESTBED_LOGGER_Handle *h,
- const void *data, size_t size);
+ const void *data,
+ size_t size);
/**
*
* @param h the logger handle
* @param cb the callback to call after the data is flushed
- * @param cb_cls the closure for the above callback
+ * @param cb_cls the closure for @a cb
*/
void
GNUNET_TESTBED_LOGGER_flush (struct GNUNET_TESTBED_LOGGER_Handle *h,
/**
- * Cancel notification upon flush.
+ * Cancel notification upon flush. Should only be used when the flush
+ * completion callback given to GNUNET_TESTBED_LOGGER_flush() is not already
+ * called.
*
* @param h the logger handle
*/
#endif /* GNUNET_TESTBED_LOGGER_SERVICE_H */
+/** @} */ /* end of group */
+
/* End of gnunet_testbed_logger_service.h */