2 This file is part of GNUnet
3 (C) 2008--2013 Christian Grothoff (and other contributing authors)
5 GNUnet is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published
7 by the Free Software Foundation; either version 3, or (at your
8 option) any later version.
10 GNUnet is distributed in the hope that it will be useful, but
11 WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with GNUnet; see the file COPYING. If not, write to the
17 Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18 Boston, MA 02111-1307, USA.
22 * @file include/gnunet_testbed_logger_service.h
23 * @brief API for submitting data to the testbed logger service
24 * @author Sree Harsha Totakura <sreeharsha@totakura.in>
27 #ifndef GNUNET_TESTBED_LOGGER_SERVICE_H
28 #define GNUNET_TESTBED_LOGGER_SERVICE_H
33 #if 0 /* keep Emacsens' auto-indent happy */
38 #include "gnunet_configuration_lib.h"
41 * Opaque handle for the logging service
43 struct GNUNET_TESTBED_LOGGER_Handle;
47 * Connect to the testbed logger service
49 * @param cfg configuration to use
50 * @return the handle which can be used for sending data to the service; NULL
53 struct GNUNET_TESTBED_LOGGER_Handle *
54 GNUNET_TESTBED_LOGGER_connect (const struct GNUNET_CONFIGURATION_Handle *cfg);
58 * Disconnect from the logger service. Also cancels any pending send handles.
60 * @param h the logger handle
63 GNUNET_TESTBED_LOGGER_disconnect (struct GNUNET_TESTBED_LOGGER_Handle *h);
67 * Opaque handle representing a send request
69 struct GNUNET_TESTBED_LOGGER_SendHandle;
73 * Functions of this type are called to notify a successful transmission of the
74 * message to the logger service
76 * @param cls the closure given to GNUNET_TESTBED_LOGGER_send()
77 * @param size the amount of data sent
79 typedef void (*GNUNET_TESTBED_LOGGER_FlushCompletion) (void *cls, size_t size);
83 * Send data to be logged to the logger service. The data will be buffered and
84 * will be sent upon an explicit call to GNUNET_TESTBED_LOGGER_flush() or upon
85 * exceeding a threshold size.
87 * @param h the logger handle
88 * @param data the data to send;
89 * @param size how many bytes of data to send
92 GNUNET_TESTBED_LOGGER_write (struct GNUNET_TESTBED_LOGGER_Handle *h,
93 const void *data, size_t size);
97 * Flush the buffered data to the logger service
99 * @param h the logger handle
100 * @param cb the callback to call after the data is flushed
101 * @param cb_cls the closure for the above callback
104 GNUNET_TESTBED_LOGGER_flush (struct GNUNET_TESTBED_LOGGER_Handle *h,
105 GNUNET_TESTBED_LOGGER_FlushCompletion cb,
110 * Cancel notification upon flush.
112 * @param h the logger handle
115 GNUNET_TESTBED_LOGGER_flush_cancel (struct GNUNET_TESTBED_LOGGER_Handle *h);
118 #if 0 /* keep Emacsens' auto-indent happy */
125 #endif /* GNUNET_TESTBED_LOGGER_SERVICE_H */
127 /* End of gnunet_testbed_logger_service.h */