wip
[oweals/gnunet.git] / src / include / gnunet_core_service.h
index abfcd1d3b7c8332741ea347f78ec14363c31bed2..fd43753556c7e66ade355343071e99acfc54a223 100644 (file)
@@ -77,7 +77,7 @@ typedef void (*GNUNET_CORE_ConnectEventHandler) (void *cls,
  */
 typedef void (*GNUNET_CORE_PeerStatusEventHandler) (void *cls,
                                                    const struct
-                                                   GNUNET_PeerIdentity * peer,
+                                                   GNUNET_PeerIdentity *peer,
                                                    struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in,
                                                    struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out,
                                                    struct GNUNET_TIME_Absolute timeout,
@@ -111,7 +111,7 @@ typedef int
   (*GNUNET_CORE_MessageCallback) (void *cls,
                                   const struct GNUNET_PeerIdentity *other,
                                   const struct GNUNET_MessageHeader *message,
-                                 const struct GNUNET_TRANSPORT_ATS_Information *atsi);
+                                  const struct GNUNET_TRANSPORT_ATS_Information *atsi);
 
 
 /**
@@ -241,6 +241,19 @@ void GNUNET_CORE_disconnect (struct GNUNET_CORE_Handle *handle);
 struct GNUNET_CORE_PeerRequestHandle;
 
 
+/**
+ * Type of function called upon completion.
+ *
+ * @param cls closure
+ * @param success GNUNET_OK on success (which for request_connect
+ *        ONLY means that we transmitted the connect request to CORE,
+ *        it does not mean that we are actually now connected!);
+ *        GNUNET_NO on timeout,
+ *        GNUNET_SYSERR if core was shut down
+ */
+typedef void (*GNUNET_CORE_ControlContinuation)(void *cls, int success);
+
+
 /**
  * Request that the core should try to connect to a particular peer.
  * Once the request has been transmitted to the core, the continuation
@@ -263,7 +276,7 @@ struct GNUNET_CORE_PeerRequestHandle *
 GNUNET_CORE_peer_request_connect (struct GNUNET_CORE_Handle *h,
                                  struct GNUNET_TIME_Relative timeout,
                                  const struct GNUNET_PeerIdentity * peer,
-                                 GNUNET_SCHEDULER_Task cont,
+                                 GNUNET_CORE_ControlContinuation cont,
                                  void *cont_cls);
 
 
@@ -285,14 +298,17 @@ GNUNET_CORE_peer_request_connect_cancel (struct GNUNET_CORE_PeerRequestHandle *r
  * @param bandwidth_out available amount of outbound bandwidth
  * @param amount set to the amount that was actually reserved or unreserved;
  *               either the full requested amount or zero (no partial reservations)
+ * @param res_delay if the reservation could not be satisfied (amount was 0), how
+ *        long should the client wait until re-trying?
  * @param preference current traffic preference for the given peer
  */
 typedef void
   (*GNUNET_CORE_PeerConfigurationInfoCallback) (void *cls,
                                                 const struct
-                                                GNUNET_PeerIdentity * peer,
+                                                GNUNET_PeerIdentity *peer,
                                                struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out,
-                                               int amount,
+                                               int32_t amount,
+                                               struct GNUNET_TIME_Relative res_delay,
                                                 uint64_t preference);
 
 
@@ -312,7 +328,7 @@ struct GNUNET_CORE_InformationRequestContext;
  * @param timeout after how long should we give up (and call "info" with NULL
  *                for "peer" to signal an error)?
  * @param bw_out set to the current bandwidth limit (sending) for this peer,
- *                caller should set "bpm_out" to "-1" to avoid changing
+ *                caller should set "bpm_out" to "GNUNET_BANDWIDTH_VALUE_MAX" to avoid changing
  *                the current value; otherwise "bw_out" will be lowered to
  *                the specified value; passing a pointer to "0" can be used to force
  *                us to disconnect from the peer; "bw_out" might not increase
@@ -357,16 +373,35 @@ GNUNET_CORE_peer_change_preference_cancel (struct GNUNET_CORE_InformationRequest
 /**
  * Iterate over all connected peers.
  *
- * @param h core handle
+ * @param cfg configuration handle
  * @param peer_cb function to call with the peer information
  * @param cb_cls closure for peer_cb
  * @return GNUNET_OK on success, GNUNET_SYSERR on errors
  */
 int
-GNUNET_CORE_iterate_peers (struct GNUNET_CORE_Handle *h,
+GNUNET_CORE_iterate_peers (const struct GNUNET_CONFIGURATION_Handle *cfg,
                            GNUNET_CORE_ConnectEventHandler peer_cb,
                            void *cb_cls);
 
+/**
+ * Iterate over all currently connected peers.
+ * Calls peer_cb with each connected peer, and then
+ * once with NULL to indicate that all peers have
+ * been handled.
+ *
+ * @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
+ */
+int
+GNUNET_CORE_is_peer_connected (const struct GNUNET_CONFIGURATION_Handle *cfg,
+                               struct GNUNET_PeerIdentity *peer,
+                               GNUNET_CORE_ConnectEventHandler peer_cb,
+                               void *cb_cls);
+
 
 /**
  * Handle for a transmission request.
@@ -376,11 +411,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".  If we are not yet
- * connected to the specified peer, a call to this function will cause
- * us to try to establish a connection.
+ * 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).
+ * 
  *
  * @param handle connection to core service
+ * @param cork is corking allowed for this transmission?
  * @param priority how important is the message?
  * @param maxdelay how long can the message wait?
  * @param target who should receive the message,
@@ -389,7 +426,12 @@ struct GNUNET_CORE_TransmitHandle;
  * @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
+ *        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
+ *        all pending transmission requests DURING the disconnect
+ *        handler (unless they ensure that 'notify' never calls
+ *        'GNUNET_CORE_notify_transmit_ready').
  * @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
@@ -399,6 +441,7 @@ struct GNUNET_CORE_TransmitHandle *
 GNUNET_CORE_notify_transmit_ready (struct
                                   GNUNET_CORE_Handle
                                   *handle,
+                                  int cork,
                                   uint32_t priority,
                                   struct
                                   GNUNET_TIME_Relative