/**
* Version number of GNUnet-core API.
*/
-#define GNUNET_CORE_VERSION 0x00000000
+#define GNUNET_CORE_VERSION 0x00000001
/**
* @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);
/**
* 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)
*/
other,
const struct GNUNET_MessageHeader *
message,
- const struct
- GNUNET_TRANSPORT_ATS_Information *
- atsi);
+ const struct GNUNET_ATS_Information
+ * atsi, unsigned int atsi_count);
/**
*/
typedef void (*GNUNET_CORE_StartupCallback) (void *cls,
struct GNUNET_CORE_Handle * server,
- const struct GNUNET_PeerIdentity *my_identity);
+ const struct GNUNET_PeerIdentity *
+ my_identity);
/**
* (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 on timeout or once we have successfully
- * connected to the core service; note that timeout is only meaningful if init is not NULL
+ * @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 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
*/
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,
- GNUNET_CORE_PeerStatusEventHandler status_events,
GNUNET_CORE_MessageCallback inbound_notify,
int inbound_hdr_only,
GNUNET_CORE_MessageCallback outbound_notify,
/**
- * 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.
+ * Handle for a transmission request.
*/
-struct GNUNET_CORE_InformationRequestContext;
+struct GNUNET_CORE_TransmitHandle;
/**
- * Obtain statistics and/or change preferences for the given peer.
- * You can only have one such pending request per peer.
+ * Ask the core to call "notify" once it is ready to transmit the
+ * 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). 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 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
+ * @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, 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; clients MUST cancel
+ * all pending transmission requests DURING the disconnect
+ * 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 (request already pending);
+ * if NULL is returned, "notify" will NOT be called.
*/
-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);
+struct GNUNET_CORE_TransmitHandle *
+GNUNET_CORE_notify_transmit_ready (struct GNUNET_CORE_Handle *handle, int cork,
+ uint32_t priority,
+ struct GNUNET_TIME_Relative maxdelay,
+ const struct GNUNET_PeerIdentity *target,
+ size_t notify_size,
+ GNUNET_CONNECTION_TransmitReadyNotify notify,
+ void *notify_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.
+ * Cancel the specified transmission-ready notification.
*
- * @param irc context returned by the original GNUNET_CORE_peer_get_info call
- * @deprecated will be replaced soon
+ * @param th handle that was returned by "notify_transmit_ready".
*/
void
-GNUNET_CORE_peer_change_preference_cancel (struct
- GNUNET_CORE_InformationRequestContext
- *irc);
+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.
+ * 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
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.
+ * 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.
*
* @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);
/**
- * Handle for a transmission request.
- */
-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
- * called after a connection to the respective peer has been
- * established (and the client has been informed about this).
- *
+ * Abort 'is_connected' test operation.
*
- * @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,
- * use NULL for this peer (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
- * 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
- * memory); 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,
- uint32_t priority,
- struct GNUNET_TIME_Relative maxdelay,
- const struct GNUNET_PeerIdentity *target,
- size_t notify_size,
- GNUNET_CONNECTION_TransmitReadyNotify notify,
- void *notify_cls);
-
-
-/**
- * Cancel the specified transmission-ready notification.
- *
- * @param th handle that was returned by "notify_transmit_ready".
+ * @param cth handle for operation to cancel
*/
void
-GNUNET_CORE_notify_transmit_ready_cancel (struct GNUNET_CORE_TransmitHandle
- *th);
+GNUNET_CORE_is_peer_connected_cancel (struct GNUNET_CORE_ConnectTestHandle *cth);
#if 0 /* keep Emacsens' auto-indent happy */
projects / oweals / gnunet.git / blobdiff