X-Git-Url: https://git.librecmc.org/?a=blobdiff_plain;f=src%2Finclude%2Fgnunet_testbed_logger_service.h;h=4d7c3f7cb6ac516f83eb200660a2e785a8f3a6f1;hb=7a7ec54a324da4820202582126795a8ac6bbe94d;hp=7e668ca1a9aa13fa303406b27a095bb08e3aa6eb;hpb=61c39c60565b386e0e12ea669556b030e8cd7180;p=oweals%2Fgnunet.git diff --git a/src/include/gnunet_testbed_logger_service.h b/src/include/gnunet_testbed_logger_service.h index 7e668ca1a..4d7c3f7cb 100644 --- a/src/include/gnunet_testbed_logger_service.h +++ b/src/include/gnunet_testbed_logger_service.h @@ -1,6 +1,6 @@ /* 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 @@ -14,14 +14,19 @@ 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 + * + * @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 @@ -35,7 +40,7 @@ extern "C" #endif #endif -#include "gnunet_configuration_lib.h" +#include "gnunet_util_lib.h" /** * Opaque handle for the logging service @@ -65,12 +70,14 @@ GNUNET_TESTBED_LOGGER_disconnect (struct GNUNET_TESTBED_LOGGER_Handle *h); /** * 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); /** @@ -80,24 +87,23 @@ 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); /** * Flush the buffered data to the logger service * * @param h the logger handle - * @param timeout how long to wait before calling the flust completion callback * @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, - struct GNUNET_TIME_Relative timeout, GNUNET_TESTBED_LOGGER_FlushCompletion cb, void *cb_cls); @@ -122,4 +128,6 @@ GNUNET_TESTBED_LOGGER_flush_cancel (struct GNUNET_TESTBED_LOGGER_Handle *h); #endif /* GNUNET_TESTBED_LOGGER_SERVICE_H */ +/** @} */ /* end of group */ + /* End of gnunet_testbed_logger_service.h */