curly wars / auto-indentation
[oweals/gnunet.git] / src / include / gnunet_core_service.h
index 7419b44a236591fe96e7808d6d36c6491cca9c7e..1f6c0f329c64d169e44c006d2a5c2a38bc16af15 100644 (file)
@@ -57,40 +57,14 @@ struct GNUNET_CORE_Handle;
  * @param cls closure
  * @param peer peer identity this notification is about
  * @param atsi performance data for the connection
+ * @param atsi_count number of records in 'atsi'
  */
 typedef void (*GNUNET_CORE_ConnectEventHandler) (void *cls,
                                                  const struct
                                                  GNUNET_PeerIdentity * peer,
                                                  const struct
-                                                 GNUNET_TRANSPORT_ATS_Information
-                                                 * atsi);
-
-
-/**
- * Method called whenever a given peer has a status change.
- *
- * @param cls closure
- * @param peer peer identity this notification is about
- * @param timeout absolute time when this peer will time out
- *        unless we see some further activity from it
- * @param bandwidth_in available amount of inbound bandwidth
- * @param bandwidth_out available amount of outbound bandwidth
- * @param atsi performance data for the connection
- */
-typedef void (*GNUNET_CORE_PeerStatusEventHandler) (void *cls,
-                                                    const struct
-                                                    GNUNET_PeerIdentity * peer,
-                                                    struct
-                                                    GNUNET_BANDWIDTH_Value32NBO
-                                                    bandwidth_in,
-                                                    struct
-                                                    GNUNET_BANDWIDTH_Value32NBO
-                                                    bandwidth_out,
-                                                    struct GNUNET_TIME_Absolute
-                                                    timeout,
-                                                    const struct
-                                                    GNUNET_TRANSPORT_ATS_Information
-                                                    * atsi);
+                                                 GNUNET_ATS_Information * atsi,
+                                                 unsigned int atsi_count);
 
 
 /**
@@ -113,6 +87,7 @@ typedef void (*GNUNET_CORE_DisconnectEventHandler) (void *cls,
  *        for loopback messages where we are both sender and receiver)
  * @param message the actual message
  * @param atsi performance data for the connection
+ * @param atsi_count number of records in 'atsi'
  * @return GNUNET_OK to keep the connection open,
  *         GNUNET_SYSERR to close it (signal serious error)
  */
@@ -121,9 +96,8 @@ typedef int (*GNUNET_CORE_MessageCallback) (void *cls,
                                             other,
                                             const struct GNUNET_MessageHeader *
                                             message,
-                                            const struct
-                                            GNUNET_TRANSPORT_ATS_Information *
-                                            atsi);
+                                            const struct GNUNET_ATS_Information
+                                            * atsi, unsigned int atsi_count);
 
 
 /**
@@ -165,7 +139,8 @@ struct GNUNET_CORE_MessageHandler
  */
 typedef void (*GNUNET_CORE_StartupCallback) (void *cls,
                                              struct GNUNET_CORE_Handle * server,
-                                             const struct GNUNET_PeerIdentity *my_identity);
+                                             const struct GNUNET_PeerIdentity *
+                                             my_identity);
 
 
 /**
@@ -186,7 +161,6 @@ typedef void (*GNUNET_CORE_StartupCallback) (void *cls,
  *        connected to the core service; note that timeout is only meaningful if init is not NULL
  * @param connects function to call on peer connect, can be NULL
  * @param disconnects function to call on peer disconnect / timeout, can be NULL
- * @param status_events function to call on peer status changes, can be NULL
  * @param inbound_notify function to call for all inbound messages, can be NULL
  *                note that the core is allowed to drop notifications about inbound
  *                messages if the client does not process them fast enough (for this
@@ -220,7 +194,6 @@ GNUNET_CORE_connect (const struct GNUNET_CONFIGURATION_Handle *cfg,
                      GNUNET_CORE_StartupCallback init,
                      GNUNET_CORE_ConnectEventHandler connects,
                      GNUNET_CORE_DisconnectEventHandler disconnects,
-                     GNUNET_CORE_PeerStatusEventHandler status_events,
                      GNUNET_CORE_MessageCallback inbound_notify,
                      int inbound_hdr_only,
                      GNUNET_CORE_MessageCallback outbound_notify,
@@ -239,110 +212,6 @@ void
 GNUNET_CORE_disconnect (struct GNUNET_CORE_Handle *handle);
 
 
-/**
- * Function called with perference change information about the given peer.
- *
- * @param cls closure
- * @param peer identifies the peer
- * @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?
- */
-typedef void (*GNUNET_CORE_PeerConfigurationInfoCallback) (void *cls,
-                                                           const struct
-                                                           GNUNET_PeerIdentity *
-                                                           peer,
-                                                           int32_t amount,
-                                                           struct
-                                                           GNUNET_TIME_Relative
-                                                           res_delay);
-
-
-
-/**
- * Context that can be used to cancel a peer information request.
- */
-struct GNUNET_CORE_InformationRequestContext;
-
-
-/**
- * Obtain statistics and/or change preferences for the given peer.
- * You can only have one such pending request per peer.
- *
- * @param h core handle
- * @param peer identifies the peer
- * @param amount reserve N bytes for receiving, negative
- *                amounts can be used to undo a (recent) reservation;
- * @param preference increase incoming traffic share preference by this amount;
- *                in the absence of "amount" reservations, we use this
- *                preference value to assign proportional bandwidth shares
- *                to all connected peers
- * @param info function to call with the resulting configuration information
- * @param info_cls closure for info
- * @return NULL on error
- * @deprecated will be replaced soon
- */
-struct GNUNET_CORE_InformationRequestContext *
-GNUNET_CORE_peer_change_preference (struct GNUNET_CORE_Handle *h,
-                                    const struct GNUNET_PeerIdentity *peer,
-                                    int32_t amount, uint64_t preference,
-                                    GNUNET_CORE_PeerConfigurationInfoCallback
-                                    info, void *info_cls);
-
-
-/**
- * Cancel request for getting information about a peer.
- * Note that an eventual change in preference, trust or bandwidth
- * assignment MAY have already been committed at the time,
- * so cancelling a request is NOT sure to undo the original
- * request.  The original request may or may not still commit.
- * The only thing cancellation ensures is that the callback
- * from the original request will no longer be called.
- *
- * @param irc context returned by the original GNUNET_CORE_peer_get_info call
- * @deprecated will be replaced soon
- */
-void
-GNUNET_CORE_peer_change_preference_cancel (struct
-                                           GNUNET_CORE_InformationRequestContext
-                                           *irc);
-
-
-/**
- * Iterate over all 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 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 (const struct GNUNET_CONFIGURATION_Handle *cfg,
-                           GNUNET_CORE_ConnectEventHandler peer_cb,
-                           void *cb_cls);
-
-
-/**
- * Check if the given peer is currently connected and return information
- * about the session if so.
- *
- * @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.
  */
@@ -397,6 +266,56 @@ GNUNET_CORE_notify_transmit_ready_cancel (struct GNUNET_CORE_TransmitHandle
                                           *th);
 
 
+
+
+
+/**
+ * Iterate over all connected peers.  Calls peer_cb with each
+ * connected peer, and then once with NULL to indicate that all peers
+ * have been handled.  Normal users of the CORE API are not expected
+ * to use this function.  It is different in that it truly lists
+ * all connections, not just those relevant to the application.  This
+ * function is used by special applications for diagnostics.  This
+ * function is NOT part of the 'versioned', 'official' API.
+ *
+ * FIXME: we should probably make it possible to 'cancel' the
+ * operation...
+ *
+ * @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 (const struct GNUNET_CONFIGURATION_Handle *cfg,
+                           GNUNET_CORE_ConnectEventHandler peer_cb,
+                           void *cb_cls);
+
+
+/**
+ * Check if the given peer is currently connected and return information
+ * about the session if so.  This function is for special cirumstances
+ * (GNUNET_TESTING uses it), normal users of the CORE API are
+ * expected to track which peers are connected based on the
+ * 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
+ */
+int
+GNUNET_CORE_is_peer_connected (const struct GNUNET_CONFIGURATION_Handle *cfg,
+                               struct GNUNET_PeerIdentity *peer,
+                               GNUNET_CORE_ConnectEventHandler peer_cb,
+                               void *cb_cls);
+
+
 #if 0                           /* keep Emacsens' auto-indent happy */
 {
 #endif