X-Git-Url: https://git.librecmc.org/?a=blobdiff_plain;f=src%2Finclude%2Fgnunet_core_service.h;h=1f6c0f329c64d169e44c006d2a5c2a38bc16af15;hb=83b19539f4d322b43683f5838b72e9ec2c8e6073;hp=b93c86b795fef35780df0dc0ac7220d2f74c08f3;hpb=07b5d5dad5ba589cde1c97e574de84e5c7d5d696;p=oweals%2Fgnunet.git diff --git a/src/include/gnunet_core_service.h b/src/include/gnunet_core_service.h index b93c86b79..1f6c0f329 100644 --- a/src/include/gnunet_core_service.h +++ b/src/include/gnunet_core_service.h @@ -57,31 +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); + const struct + GNUNET_PeerIdentity * peer, + const struct + GNUNET_ATS_Information * atsi, + unsigned int atsi_count); /** @@ -91,8 +74,8 @@ typedef void (*GNUNET_CORE_PeerStatusEventHandler) (void *cls, * @param peer peer identity this notification is about */ typedef void (*GNUNET_CORE_DisconnectEventHandler) (void *cls, - const struct - GNUNET_PeerIdentity *peer); + const struct + GNUNET_PeerIdentity * peer); /** @@ -104,14 +87,17 @@ 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) */ -typedef int - (*GNUNET_CORE_MessageCallback) (void *cls, - const struct GNUNET_PeerIdentity *other, - const struct GNUNET_MessageHeader *message, - const struct GNUNET_TRANSPORT_ATS_Information *atsi); +typedef int (*GNUNET_CORE_MessageCallback) (void *cls, + const struct GNUNET_PeerIdentity * + other, + const struct GNUNET_MessageHeader * + message, + const struct GNUNET_ATS_Information + * atsi, unsigned int atsi_count); /** @@ -141,25 +127,20 @@ struct GNUNET_CORE_MessageHandler /** - * Function called after GNUNET_CORE_connect has succeeded - * (or failed for good). Note that the private key of the - * peer is intentionally not exposed here; if you need it, - * your process should try to read the private key file - * directly (which should work if you are authorized...). + * Function called after GNUNET_CORE_connect has succeeded (or failed + * for good). Note that the private key of the peer is intentionally + * not exposed here; if you need it, your process should try to read + * the private key file directly (which should work if you are + * authorized...). * * @param cls closure * @param server handle to the server, NULL if we failed * @param my_identity ID of this peer, NULL if we failed - * @param publicKey public key of this peer, NULL if we failed */ -typedef void - (*GNUNET_CORE_StartupCallback) (void *cls, - struct GNUNET_CORE_Handle * server, - const struct GNUNET_PeerIdentity * - my_identity, - const struct - GNUNET_CRYPTO_RsaPublicKeyBinaryEncoded * - publicKey); +typedef void (*GNUNET_CORE_StartupCallback) (void *cls, + struct GNUNET_CORE_Handle * server, + const struct GNUNET_PeerIdentity * + my_identity); /** @@ -180,7 +161,6 @@ typedef void * 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 @@ -190,7 +170,7 @@ typedef void * can be used to improve efficiency, ignored if inbound_notify is NULL * 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) + * notification type, a bounded queue is used) * @param outbound_notify function to call for all outbound messages, can be NULL; * note that the core is allowed to drop notifications about outbound * messages if the client does not process them fast enough (for this @@ -210,12 +190,10 @@ typedef void */ struct GNUNET_CORE_Handle * GNUNET_CORE_connect (const struct GNUNET_CONFIGURATION_Handle *cfg, - unsigned int queue_size, - void *cls, + unsigned int queue_size, 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, @@ -224,161 +202,14 @@ GNUNET_CORE_connect (const struct GNUNET_CONFIGURATION_Handle *cfg, /** - * Disconnect from the core service. This function can only + * Disconnect from the core service. This function can only * be called *after* all pending 'GNUNET_CORE_notify_transmit_ready' * requests have been explicitly cancelled. * * @param handle connection to core to disconnect */ -void GNUNET_CORE_disconnect (struct GNUNET_CORE_Handle *handle); - - -/** - * Handle for a request to the core to connect or disconnect - * from a particular peer. Can be used to cancel the request - * (before the 'cont'inuation is called). - */ -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 - * function will be called. Note that this does NOT mean that a - * connection was successfully established -- it only means that the - * core will now try. Successful establishment of the connection - * will be signalled to the 'connects' callback argument of - * 'GNUNET_CORE_connect' only. If the core service does not respond - * to our connection attempt within the given time frame, 'cont' will - * be called with the TIMEOUT reason code. - * - * @param h core handle - * @param timeout how long to try to talk to core - * @param peer who should we connect to - * @param cont function to call once the request has been completed (or timed out) - * @param cont_cls closure for cont - * @return NULL on error (cont will not be called), otherwise handle for cancellation - */ -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_CORE_ControlContinuation cont, - void *cont_cls); - - -/** - * Cancel a pending request to connect to a particular peer. Must not - * be called after the 'cont' function was invoked. - * - * @param req request handle that was returned for the original request - */ -void -GNUNET_CORE_peer_request_connect_cancel (struct GNUNET_CORE_PeerRequestHandle *req); - - -/** - * Function called with perference change information about the given peer. - * - * @param cls closure - * @param peer identifies the peer - * @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 preference current traffic preference for the given peer - */ -typedef void - (*GNUNET_CORE_PeerConfigurationInfoCallback) (void *cls, - const struct - GNUNET_PeerIdentity * peer, - struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out, - int amount, - uint64_t preference); - - - -/** - * 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 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 "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 - * as specified since the upper bound is generally - * determined by the other 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 - */ -struct GNUNET_CORE_InformationRequestContext * -GNUNET_CORE_peer_change_preference (struct GNUNET_CORE_Handle *h, - const struct GNUNET_PeerIdentity *peer, - struct GNUNET_TIME_Relative timeout, - struct GNUNET_BANDWIDTH_Value32NBO bw_out, - 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 - */ void -GNUNET_CORE_peer_change_preference_cancel (struct GNUNET_CORE_InformationRequestContext *irc); - - -/** - * Iterate over all connected peers. - * - * @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); +GNUNET_CORE_disconnect (struct GNUNET_CORE_Handle *handle); /** @@ -392,9 +223,10 @@ struct GNUNET_CORE_TransmitHandle; * 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, @@ -415,23 +247,13 @@ struct GNUNET_CORE_TransmitHandle; * memory); if NULL is returned, "notify" will NOT be called. */ struct GNUNET_CORE_TransmitHandle * -GNUNET_CORE_notify_transmit_ready (struct - GNUNET_CORE_Handle - *handle, - uint32_t priority, - struct - GNUNET_TIME_Relative - maxdelay, - const - struct - GNUNET_PeerIdentity - *target, - size_t - notify_size, - GNUNET_CONNECTION_TransmitReadyNotify - notify, - void - *notify_cls); +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); /** @@ -444,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