-work around MHD_USE_TLS not being in old MHD versions

[oweals/gnunet.git] / src / include / gnunet_service_lib.h

diff --git a/src/include/gnunet_service_lib.h b/src/include/gnunet_service_lib.h
index 797857ed8541f0334dc4db127dc1fde97b81e9e7..31abe0ab62238c0abdca0ad332193b9763ff20bc 100644 (file)
--- a/src/include/gnunet_service_lib.h
+++ b/src/include/gnunet_service_lib.h
@@ -248,6 +248,60 @@ typedef void
                                     void *internal_cls);
 
 
+/**
+ * Low-level function to start a service if the scheduler
+ * is already running.  Should only be used directly in
+ * special cases.
+ *
+ * The function will launch the service with the name @a service_name
+ * using the @a service_options to configure its shutdown
+ * behavior. When clients connect or disconnect, the respective
+ * @a connect_cb or @a disconnect_cb functions will be called. For
+ * messages received from the clients, the respective @a handlers will
+ * be invoked; for the closure of the handlers we use the return value
+ * from the @a connect_cb invocation of the respective client.
+ *
+ * Each handler MUST call #GNUNET_SERVICE_client_continue() after each
+ * message to receive further messages from this client.  If
+ * #GNUNET_SERVICE_client_continue() is not called within a short
+ * time, a warning will be logged. If delays are expected, services
+ * should call #GNUNET_SERVICE_client_disable_continue_warning() to
+ * disable the warning.
+ *
+ * Clients sending invalid messages (based on @a handlers) will be
+ * dropped. Additionally, clients can be dropped at any time using
+ * #GNUNET_SERVICE_client_drop().
+ *
+ * The service must be stopped using #GNUNET_SERVICE_stoP().
+ *
+ * @param service_name name of the service to run
+ * @param cfg configuration to use
+ * @param connect_cb function to call whenever a client connects
+ * @param disconnect_cb function to call whenever a client disconnects
+ * @param cls closure argument for @a connect_cb and @a disconnect_cb
+ * @param handlers NULL-terminated array of message handlers for the service,
+ *                 the closure will be set to the value returned by
+ *                 the @a connect_cb for the respective connection
+ * @return NULL on error
+ */
+struct GNUNET_SERVICE_Handle *
+GNUNET_SERVICE_starT (const char *service_name,
+                      const struct GNUNET_CONFIGURATION_Handle *cfg,
+                      GNUNET_SERVICE_ConnectHandler connect_cb,
+                      GNUNET_SERVICE_DisconnectHandler disconnect_cb,
+                      void *cls,
+                      const struct GNUNET_MQ_MessageHandler *handlers);
+
+
+/**
+ * Stops a service that was started with #GNUNET_SERVICE_starT().
+ *
+ * @param srv service to stop
+ */
+void
+GNUNET_SERVICE_stoP (struct GNUNET_SERVICE_Handle *srv);
+
+
 /**
  * Creates the "main" function for a GNUnet service.  You
  * should almost always use the #GNUNET_SERVICE_MAIN macro
@@ -336,16 +390,36 @@ GNUNET_SERVICE_ruN_ (int argc,
  * @param connect_cb function to call whenever a client connects
  * @param disconnect_cb function to call whenever a client disconnects
  * @param cls closure argument for @a service_init_cb, @a connect_cb and @a disconnect_cb
- * @param handlers NULL-terminated array of message handlers for the service,
+ * @param ... array of message handlers for the service, terminated
+ *            by #GNUNET_MQ_handler_end();
  *                 the closure will be set to the value returned by
  *                 the @a connect_cb for the respective connection
  * @return 0 on success, non-zero on error
+ *
+ * Sample invocation:
+ * <code>
+ * GNUNET_SERVICE_MAIN
+ * ("resolver",
+ *  GNUNET_SERVICE_OPTION_NONE,
+ *  &init_cb,
+ *  &connect_cb,
+ *  &disconnect_cb,
+ *  closure_for_cb,
+ *  GNUNET_MQ_hd_var_size (get,
+ *                        GNUNET_MESSAGE_TYPE_RESOLVER_REQUEST,
+ *                        struct GNUNET_RESOLVER_GetMessage,
+ *                        NULL),
+ *  GNUNET_MQ_handler_end ());
+ * </code>
  */
-#define GNUNET_SERVICE_MAIN(service_name,service_options,init_cb,connect_cb,disconnect_cb,cls,handlers) \
+#define GNUNET_SERVICE_MAIN(service_name,service_options,init_cb,connect_cb,disconnect_cb,cls,...) \
   int \
   main (int argc,\
         char *const *argv)\
   { \
+    struct GNUNET_MQ_MessageHandler mh[] = { \
+      __VA_ARGS__ \
+    };                       \
     return GNUNET_SERVICE_ruN_ (argc, \
                                 argv, \
                                 service_name, \
@@ -354,7 +428,7 @@ GNUNET_SERVICE_ruN_ (int argc,
                                 connect_cb, \
                                 disconnect_cb, \
                                 cls, \
-                                handlers); \
+                                mh); \
   }
 
 
@@ -387,6 +461,16 @@ void
 GNUNET_SERVICE_client_continue (struct GNUNET_SERVICE_Client *c);
 
 
+/**
+ * Obtain the message queue of @a c.  Convenience function.
+ *
+ * @param c the client to continue receiving from
+ * @return the message queue of @a c
+ */
+struct GNUNET_MQ_Handle *
+GNUNET_SERVICE_client_get_mq (struct GNUNET_SERVICE_Client *c);
+
+
 /**
  * Disable the warning the server issues if a message is not
  * acknowledged in a timely fashion.  Use this call if a client is