migrate ARM to new service API

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

diff --git a/src/include/gnunet_core_service.h b/src/include/gnunet_core_service.h
index 8adb5d3d7b65141b6d8502c2c61325863ecfde42..6ec486b26c0cbcebe3e9cb0be39e503f987ef39b 100644 (file)
--- a/src/include/gnunet_core_service.h
+++ b/src/include/gnunet_core_service.h
@@ -1,6 +1,6 @@
 /*
      This file is part of GNUnet.
-     Copyright (C) 2009-2014 Christian Grothoff (and other contributing authors)
+     Copyright (C) 2009-2014, 2016 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
@@ -107,6 +107,30 @@ typedef void
                                        const struct GNUNET_PeerIdentity *peer);
 
 
+/**
+ * Method called whenever a given peer connects.
+ *
+ * @param cls closure
+ * @param peer peer identity this notification is about
+ */
+typedef void *
+(*GNUNET_CORE_ConnecTEventHandler) (void *cls,
+                                    const struct GNUNET_PeerIdentity *peer,
+                                   struct GNUNET_MQ_Handle *mq);
+
+
+/**
+ * Method called whenever a peer disconnects.
+ *
+ * @param cls closure
+ * @param peer peer identity this notification is about
+ */
+typedef void
+(*GNUNET_CORE_DisconnecTEventHandler) (void *cls,
+                                       const struct GNUNET_PeerIdentity *peer,
+                                      void *peer_cls);
+
+
 /**
  * Functions with this signature are called whenever a message is
  * received or transmitted.
@@ -223,7 +247,6 @@ GNUNET_CORE_connect (const struct GNUNET_CONFIGURATION_Handle *cfg,
                      int outbound_hdr_only,
                      const struct GNUNET_CORE_MessageHandler *handlers);
 
-
 /**
  * Disconnect from the core service.    This function can only
  * be called *after* all pending #GNUNET_CORE_notify_transmit_ready
@@ -235,6 +258,76 @@ void
 GNUNET_CORE_disconnect (struct GNUNET_CORE_Handle *handle);
 
 
+/**
+ * Connect to the core service.  Note that the connection may complete
+ * (or fail) asynchronously.  This function primarily causes the given
+ * callback notification functions to be invoked whenever the
+ * specified event happens.  The maximum number of queued
+ * notifications (queue length) is per client; the queue is shared
+ * across all types of notifications.  So a slow client that registers
+ * for @a outbound_notify also risks missing @a inbound_notify messages.
+ * Certain events (such as connect/disconnect notifications) are not
+ * subject to queue size limitations.
+ *
+ * @param cfg configuration to use
+ * @param cls closure for the various callbacks that follow (including handlers in the handlers array)
+ * @param init callback to call once we have successfully
+ *        connected to the core service
+ * @param connects function to call on peer connect, can be NULL
+ * @param disconnects function to call on peer disconnect / timeout, can be NULL
+ * @param handlers callbacks for messages we care about, NULL-terminated
+ *                note that the core is allowed to drop notifications about inbound
+ *                messages if the client does not process them fast enough (for this
+ *                notification type, a bounded queue is used)
+ * @return handle to the core service (only useful for disconnect until @a init is called),
+ *           NULL on error (in this case, init is never called)
+ */
+struct GNUNET_CORE_Handle *
+GNUNET_CORE_connecT (const struct GNUNET_CONFIGURATION_Handle *cfg,
+                     void *cls,
+                     GNUNET_CORE_StartupCallback init,
+                     GNUNET_CORE_ConnecTEventHandler connects,
+                     GNUNET_CORE_DisconnecTEventHandler disconnects,
+                     const struct GNUNET_MQ_MessageHandler *handlers);
+
+
+/**
+ * Disconnect from the core service.
+ *
+ * @param handle connection to core to disconnect
+ */
+void
+GNUNET_CORE_disconnecT (struct GNUNET_CORE_Handle *handle);
+
+
+/**
+ * Inquire with CORE what options should be set for a message
+ * so that it is transmitted with the given @a priority and
+ * the given @a cork value.
+ *
+ * @param cork desired corking 
+ * @param priority desired message priority
+ * @param[out] flags set to `flags` value for #GNUNET_MQ_set_options()
+ * @return `extra` argument to give to #GNUNET_MQ_set_options()
+ */
+const void *
+GNUNET_CORE_get_mq_options (int cork,
+                           enum GNUNET_CORE_Priority priority,
+                           uint64_t *flags);
+
+
+/**
+ * Obtain the message queue for a connected peer.
+ *
+ * @param h the core handle
+ * @param pid the identity of the peer 
+ * @return NULL if @a pid is not connected
+ */
+struct GNUNET_MQ_Handle *
+GNUNET_CORE_get_mq (const struct GNUNET_CORE_Handle *h,
+                   const struct GNUNET_PeerIdentity *pid);
+
+
 /**
  * Handle for a transmission request.
  */