input checks

[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 a317fbdd56e220fa66b28d3abcbcb70cea4d169d..c648c3ce01e6c4a61567d6bdac5a778fd1fc6af0 100644 (file)
--- a/src/include/gnunet_core_service.h
+++ b/src/include/gnunet_core_service.h
@@ -42,7 +42,7 @@ extern "C"
 /**
  * Version number of GNUnet-core API.
  */
-#define GNUNET_CORE_VERSION 0x00000000
+#define GNUNET_CORE_VERSION 0x00000001
 
 
 /**
@@ -148,14 +148,13 @@ typedef void (*GNUNET_CORE_StartupCallback) (void *cls,
  * (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 but the queue is shared
+ * notifications (queue length) is per client; the queue is shared
  * across all types of notifications.  So a slow client that registers
  * for 'outbound_notify' also risks missing 'inbound_notify' messages.
  * Certain events (such as connect/disconnect notifications) are not
  * subject to queue size limitations.
  *
  * @param cfg configuration to use
- * @param queue_size size of the per-peer message queue
  * @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
@@ -190,7 +189,7 @@ typedef void (*GNUNET_CORE_StartupCallback) (void *cls,
  */
 struct GNUNET_CORE_Handle *
 GNUNET_CORE_connect (const struct GNUNET_CONFIGURATION_Handle *cfg,
-                     unsigned int queue_size, void *cls,
+                     void *cls,
                      GNUNET_CORE_StartupCallback init,
                      GNUNET_CORE_ConnectEventHandler connects,
                      GNUNET_CORE_DisconnectEventHandler disconnects,
@@ -220,10 +219,13 @@ struct GNUNET_CORE_TransmitHandle;
 
 /**
  * Ask the core to call "notify" once it is ready to transmit the
- * given number of bytes to the specified "target".   Must only be
+ * given number of bytes to the specified "target".  Must only be
  * called after a connection to the respective peer has been
- * established (and the client has been informed about this).
- *
+ * established (and the client has been informed about this).  You may
+ * have one request of this type pending for each connected peer at
+ * any time.  If a peer disconnects, the application MUST call
+ * "GNUNET_CORE_notify_transmit_ready_cancel" on the respective
+ * transmission request, if one such request is pending.
  *
  * @param handle connection to core service
  * @param cork is corking allowed for this transmission?
@@ -232,18 +234,13 @@ struct GNUNET_CORE_TransmitHandle;
  * @param target who should receive the message, never NULL (can be this peer's identity for loopback)
  * @param notify_size how many bytes of buffer space does notify want?
  * @param notify function to call when buffer space is available;
- *        will be called with NULL on timeout or if the overall queue
- *        for this peer is larger than queue_size and this is currently
- *        the message with the lowest priority; will also be called
- *        with 'NULL' buf if the peer disconnects; since the disconnect
- *        signal will be emmitted even later, clients MUST cancel
+ *        will be called with NULL on timeout; clients MUST cancel
  *        all pending transmission requests DURING the disconnect
- *        handler (unless they ensure that 'notify' never calls
- *        'GNUNET_CORE_notify_transmit_ready').
+ *        handler
  * @param notify_cls closure for notify
  * @return non-NULL if the notify callback was queued,
- *         NULL if we can not even queue the request (insufficient
- *         memory); if NULL is returned, "notify" will NOT be called.
+ *         NULL if we can not even queue the request (request already pending);
+ *         if NULL is returned, "notify" will NOT be called.
  */
 struct GNUNET_CORE_TransmitHandle *
 GNUNET_CORE_notify_transmit_ready (struct GNUNET_CORE_Handle *handle, int cork,
@@ -291,6 +288,12 @@ GNUNET_CORE_iterate_peers (const struct GNUNET_CONFIGURATION_Handle *cfg,
                            void *cb_cls);
 
 
+/**
+ * Handle to cancel 'is_peer_connected' test.
+ */
+struct GNUNET_CORE_ConnectTestHandle;
+
+
 /**
  * Check if the given peer is currently connected and return information
  * about the session if so.  This function is for special cirumstances
@@ -299,22 +302,28 @@ GNUNET_CORE_iterate_peers (const struct GNUNET_CONFIGURATION_Handle *cfg,
  * connect/disconnect callbacks from GNUNET_CORE_connect.  This
  * function is NOT part of the 'versioned', 'official' API.
  *
- * FIXME: we should probably make it possible to 'cancel' the
- * operation...
- *
  * @param cfg configuration to use
  * @param peer the specific peer to check for
  * @param peer_cb function to call with the peer information
  * @param cb_cls closure for peer_cb
- * @return GNUNET_OK if iterating, GNUNET_SYSERR on error
+ * @return handle to cancel the operation
  */
-int
+struct GNUNET_CORE_ConnectTestHandle *
 GNUNET_CORE_is_peer_connected (const struct GNUNET_CONFIGURATION_Handle *cfg,
-                               struct GNUNET_PeerIdentity *peer,
+                               const struct GNUNET_PeerIdentity *peer,
                                GNUNET_CORE_ConnectEventHandler peer_cb,
                                void *cb_cls);
 
 
+/**
+ * Abort 'is_connected' test operation.
+ *
+ * @param cth handle for operation to cancel
+ */
+void
+GNUNET_CORE_is_peer_connected_cancel (struct GNUNET_CORE_ConnectTestHandle *cth);
+
+
 #if 0                           /* keep Emacsens' auto-indent happy */
 {
 #endif