2 This file is part of GNUnet
3 Copyright (C) 2008--2013 GNUnet e.V.
5 GNUnet is free software: you can redistribute it and/or modify it
6 under the terms of the GNU Affero General Public License as published
7 by the Free Software Foundation, either version 3 of the License,
8 or (at your 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 Affero General Public License for more details.
15 You should have received a copy of the GNU Affero General Public License
16 along with this program. If not, see <http://www.gnu.org/licenses/>.
18 SPDX-License-Identifier: AGPL3.0-or-later
22 * @author Sree Harsha Totakura <sreeharsha@totakura.in>
25 * API for submitting data to the testbed logger service
27 * @defgroup testbed-logger Testbed Logger service
28 * Submit data to the testbed logger service.
32 #ifndef GNUNET_TESTBED_LOGGER_SERVICE_H
33 #define GNUNET_TESTBED_LOGGER_SERVICE_H
38 #if 0 /* keep Emacsens' auto-indent happy */
43 #include "gnunet_util_lib.h"
46 * Opaque handle for the logging service
48 struct GNUNET_TESTBED_LOGGER_Handle;
52 * Connect to the testbed logger service
54 * @param cfg configuration to use
55 * @return the handle which can be used for sending data to the service; NULL
58 struct GNUNET_TESTBED_LOGGER_Handle *
59 GNUNET_TESTBED_LOGGER_connect (const struct GNUNET_CONFIGURATION_Handle *cfg);
63 * Disconnect from the logger service. Also cancels any pending send handles.
65 * @param h the logger handle
68 GNUNET_TESTBED_LOGGER_disconnect (struct GNUNET_TESTBED_LOGGER_Handle *h);
72 * Functions of this type are called to notify a successful transmission of the
73 * message to the logger service.
75 * @param cls the closure given to GNUNET_TESTBED_LOGGER_send()
76 * @param size the amount of data sent
79 (*GNUNET_TESTBED_LOGGER_FlushCompletion) (void *cls,
84 * Send data to be logged to the logger service. The data will be buffered and
85 * will be sent upon an explicit call to GNUNET_TESTBED_LOGGER_flush() or upon
86 * exceeding a threshold size.
88 * @param h the logger handle
89 * @param data the data to send;
90 * @param size how many bytes of @a data to send
93 GNUNET_TESTBED_LOGGER_write (struct GNUNET_TESTBED_LOGGER_Handle *h,
99 * Flush the buffered data to the logger service
101 * @param h the logger handle
102 * @param cb the callback to call after the data is flushed
103 * @param cb_cls the closure for @a cb
106 GNUNET_TESTBED_LOGGER_flush (struct GNUNET_TESTBED_LOGGER_Handle *h,
107 GNUNET_TESTBED_LOGGER_FlushCompletion cb,
112 * Cancel notification upon flush. Should only be used when the flush
113 * completion callback given to GNUNET_TESTBED_LOGGER_flush() is not already
116 * @param h the logger handle
119 GNUNET_TESTBED_LOGGER_flush_cancel (struct GNUNET_TESTBED_LOGGER_Handle *h);
122 #if 0 /* keep Emacsens' auto-indent happy */
129 #endif /* GNUNET_TESTBED_LOGGER_SERVICE_H */
131 /** @} */ /* end of group */
133 /* End of gnunet_testbed_logger_service.h */