/*
This file is part of GNUnet.
- (C) 2009-2014 Christian Grothoff (and other contributing authors)
+ Copyright (C) 2009-2014 Christian Grothoff (and other contributing authors)
GNUnet is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published
You should have received a copy of the GNU General Public License
along with GNUnet; see the file COPYING. If not, write to the
- Free Software Foundation, Inc., 59 Temple Place - Suite 330,
- Boston, MA 02111-1307, USA.
+ Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+ Boston, MA 02110-1301, USA.
*/
/**
/**
* Version number of the transport API.
*/
-#define GNUNET_TRANSPORT_VERSION 0x00000001
+#define GNUNET_TRANSPORT_VERSION 0x00000002
/**
*/
typedef void
(*GNUNET_TRANSPORT_TryConnectCallback) (void *cls,
- const int result);
+ int result);
/**
GNUNET_TRANSPORT_try_connect_cancel (struct GNUNET_TRANSPORT_TryConnectHandle *tch);
+/**
+ * Opaque handle for a transmission-ready request.
+ */
+struct GNUNET_TRANSPORT_TryDisconnectHandle;
+
+/**
+ * Function to call with result of the try connect request.
+ *
+ * @param cls closure
+ * @param result #GNUNET_OK if message was transmitted to transport service
+ * #GNUNET_SYSERR if message was not transmitted to transport service
+ */
+typedef void
+(*GNUNET_TRANSPORT_TryDisconnectCallback) (void *cls,
+ int result);
+
+
/**
* Ask the transport service to disconnect from the given peer.
*
* @return a `struct GNUNET_TRANSPORT_TryConnectHandle` handle or
* NULL on failure (@a cb will not be called)
*/
-struct GNUNET_TRANSPORT_TryConnectHandle *
+struct GNUNET_TRANSPORT_TryDisconnectHandle *
GNUNET_TRANSPORT_try_disconnect (struct GNUNET_TRANSPORT_Handle *handle,
const struct GNUNET_PeerIdentity *target,
- GNUNET_TRANSPORT_TryConnectCallback cb,
+ GNUNET_TRANSPORT_TryDisconnectCallback cb,
void *cb_cls);
* Cancel the request to transport to disconnect.
* Callback will not be called anymore.
*
- * @param tch handle for operation to cancel
+ * @param tdh handle for operation to cancel
*/
void
-GNUNET_TRANSPORT_try_disconnect_cancel (struct GNUNET_TRANSPORT_TryConnectHandle *tch);
+GNUNET_TRANSPORT_try_disconnect_cancel (struct GNUNET_TRANSPORT_TryDisconnectHandle *tdh);
/* ************************* Sending *************************** */
GNUNET_TRANSPORT_notify_transmit_ready_cancel (struct GNUNET_TRANSPORT_TransmitHandle *th);
-
/**
* Checks if a given peer is connected to us
*
*
* @param handle transport handle
* @param peer the peer to set the metric for
- * @param inbound set inbound direction (#GNUNET_YES or #GNUNET_NO)
- * @param outbound set outbound direction (#GNUNET_YES or #GNUNET_NO)
- * @param ats the metric as ATS information
- * @param ats_count the number of metrics
- *
- * Supported ATS values:
- * #GNUNET_ATS_QUALITY_NET_DELAY (value in ms)
- * #GNUNET_ATS_QUALITY_NET_DISTANCE (value in count(hops))
- *
- * Example
- * To enforce a delay of 10 ms for peer p1 in sending direction use:
- *
- * struct GNUNET_ATS_Information ats;
- * ats.type = ntohl (GNUNET_ATS_QUALITY_NET_DELAY);
- * ats.value = ntohl (10);
- * GNUNET_TRANSPORT_set_traffic_metric (th, p1, TM_SEND, &ats, 1);
+ * @param prop the performance metrics to set
+ * @param delay_in inbound delay to introduce
+ * @param delay_out outbound delay to introduce
*
- * Note:
- * Delay restrictions in receiving direction will be enforced with
- * 1 message delay.
+ * Note: Delay restrictions in receiving direction will be enforced
+ * with one message delay.
*/
void
GNUNET_TRANSPORT_set_traffic_metric (struct GNUNET_TRANSPORT_Handle *handle,
const struct GNUNET_PeerIdentity *peer,
- int inbound,
- int outbound,
- const struct GNUNET_ATS_Information *ats,
- size_t ats_count);
+ const struct GNUNET_ATS_Properties *prop,
+ struct GNUNET_TIME_Relative delay_in,
+ struct GNUNET_TIME_Relative delay_out);
/* *************************** HELLO *************************** */
*/
struct GNUNET_TRANSPORT_OfferHelloHandle;
+
/**
* Offer the transport service the HELLO of another peer. Note that
* the transport service may just ignore this message if the HELLO is
struct GNUNET_TRANSPORT_OfferHelloHandle *
GNUNET_TRANSPORT_offer_hello (struct GNUNET_TRANSPORT_Handle *handle,
const struct GNUNET_MessageHeader *hello,
- GNUNET_SCHEDULER_Task cont, void *cls);
+ GNUNET_SCHEDULER_TaskCallback cont, void *cls);
/**
/**
* Function to call with a textual representation of an address. This
* function will be called several times with different possible
- * textual representations, and a last time with @address being NULL
- * to signal the end of the iteration. Note that @address NULL
+ * textual representations, and a last time with @a address being NULL
+ * to signal the end of the iteration. Note that @a address NULL
* always is the last call, regardless of the value in @a res.
*
* @param cls closure
/**
* Possible state of a neighbour. Initially, we are #GNUNET_TRANSPORT_PS_NOT_CONNECTED.
*
- * Then, there are two main paths. If we receive a CONNECT message, we give
+ * Then, there are two main paths. If we receive a SYN message, we give
* the inbound address to ATS. After the check we ask ATS for a suggestion
* (#GNUNET_TRANSPORT_PS_CONNECT_RECV_ATS). If ATS makes a suggestion, we
- * send our CONNECT_ACK and go to #GNUNET_TRANSPORT_PS_CONNECT_RECV_ACK.
- * If we receive a SESSION_ACK, we go to #GNUNET_TRANSPORT_PS_CONNECTED
+ * send our SYN_ACK and go to #GNUNET_TRANSPORT_PS_CONNECT_RECV_ACK.
+ * If we receive a ACK, we go to #GNUNET_TRANSPORT_PS_CONNECTED
* (and notify everyone about the new connection). If the operation times out,
* we go to #GNUNET_TRANSPORT_PS_DISCONNECT.
*
- * The other case is where we transmit a CONNECT message first. We
+ * The other case is where we transmit a SYN message first. We
* start with #GNUNET_TRANSPORT_PS_INIT_ATS. If we get an address, we send
- * the CONNECT message and go to state #GNUNET_TRANSPORT_PS_CONNECT_SENT.
- * Once we receive a CONNECT_ACK, we go to #GNUNET_TRANSPORT_PS_CONNECTED
+ * the SYN message and go to state #GNUNET_TRANSPORT_PS_CONNECT_SENT.
+ * Once we receive a SYN_ACK, we go to #GNUNET_TRANSPORT_PS_CONNECTED
* (and notify everyone about the new connection and send
- * back a SESSION_ACK). If the operation times out, we go to
+ * back a ACK). If the operation times out, we go to
* #GNUNET_TRANSPORT_PS_DISCONNECT.
*
* If the session is in trouble (i.e. transport-level disconnect or
* timeout), we go to #GNUNET_TRANSPORT_PS_RECONNECT_ATS where we ask ATS for a new
* address (we don't notify anyone about the disconnect yet). Once we
* have a new address, we enter #GNUNET_TRANSPORT_PS_RECONNECT_SENT and send a
- * CONNECT message. If we receive a
- * CONNECT_ACK, we go to #GNUNET_TRANSPORT_PS_CONNECTED and nobody noticed that we had
- * trouble; we also send a SESSION_ACK at this time just in case. If
+ * SYN message. If we receive a
+ * SYN_ACK, we go to #GNUNET_TRANSPORT_PS_CONNECTED and nobody noticed that we had
+ * trouble; we also send a ACK at this time just in case. If
* the operation times out, we go to #GNUNET_TRANSPORT_PS_DISCONNECT (and notify everyone
* about the lost connection).
*
* If ATS decides to switch addresses while we have a normal
- * connection, we go to #GNUNET_TRANSPORT_PS_CONNECTED_SWITCHING_CONNECT_SENT
- * and send a SESSION_CONNECT. If we get a SESSION_ACK back, we switch the
+ * connection, we go to #GNUNET_TRANSPORT_PS_CONNECTED_SWITCHING_SYN_SENT
+ * and send a SESSION_CONNECT. If we get a ACK back, we switch the
* primary connection to the suggested alternative from ATS, go back
- * to #GNUNET_TRANSPORT_PS_CONNECTED and send a SESSION_ACK to the other peer just to be
+ * to #GNUNET_TRANSPORT_PS_CONNECTED and send a ACK to the other peer just to be
* sure. If the operation times out
* we go to #GNUNET_TRANSPORT_PS_CONNECTED (and notify ATS that the given alternative
* address is "invalid").
* generating disconnect notifications.
*
* Note that it is quite possible that while we are in any of these
- * states, we could receive a 'CONNECT' request from the other peer.
+ * states, we could receive a 'SYN' request from the other peer.
* We then enter a 'weird' state where we pursue our own primary state
* machine (as described above), but with the 'send_connect_ack' flag
- * set to 1. If our state machine allows us to send a 'CONNECT_ACK'
- * (because we have an acceptable address), we send the 'CONNECT_ACK'
+ * set to 1. If our state machine allows us to send a 'SYN_ACK'
+ * (because we have an acceptable address), we send the 'SYN_ACK'
* and set the 'send_connect_ack' to 2. If we then receive a
- * 'SESSION_ACK', we go to #GNUNET_TRANSPORT_PS_CONNECTED (and reset 'send_connect_ack'
+ * 'ACK', we go to #GNUNET_TRANSPORT_PS_CONNECTED (and reset 'send_connect_ack'
* to 0).
*
*/
GNUNET_TRANSPORT_PS_INIT_ATS,
/**
- * Sent CONNECT message to other peer, waiting for CONNECT_ACK
+ * Sent SYN message to other peer, waiting for SYN_ACK
*/
- GNUNET_TRANSPORT_PS_CONNECT_SENT,
+ GNUNET_TRANSPORT_PS_SYN_SENT,
/**
- * Received a CONNECT, asking ATS about address suggestions.
+ * Received a SYN, asking ATS about address suggestions.
*/
- GNUNET_TRANSPORT_PS_CONNECT_RECV_ATS,
+ GNUNET_TRANSPORT_PS_SYN_RECV_ATS,
/**
- * CONNECT request from other peer was CONNECT_ACK'ed, waiting for
- * SESSION_ACK.
+ * SYN request from other peer was SYN_ACK'ed, waiting for ACK.
*/
- GNUNET_TRANSPORT_PS_CONNECT_RECV_ACK,
+ GNUNET_TRANSPORT_PS_SYN_RECV_ACK,
/**
- * Got our CONNECT_ACK/SESSION_ACK, connection is up.
+ * Got our SYN_ACK/ACK, connection is up.
*/
GNUNET_TRANSPORT_PS_CONNECTED,
GNUNET_TRANSPORT_PS_RECONNECT_ATS,
/**
- * Sent CONNECT over new address (either by ATS telling us to switch
+ * Sent SYN over new address (either by ATS telling us to switch
* addresses or from RECONNECT_ATS); if this fails, we need to tell
* the rest of the system about a disconnect.
*/
/**
* We have some primary connection, but ATS suggested we switch
- * to some alternative; we now sent a CONNECT message for the
+ * to some alternative; we now sent a SYN message for the
* alternative session to the other peer and waiting for a
- * CONNECT_ACK to make this our primary connection.
+ * SYN_ACK to make this our primary connection.
*/
- GNUNET_TRANSPORT_PS_CONNECTED_SWITCHING_CONNECT_SENT,
+ GNUNET_TRANSPORT_PS_SWITCH_SYN_SENT,
/**
* Disconnect in progress (we're sending the DISCONNECT message to the
* a final call with NULL for peer and address will follow when done.
* In this case state and timeout do not contain valid values.
*
- * The #GNUNET_TRANSPORT_monitor_peers_cancel call MUST not be called from
+ * The #GNUNET_TRANSPORT_monitor_peers_cancel() call MUST not be called from
* within this function!
*
*
* @param cls closure
* @param peer peer this update is about,
* NULL if this is the final last callback for a iteration operation
- * @param address address, NULL for disconnect notification in monitor mode
+ * @param address address, NULL if this is the final callback for iteration op
* @param state current state this peer is in
* @param state_timeout timeout for the current state of the peer
*/
* to communicate with this peer, the state this peer is currently in and the
* the current timeout for this state.
*
- * Upon completion, the 'GNUNET_TRANSPORT_PeerIterateCallback' is called one
- * more time with 'NULL'. After this, the operation must no longer be
+ * Upon completion, the #GNUNET_TRANSPORT_PeerIterateCallback is called one
+ * more time with `NULL`. After this, the operation must no longer be
* explicitly canceled.
*
* The #GNUNET_TRANSPORT_monitor_peers_cancel call MUST not be called in the
* indicate a change to a validation entry. The information included represent
* the current state of the validation entry,
*
- * If the monitoring was called with one_shot=GNUNET_YES, a final callback
- * with peer==NULL and address==NULL is executed.
+ * If the monitoring was called with `one_shot==GNUNET_YES`, a final callback
+ * with `address==NULL` is executed.
*
* @param cls closure
- * @param peer peer this update is about,
+ * @param address address this update is about,
* NULL if this is the final last callback for a iteration operation
- * @param address address,
- * NULL for disconnect notification in monitor mode
* @param last_validation when was this address last validated
* @param valid_until when does this address expire
* @param next_validation time of the next validation operation
*/
typedef void
(*GNUNET_TRANSPORT_ValidationIterateCallback) (void *cls,
- const struct GNUNET_PeerIdentity *peer,
const struct GNUNET_HELLO_Address *address,
struct GNUNET_TIME_Absolute last_validation,
struct GNUNET_TIME_Absolute valid_until,
GNUNET_TRANSPORT_blacklist_cancel (struct GNUNET_TRANSPORT_Blacklist *br);
+/**
+ * Handle for a plugin session state monitor.
+ */
+struct GNUNET_TRANSPORT_PluginMonitor;
+
+/**
+ * Abstract representation of a plugin's session.
+ * Corresponds to the `struct Session` within the TRANSPORT service.
+ */
+struct GNUNET_TRANSPORT_PluginSession;
+
+
+/**
+ * Possible states of a session in a plugin.
+ */
+enum GNUNET_TRANSPORT_SessionState
+{
+
+ /**
+ * The session was created (first call for each session object).
+ */
+ GNUNET_TRANSPORT_SS_INIT,
+
+ /**
+ * Initial session handshake is in progress.
+ */
+ GNUNET_TRANSPORT_SS_HANDSHAKE,
+
+ /**
+ * Session is fully UP.
+ */
+ GNUNET_TRANSPORT_SS_UP,
+
+ /**
+ * This is just an update about the session,
+ * the state did not change.
+ */
+ GNUNET_TRANSPORT_SS_UPDATE,
+
+ /**
+ * Session is being torn down and about to disappear.
+ * Last call for each session object.
+ */
+ GNUNET_TRANSPORT_SS_DONE
+
+};
+
+
+/**
+ * Information about a plugin's session.
+ */
+struct GNUNET_TRANSPORT_SessionInfo
+{
+
+ /**
+ * New state of the session.
+ */
+ enum GNUNET_TRANSPORT_SessionState state;
+
+ /**
+ * #GNUNET_YES if this is an inbound connection,
+ * #GNUNET_NO if this is an outbound connection,
+ * #GNUNET_SYSERR if connections of this plugin
+ * are so fundamentally bidirectional
+ * that they have no 'initiator'
+ */
+ int is_inbound;
+
+ /**
+ * Number of messages pending transmission for this session.
+ */
+ uint32_t num_msg_pending;
+
+ /**
+ * Number of bytes pending transmission for this session.
+ */
+ uint32_t num_bytes_pending;
+
+ /**
+ * Until when does this plugin refuse to receive to manage
+ * staying within the inbound quota? ZERO if receive is
+ * active.
+ */
+ struct GNUNET_TIME_Absolute receive_delay;
+
+ /**
+ * At what time will this session timeout (unless activity
+ * happens)?
+ */
+ struct GNUNET_TIME_Absolute session_timeout;
+
+ /**
+ * Address used by the session. Can be NULL if none is available.
+ */
+ const struct GNUNET_HELLO_Address *address;
+};
+
+
+/**
+ * Function called by the plugin with information about the
+ * current sessions managed by the plugin (for monitoring).
+ *
+ * @param cls closure
+ * @param session session handle this information is about,
+ * NULL to indicate that we are "in sync" (initial
+ * iteration complete)
+ * @param session_ctx storage location where the application
+ * can store data; will point to NULL on #GNUNET_TRANSPORT_SS_INIT,
+ * and must be reset to NULL on #GNUNET_TRANSPORT_SS_DONE
+ * @param info information about the state of the session,
+ * NULL if @a session is also NULL and we are
+ * merely signalling that the initial iteration is over;
+ * NULL with @a session being non-NULL if the monitor
+ * was being cancelled while sessions were active
+ */
+typedef void
+(*GNUNET_TRANSPORT_SessionMonitorCallback) (void *cls,
+ struct GNUNET_TRANSPORT_PluginSession *session,
+ void **session_ctx,
+ const struct GNUNET_TRANSPORT_SessionInfo *info);
+
+
+/**
+ * Install a plugin session state monitor callback. The callback
+ * will be notified whenever the session changes.
+ *
+ * @param cfg configuration to use
+ * @param cb callback to invoke on events
+ * @param cb_cls closure for @a cb
+ * @return NULL on error, otherwise handle for cancellation
+ */
+struct GNUNET_TRANSPORT_PluginMonitor *
+GNUNET_TRANSPORT_monitor_plugins (const struct GNUNET_CONFIGURATION_Handle *cfg,
+ GNUNET_TRANSPORT_SessionMonitorCallback cb,
+ void *cb_cls);
+
+
+/**
+ * Cancel monitoring the plugin session state. The callback will be
+ * called once for each session that is up with the "info" argument
+ * being NULL (this is just to enable client-side cleanup).
+ *
+ * @param pm handle of the request that is to be cancelled
+ */
+void
+GNUNET_TRANSPORT_monitor_plugins_cancel (struct GNUNET_TRANSPORT_PluginMonitor *pm);
+
+
#if 0 /* keep Emacsens' auto-indent happy */
{
/* ifndef GNUNET_TRANSPORT_SERVICE_H */
#endif
/* end of gnunet_transport_service.h */
-
-
projects / oweals / gnunet.git / blobdiff