projects
/
oweals
/
gnunet.git
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
raw
|
inline
| side by side
introducing GNUNET_CRYPTO_ecdhe_create2() to avoid malloc nonsense
[oweals/gnunet.git]
/
src
/
include
/
gnunet_testbed_logger_service.h
diff --git
a/src/include/gnunet_testbed_logger_service.h
b/src/include/gnunet_testbed_logger_service.h
index 084d88387b8fe628612deddabcb28ceb45c60a94..4d7c3f7cb6ac516f83eb200660a2e785a8f3a6f1 100644
(file)
--- 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
/*
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
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
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., 5
9 Temple Place - Suite 330
,
- Boston, MA 0211
1-1307
, USA.
+ Free Software Foundation, Inc., 5
1 Franklin Street, Fifth Floor
,
+ Boston, MA 0211
0-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
*/
#ifndef GNUNET_TESTBED_LOGGER_SERVICE_H
@@
-35,7
+40,7
@@
extern "C"
#endif
#endif
#endif
#endif
-#include "gnunet_
configuration
_lib.h"
+#include "gnunet_
util
_lib.h"
/**
* Opaque handle for the logging service
/**
* Opaque handle for the logging service
@@
-63,20
+68,16
@@
void
GNUNET_TESTBED_LOGGER_disconnect (struct GNUNET_TESTBED_LOGGER_Handle *h);
GNUNET_TESTBED_LOGGER_disconnect (struct GNUNET_TESTBED_LOGGER_Handle *h);
-/**
- * Opaque handle representing a send request
- */
-struct GNUNET_TESTBED_LOGGER_SendHandle;
-
-
/**
* Functions of this type are called to notify a successful transmission of the
/**
* 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
*/
*
* @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);
/**
/**
@@
-86,11
+87,12
@@
typedef void (*GNUNET_TESTBED_LOGGER_FlushCompletion) (void *cls, size_t size);
*
* @param h the logger handle
* @param data the data to send;
*
* @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,
*/
void
GNUNET_TESTBED_LOGGER_write (struct GNUNET_TESTBED_LOGGER_Handle *h,
- const void *data, size_t size);
+ const void *data,
+ size_t size);
/**
/**
@@
-98,7
+100,7
@@
GNUNET_TESTBED_LOGGER_write (struct GNUNET_TESTBED_LOGGER_Handle *h,
*
* @param h the logger handle
* @param cb the callback to call after the data is flushed
*
* @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,
*/
void
GNUNET_TESTBED_LOGGER_flush (struct GNUNET_TESTBED_LOGGER_Handle *h,
@@
-107,7
+109,9
@@
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
*/
*
* @param h the logger handle
*/
@@
-124,4
+128,6
@@
GNUNET_TESTBED_LOGGER_flush_cancel (struct GNUNET_TESTBED_LOGGER_Handle *h);
#endif /* GNUNET_TESTBED_LOGGER_SERVICE_H */
#endif /* GNUNET_TESTBED_LOGGER_SERVICE_H */
+/** @} */ /* end of group */
+
/* End of gnunet_testbed_logger_service.h */
/* End of gnunet_testbed_logger_service.h */