X-Git-Url: https://git.librecmc.org/?a=blobdiff_plain;f=src%2Ftransport%2Fgnunet-service-transport_neighbours.h;h=5b37ccb6aacbfa3a6f484c7e1964f45dda9cbed1;hb=f181f6eaf8cdb1fdb47dc98cf171ad1be842b441;hp=2810609138e53155a047a3f464dcdc9d057ddf18;hpb=63d15aa9d1ea50933ff34fc42916024a5d3196bf;p=oweals%2Fgnunet.git diff --git a/src/transport/gnunet-service-transport_neighbours.h b/src/transport/gnunet-service-transport_neighbours.h index 281060913..5b37ccb6a 100644 --- a/src/transport/gnunet-service-transport_neighbours.h +++ b/src/transport/gnunet-service-transport_neighbours.h @@ -43,10 +43,9 @@ * @param connect_cb function to call if we connect to a peer * @param disconnect_cb function to call if we disconnect from a peer */ -void -GST_neighbours_start (void *cls, - GNUNET_TRANSPORT_NotifyConnect connect_cb, - GNUNET_TRANSPORT_NotifyDisconnect disconnect_cb); +void +GST_neighbours_start (void *cls, GNUNET_TRANSPORT_NotifyConnect connect_cb, + GNUNET_TRANSPORT_NotifyDisconnect disconnect_cb); /** @@ -67,7 +66,7 @@ GST_neighbours_try_connect (const struct GNUNET_PeerIdentity *target); /** * Test if we're connected to the given peer. - * + * * @param target peer to test * @return GNUNET_YES if we are connected, GNUNET_NO if not */ @@ -81,8 +80,7 @@ GST_neighbours_test_connected (const struct GNUNET_PeerIdentity *target); * @param cls closure * @param success GNUNET_OK on success, GNUNET_NO on failure, GNUNET_SYSERR if we're not connected */ -typedef void (*GST_NeighbourSendContinuation)(void *cls, - int success); +typedef void (*GST_NeighbourSendContinuation) (void *cls, int success); /** @@ -96,12 +94,9 @@ typedef void (*GST_NeighbourSendContinuation)(void *cls, * @param cont_cls closure for 'cont' */ void -GST_neighbours_send (const struct GNUNET_PeerIdentity *target, - const void *msg, - size_t msg_size, - struct GNUNET_TIME_Relative timeout, - GST_NeighbourSendContinuation cont, - void *cont_cls); +GST_neighbours_send (const struct GNUNET_PeerIdentity *target, const void *msg, + size_t msg_size, struct GNUNET_TIME_Relative timeout, + GST_NeighbourSendContinuation cont, void *cont_cls); /** @@ -111,22 +106,47 @@ GST_neighbours_send (const struct GNUNET_PeerIdentity *target, * * @param sender sender of the message * @param size size of the message + * @param do_forward set to GNUNET_YES if the message should be forwarded to clients + * GNUNET_NO if the neighbour is not connected or violates the quota * @return how long to wait before reading more from this sender */ struct GNUNET_TIME_Relative -GST_neighbours_calculate_receive_delay (const struct GNUNET_PeerIdentity *sender, - ssize_t size); +GST_neighbours_calculate_receive_delay (const struct GNUNET_PeerIdentity + *sender, ssize_t size, int *do_forward); + + +/** + * Keep the connection to the given neighbour alive longer, + * we received a KEEPALIVE (or equivalent). + * + * @param neighbour neighbour to keep alive + */ +void +GST_neighbours_keepalive (const struct GNUNET_PeerIdentity *neighbour); + +/** + * We received a KEEP_ALIVE_RESPONSE message and use this to calculate latency + * to this peer + * + * @param neighbour neighbour to keep alive + * @param ats performance data + * @param ats_count number of entries in ats + */ +void +GST_neighbours_keepalive_response (const struct GNUNET_PeerIdentity *neighbour, + const struct GNUNET_ATS_Information *ats, + uint32_t ats_count); /** * Change the incoming quota for the given peer. * * @param neighbour identity of peer to change qutoa for - * @param quota new quota + * @param quota new quota */ void GST_neighbours_set_incoming_quota (const struct GNUNET_PeerIdentity *neighbour, - struct GNUNET_BANDWIDTH_Value32NBO quota); + struct GNUNET_BANDWIDTH_Value32NBO quota); /** @@ -144,44 +164,149 @@ GST_neighbours_force_disconnect (const struct GNUNET_PeerIdentity *target); * @param cls closure * @param neighbour identity of the neighbour * @param ats performance data - * @param ats_count number of entries in ats (excluding 0-termination) + * @param ats_count number of entries in ats (including 0-termination) + * @param address the address (or NULL) */ -typedef void (*GST_NeighbourIterator)(void *cls, - const struct GNUNET_PeerIdentity *neighbour, - const struct GNUNET_TRANSPORT_ATS_Information *ats, - uint32_t ats_count); +typedef void (*GST_NeighbourIterator) (void *cls, + const struct GNUNET_PeerIdentity * + neighbour, + const struct GNUNET_ATS_Information * + ats, uint32_t ats_count, + const struct GNUNET_HELLO_Address * + address); /** * Iterate over all connected neighbours. * - * @param cb function to call + * @param cb function to call * @param cb_cls closure for cb */ void -GST_neighbours_iterate (GST_NeighbourIterator cb, - void *cb_cls); +GST_neighbours_iterate (GST_NeighbourIterator cb, void *cb_cls); + + +/** + * A session was terminated. Take note. + * + * @param peer identity of the peer where the session died + * @param session session that is gone + */ +void +GST_neighbours_session_terminated (const struct GNUNET_PeerIdentity *peer, + struct Session *session); /** * For an existing neighbour record, set the active connection to * use the given address. * - * @param plugin_name name of transport that delivered the PONG + * @param peer identity of the peer to switch the address for * @param address address of the other peer, NULL if other peer * connected to us - * @param address_len number of bytes in address + * @param session session to use (or NULL) + * @param ats performance data + * @param ats_count number of entries in ats + * @param bandwidth_in inbound quota to be used when connection is up + * @param bandwidth_out outbound quota to be used when connection is up + * @return GNUNET_YES if we are currently connected, GNUNET_NO if the + * connection is not up (yet) + */ +int +GST_neighbours_switch_to_address_3way (const struct GNUNET_PeerIdentity *peer, + const struct GNUNET_HELLO_Address + *address, struct Session *session, + const struct GNUNET_ATS_Information *ats, + uint32_t ats_count, + struct GNUNET_BANDWIDTH_Value32NBO + bandwidth_in, + struct GNUNET_BANDWIDTH_Value32NBO + bandwidth_out); + + +/** + * We received a 'SESSION_CONNECT' message from the other peer. + * Consider switching to it. + * + * @param message possibly a 'struct SessionConnectMessage' (check format) + * @param peer identity of the peer to switch the address for + * @param address address of the other peer, NULL if other peer + * connected to us + * @param session session to use (or NULL) * @param ats performance data * @param ats_count number of entries in ats (excluding 0-termination) + */ +void +GST_neighbours_handle_connect (const struct GNUNET_MessageHeader *message, + const struct GNUNET_PeerIdentity *peer, + const struct GNUNET_HELLO_Address *address, + struct Session *session, + const struct GNUNET_ATS_Information *ats, + uint32_t ats_count); + + +/** + * We received a 'SESSION_CONNECT_ACK' message from the other peer. + * Consider switching to it. + * + * @param message possibly a 'struct SessionConnectMessage' (check format) + * @param peer identity of the peer to switch the address for + * @param address address of the other peer, NULL if other peer + * connected to us + * @param session session to use (or NULL) + * @param ats performance data + * @param ats_count number of entries in ats + */ +void +GST_neighbours_handle_connect_ack (const struct GNUNET_MessageHeader *message, + const struct GNUNET_PeerIdentity *peer, + const struct GNUNET_HELLO_Address *address, + struct Session *session, + const struct GNUNET_ATS_Information *ats, + uint32_t ats_count); + +void +GST_neighbours_handle_ack (const struct GNUNET_MessageHeader *message, + const struct GNUNET_PeerIdentity *peer, + const struct GNUNET_HELLO_Address *address, + struct Session *session, + const struct GNUNET_ATS_Information *ats, + uint32_t ats_count); + + +/** + * Obtain current latency information for the given neighbour. + * + * @param peer + * @return observed latency of the address, FOREVER if the address was + * never successfully validated + */ +struct GNUNET_TIME_Relative +GST_neighbour_get_latency (const struct GNUNET_PeerIdentity *peer); + + +/** + * Obtain current address information for the given neighbour. + * + * @param peer + * @return address currently used + */ +struct GNUNET_HELLO_Address * +GST_neighbour_get_current_address (const struct GNUNET_PeerIdentity *peer); + + +/** + * We received a disconnect message from the given peer, + * validate and process. + * + * @param peer sender of the message + * @param msg the disconnect message */ void -GST_neighbours_switch_to_address (const struct GNUNET_PeerIdentity *peer, - const char *plugin_name, - const void *address, - size_t address_len, - struct Session *session, - const struct GNUNET_TRANSPORT_ATS_Information *ats, - uint32_t ats_count); +GST_neighbours_handle_disconnect_message (const struct GNUNET_PeerIdentity + *peer, + const struct GNUNET_MessageHeader + *msg); #endif