- testbed logger client API

1 files changed, 131 insertions, 0 deletions

diff --git a/src/include/gnunet_testbed_logger_service.h b/src/include/gnunet_testbed_logger_service.h
new file mode 100644
index 000000000..c8b4b7762
--- /dev/null
+++ b/src/include/gnunet_testbed_logger_service.h
@@ -0,0 +1,131 @@
+/*
+      This file is part of GNUnet
+      (C) 2008--2013 Christian Grothoff (and other contributing authors)
+
+      GNUnet is free software; you can redistribute it and/or modify
+      it under the terms of the GNU General Public License as published
+      by the Free Software Foundation; either version 3, or (at your
+      option) any later version.
+
+      GNUnet is distributed in the hope that it will be useful, but
+      WITHOUT ANY WARRANTY; without even the implied warranty of
+      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+      General Public License for more details.
+
+      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.
+ */
+
+/**
+ * @file include/gnunet_testbed_logger_service.h
+ * @brief API for submitting data to the testbed logger service
+ * @author Sree Harsha Totakura <sreeharsha@totakura.in> 
+ */
+
+#ifndef GNUNET_TESTBED_LOGGER_SERVICE_H
+#define GNUNET_TESTBED_LOGGER_SERVICE_H
+
+#ifdef __cplusplus
+extern "C"
+{
+#if 0                           /* keep Emacsens' auto-indent happy */
+}
+#endif
+#endif
+
+#include "gnunet_configuration_lib.h"
+
+/**
+ * Opaque handle for the logging service
+ */
+struct GNUNET_TESTBED_LOGGER_Handle;
+
+
+/**
+ * Connect to the testbed logger service
+ *
+ * @param cfg configuration to use
+ * @return the handle which can be used for sending data to the service; NULL
+ *           upon any error
+ */
+struct GNUNET_TESTBED_LOGGER_Handle *
+GNUNET_TESTBED_LOGGER_connect (const struct GNUNET_CONFIGURATION_Handle *cfg);
+
+
+/**
+ * Disconnect from the logger service.  Also cancels any pending send handles.
+ *
+ * @param h the logger handle
+ */
+void
+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
+ * 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);
+
+
+/**
+ * Send data to be logged to the logger service.  The data will be buffered and
+ * will be sent upon an explicit call to GNUNET_TESTBED_LOGGER_flush() or upon
+ * exceeding a threshold size.
+ *
+ * @param h the logger handle
+ * @param data the data to send;
+ * @param size how many bytes of data to send
+ * @param cb the callback to be called upon completion of the send request
+ * @param cb_cls the closure for the above callback
+ * @return the send handle which can used for cancelling the send operation.
+ *           Will be invalid if upon call to completion callback
+ */
+void
+GNUNET_TESTBED_LOGGER_write (struct GNUNET_TESTBED_LOGGER_Handle *h,
+                             const void *data, size_t size);
+
+
+/**
+ * Flush the buffered data to the logger service
+ *
+ * @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
+ */
+void
+GNUNET_TESTBED_LOGGER_flush (struct GNUNET_TESTBED_LOGGER_Handle *h,
+                             GNUNET_TESTBED_LOGGER_FlushCompletion cb,
+                             void *cb_cls);
+
+
+/**
+ * Cancel notification upon flush.
+ *
+ * @param h the logger handle
+ */
+void
+GNUNET_TESTBED_LOGGER_flush_cancel (struct GNUNET_TESTBED_LOGGER_Handle *h);
+
+
+#if 0                           /* keep Emacsens' auto-indent happy */
+{
+#endif
+#ifdef __cplusplus
+}
+#endif
+
+#endif  /* GNUNET_TESTBED_LOGGER_SERVICE_H */
+
+/* End of gnunet_testbed_logger_service.h */