#include "gnunet_statistics_service.h"
#include "gnunet_transport_service.h"
+#include "gnunet_transport_plugin.h"
+#include "transport.h"
#include "gnunet_util_lib.h"
// TODO:
* @param cls closure for callbacks
* @param connect_cb function to call if we connect to a peer
* @param disconnect_cb function to call if we disconnect from a peer
+ * @param peer_address_cb function to call if a neighbour's active address changes
*/
-void
+void
GST_neighbours_start (void *cls,
- GNUNET_TRANSPORT_NotifyConnect connect_cb,
- GNUNET_TRANSPORT_NotifyDisconnect disconnect_cb);
+ NotifyConnect connect_cb,
+ GNUNET_TRANSPORT_NotifyDisconnect disconnect_cb,
+ GNUNET_TRANSPORT_PeerIterateCallback peer_address_cb);
/**
/**
* 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
*/
* Function called after the transmission is done.
*
* @param cls closure
- * @param success GNUNET_OK on success, GNUNET_NO on failure
+ * @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,
+ size_t bytes_payload,
+ size_t bytes_on_wire);
/**
*
* @param target destination
* @param msg message to send
+ * @param msg_size number of bytes in msg
+ * @param timeout when to fail with timeout
* @param cont function to call when done
* @param cont_cls closure for 'cont'
*/
void
-GST_neighbours_send (const struct GNUNET_PeerIdentity *target,
- const struct GNUNET_MessageHeader *msg,
- 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);
+
+
+/**
+ * We have received a message from the given sender.
+ * How long should we delay before receiving more?
+ * (Also used to keep the peer marked as live).
+ *
+ * @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, 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);
+
/**
- * Change the quota for the given peer.
- * FIXME: inbound or outbound quota?
+ * 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 FIXME: fix type!
+ * @param quota new quota
*/
void
-GST_neighbours_set_quota (const struct GNUNET_PeerIdentity *neighbour,
- const float quota);
+GST_neighbours_set_incoming_quota (const struct GNUNET_PeerIdentity *neighbour,
+ struct GNUNET_BANDWIDTH_Value32NBO quota);
/**
*
* @param cls closure
* @param neighbour identity of the neighbour
+ * @param ats performance data
+ * @param ats_count number of entries in ats (including 0-termination)
+ * @param address the address (or NULL)
+ * @param bandwidth_in inbound quota in NBO
+ * @param bandwidth_out outbound quota in NBO
*/
-typedef void (*GST_NeighbourIterator)(void *cls,
- const struct GNUNET_PeerIdentity *neighbour);
+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,
+ struct GNUNET_BANDWIDTH_Value32NBO bandwidth_in,
+ struct GNUNET_BANDWIDTH_Value32NBO bandwidth_out);
/**
* 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);
/**
- * We have received a PONG. Update lifeness of the neighbour.
+ * A session was terminated. Take note.
*
- * @param sender peer sending the PONG
- * @param hdr the PONG message (presumably)
- * @param plugin_name name of transport that delivered the PONG
- * @param sender_address address of the other peer, NULL if other peer
- * connected to us
- * @param sender_address_len number of bytes in sender_address
- * @return GNUNET_OK if the message was well-formed, GNUNET_SYSERR if not
+ * @param peer identity of the peer where the session died
+ * @param session session that is gone
+ * @return GNUNET_YES if this was a session used, GNUNET_NO if
+ * this session was not in use
*/
int
-GST_neighbours_handle_pong (const struct GNUNET_PeerIdentity *sender,
- const struct GNUNET_MessageHeader *hdr,
- const char *plugin_name,
- const void *sender_address,
- size_t sender_address_len);
+GST_neighbours_session_terminated (const struct GNUNET_PeerIdentity *peer,
+ struct Session *session);
/**
- * We have received a CONNECT. Set the peer to connected.
+ * For an existing neighbour record, set the active connection to
+ * use the given address.
*
- * @param sender peer sending the PONG
- * @param hdr the PONG message (presumably)
- * @param plugin_name name of transport that delivered the PONG
- * @param sender_address address of the other peer, NULL if other peer
+ * @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 sender_address_len number of bytes in sender_address
- * @return GNUNET_OK if the message was well-formed, GNUNET_SYSERR if not
+ * @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
*/
-int
-GST_neighbours_handle_connect (const struct GNUNET_PeerIdentity *sender,
- const struct GNUNET_MessageHeader *hdr,
- const char *plugin_name,
- const void *sender_address,
- size_t sender_address_len);
+void
+GST_neighbours_switch_to_address (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 have received a DISCONNECT. Set the peer to disconnected.
+ * We received a 'SESSION_CONNECT_ACK' message from the other peer.
+ * Consider switching to it.
*
- * @param sender peer sending the PONG
- * @param hdr the PONG message (presumably)
- * @param plugin_name name of transport that delivered the PONG
- * @param sender_address address of the other peer, NULL if other peer
+ * @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 sender_address_len number of bytes in sender_address
- * @return GNUNET_OK if the message was well-formed, GNUNET_SYSERR if not
+ * @param session session to use (or NULL)
+ * @param ats performance data
+ * @param ats_count number of entries in ats
*/
-int
-GST_neighbours_handle_disconnect (const struct GNUNET_PeerIdentity *sender,
- const struct GNUNET_MessageHeader *hdr,
- const char *plugin_name,
- const void *sender_address,
- size_t sender_address_len);
+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);
+
+
+/**
+ * We received a 'SESSION_ACK' message from the other peer.
+ * FIXME: describe what this means!
+ *
+ * @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_session_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_handle_disconnect_message (const struct GNUNET_PeerIdentity
+ *peer,
+ const struct GNUNET_MessageHeader
+ *msg);
#endif
projects / oweals / gnunet.git / blobdiff