/**
* @file transport/gnunet-service-transport_neighbours.h
- * @brief plugin management API
+ * @brief neighbour management API
* @author Christian Grothoff
*/
#ifndef GNUNET_SERVICE_TRANSPORT_NEIGHBOURS_H
#include "gnunet_statistics_service.h"
#include "gnunet_transport_service.h"
+#include "gnunet_transport_plugin.h"
#include "gnunet_util_lib.h"
+// TODO:
+// - ATS and similar info is a bit lacking in the API right now...
+
+
/**
+ * Initialize the neighbours subsystem.
*
+ * @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
*/
void
GST_neighbours_start (void *cls,
GNUNET_TRANSPORT_NotifyConnect connect_cb,
GNUNET_TRANSPORT_NotifyDisconnect disconnect_cb);
+
/**
- *
+ * Cleanup the neighbours subsystem.
*/
void
GST_neighbours_stop (void);
+
/**
+ * Try to create a connection to the given target (eventually).
*
+ * @param target peer to try to connect to
*/
void
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
*/
int
GST_neighbours_test_connected (const struct GNUNET_PeerIdentity *target);
+
/**
+ * Function called after the transmission is done.
*
+ * @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);
+
+
+/**
+ * Transmit a message to the given target using the active connection.
+ *
+ * @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 void *msg,
+ size_t msg_size,
+ struct GNUNET_TIME_Relative timeout,
+ GST_NeighbourSendContinuation cont,
+ void *cont_cls);
+
+/**
+ * Change the incoming quota for the given peer.
+ *
+ * @param neighbour identity of peer to change qutoa for
+ * @param quota new quota
+ */
+void
+GST_neighbours_set_incoming_quota (const struct GNUNET_PeerIdentity *neighbour,
+ struct GNUNET_BANDWIDTH_Value32NBO quota);
+
+
+/**
+ * If we have an active connection to the given target, it must be shutdown.
+ *
+ * @param target peer to disconnect from
*/
void
GST_neighbours_force_disconnect (const struct GNUNET_PeerIdentity *target);
+/**
+ * Function called for each connected neighbour.
+ *
+ * @param cls closure
+ * @param neighbour identity of the neighbour
+ * @param ats performance data
+ * @param ats_count number of entries in ats (excluding 0-termination)
+ */
typedef void (*GST_NeighbourIterator)(void *cls,
- const struct GNUNET_PeerIdentity *neighbour);
+ const struct GNUNET_PeerIdentity *neighbour,
+ const struct GNUNET_TRANSPORT_ATS_Information *ats,
+ uint32_t ats_count);
+/**
+ * Iterate over all connected neighbours.
+ *
+ * @param cb function to call
+ * @param cb_cls closure for cb
+ */
void
GST_neighbours_iterate (GST_NeighbourIterator cb,
void *cb_cls);
/**
+ * We have received a CONNECT. Set the peer to connected.
*
- */
-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);
-
-/**
- *
+ * @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
+ * @param ats performance data
+ * @param ats_count number of entries in ats (excluding 0-termination)
+ * @return GNUNET_OK if the message was well-formed, GNUNET_SYSERR if not
*/
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);
+ size_t sender_address_len,
+ struct Session *session,
+ const struct GNUNET_TRANSPORT_ATS_Information *ats,
+ uint32_t ats_count);
+
/**
+ * For an existing neighbour record, set the active connection to
+ * the given address.
*
+ * @param plugin_name name of transport that delivered the PONG
+ * @param address address of the other peer, NULL if other peer
+ * connected to us
+ * @param address_len number of bytes in address
+ * @param ats performance data
+ * @param ats_count number of entries in ats (excluding 0-termination)
+ */
+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);
+
+
+/**
+ * We have received a DISCONNECT. Set the peer to disconnected.
+ *
+ * @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
*/
int
GST_neighbours_handle_disconnect (const struct GNUNET_PeerIdentity *sender,
size_t sender_address_len);
-
-
#endif
/* end of file gnunet-service-transport_neighbours.h */
projects / oweals / gnunet.git / blobdiff