/**
- * Possible state of a neighbour. Initially, we are #S_NOT_CONNECTED.
+ * 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
- * first run a check against the blacklist (#S_CONNECT_RECV_BLACKLIST_INBOUND).
+ * first run a check against the blacklist (#GNUNET_TRANSPORT_PS_CONNECT_RECV_BLACKLIST_INBOUND).
* If this check is successful, we give the inbound address to ATS.
- * After the check we ask ATS for a suggestion (S_CONNECT_RECV_ATS).
+ * After the check we ask ATS for a suggestion (#GNUNET_TRANSPORT_PS_CONNECT_RECV_ATS).
* If ATS makes a suggestion, we ALSO give that suggestion to the blacklist
- * (#S_CONNECT_RECV_BLACKLIST). Once the blacklist approves the
+ * (#GNUNET_TRANSPORT_PS_CONNECT_RECV_BLACKLIST). Once the blacklist approves the
* address we got from ATS, we send our CONNECT_ACK and go to
- * #S_CONNECT_RECV_ACK. If we receive a SESSION_ACK, we go to
- * #S_CONNECTED (and notify everyone about the new connection). If the
- * operation times out, we go to #S_DISCONNECT.
+ * #GNUNET_TRANSPORT_PS_CONNECT_RECV_ACK. If we receive a SESSION_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
- * start with #S_INIT_ATS. If we get an address, we enter
- * #S_INIT_BLACKLIST and check the blacklist. If the blacklist is OK
+ * start with #GNUNET_TRANSPORT_PS_INIT_ATS. If we get an address, we enter
+ * #GNUNET_TRANSPORT_PS_INIT_BLACKLIST and check the blacklist. If the blacklist is OK
* with the connection, we actually send the CONNECT message and go to
- * state S_CONNECT_SENT. Once we receive a CONNECT_ACK, we go to
- * #S_CONNECTED (and notify everyone about the new connection and send
+ * state #GNUNET_TRANSPORT_PS_CONNECT_SENT. Once we receive a CONNECT_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
- * #S_DISCONNECT.
+ * #GNUNET_TRANSPORT_PS_DISCONNECT.
*
* If the session is in trouble (i.e. transport-level disconnect or
- * timeout), we go to #S_RECONNECT_ATS where we ask ATS for a new
+ * 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 go to #S_RECONNECT_BLACKLIST to check the new
+ * have a new address, we go to #GNUNET_TRANSPORT_PS_RECONNECT_BLACKLIST to check the new
* address against the blacklist. If the blacklist approves, we enter
- * #S_RECONNECT_SENT and send a CONNECT message. If we receive a
- * CONNECT_ACK, we go to #S_CONNECTED and nobody noticed that we had
+ * #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
- * the operation times out, we go to S_DISCONNECT (and notify everyone
+ * 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 #S_CONNECTED_SWITCHING_BLACKLIST to check the
+ * connection, we go to #GNUNET_TRANSPORT_PS_CONNECTED_SWITCHING_BLACKLIST to check the
* new address against the blacklist. If the blacklist approves, we
- * go to #S_CONNECTED_SWITCHING_CONNECT_SENT and send a
+ * go to #GNUNET_TRANSPORT_PS_CONNECTED_SWITCHING_CONNECT_SENT and send a
* SESSION_CONNECT. If we get a SESSION_ACK back, we switch the
* primary connection to the suggested alternative from ATS, go back
- * to #S_CONNECTED and send a SESSION_ACK to the other peer just to be
+ * to #GNUNET_TRANSPORT_PS_CONNECTED and send a SESSION_ACK to the other peer just to be
* sure. If the operation times out (or the blacklist disapproves),
- * we go to #S_CONNECTED (and notify ATS that the given alternative
+ * we go to #GNUNET_TRANSPORT_PS_CONNECTED (and notify ATS that the given alternative
* address is "invalid").
*
- * Once a session is in #S_DISCONNECT, it is cleaned up and then goes
- * to (#S_DISCONNECT_FINISHED). If we receive an explicit disconnect
- * request, we can go from any state to #S_DISCONNECT, possibly after
+ * Once a session is in #GNUNET_TRANSPORT_PS_DISCONNECT, it is cleaned up and then goes
+ * to (#GNUNET_TRANSPORT_PS_DISCONNECT_FINISHED). If we receive an explicit disconnect
+ * request, we can go from any state to #GNUNET_TRANSPORT_PS_DISCONNECT, possibly after
* generating disconnect notifications.
*
* Note that it is quite possible that while we are in any of these
* 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'
* and set the 'send_connect_ack' to 2. If we then receive a
- * 'SESSION_ACK', we go to #S_CONNECTED (and reset 'send_connect_ack'
+ * 'SESSION_ACK', we go to #GNUNET_TRANSPORT_PS_CONNECTED (and reset 'send_connect_ack'
* to 0).
*
*/
enum GNUNET_TRANSPORT_PeerState
{
/**
- * fresh peer or completely disconnected
+ * Fresh peer or completely disconnected
*/
- S_NOT_CONNECTED = 0,
+ GNUNET_TRANSPORT_PS_NOT_CONNECTED = 0,
/**
* Asked to initiate connection, trying to get address from ATS
*/
- S_INIT_ATS,
+ GNUNET_TRANSPORT_PS_INIT_ATS,
/**
* Asked to initiate connection, trying to get address approved
* by blacklist.
*/
- S_INIT_BLACKLIST,
+ GNUNET_TRANSPORT_PS_INIT_BLACKLIST,
/**
* Sent CONNECT message to other peer, waiting for CONNECT_ACK
*/
- S_CONNECT_SENT,
+ GNUNET_TRANSPORT_PS_CONNECT_SENT,
/**
* Received a CONNECT, do a blacklist check for inbound address
*/
- S_CONNECT_RECV_BLACKLIST_INBOUND,
+ GNUNET_TRANSPORT_PS_CONNECT_RECV_BLACKLIST_INBOUND,
/**
* Received a CONNECT, asking ATS about address suggestions.
*/
- S_CONNECT_RECV_ATS,
+ GNUNET_TRANSPORT_PS_CONNECT_RECV_ATS,
/**
* Received CONNECT from other peer, got an address, checking with blacklist.
*/
- S_CONNECT_RECV_BLACKLIST,
+ GNUNET_TRANSPORT_PS_CONNECT_RECV_BLACKLIST,
/**
* CONNECT request from other peer was SESSION_ACK'ed, waiting for
* SESSION_ACK.
*/
- S_CONNECT_RECV_ACK,
+ GNUNET_TRANSPORT_PS_CONNECT_RECV_ACK,
/**
* Got our CONNECT_ACK/SESSION_ACK, connection is up.
*/
- S_CONNECTED,
+ GNUNET_TRANSPORT_PS_CONNECTED,
/**
* Connection got into trouble, rest of the system still believes
* it to be up, but we're getting a new address from ATS.
*/
- S_RECONNECT_ATS,
+ GNUNET_TRANSPORT_PS_RECONNECT_ATS,
/**
* Connection got into trouble, rest of the system still believes
* it to be up; we are checking the new address against the blacklist.
*/
- S_RECONNECT_BLACKLIST,
+ GNUNET_TRANSPORT_PS_RECONNECT_BLACKLIST,
/**
* Sent CONNECT 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.
*/
- S_RECONNECT_SENT,
+ GNUNET_TRANSPORT_PS_RECONNECT_SENT,
/**
* We have some primary connection, but ATS suggested we switch
* to some alternative; we're now checking the alternative against
* the blacklist.
*/
- S_CONNECTED_SWITCHING_BLACKLIST,
+ GNUNET_TRANSPORT_PS_CONNECTED_SWITCHING_BLACKLIST,
/**
* We have some primary connection, but ATS suggested we switch
* alternative session to the other peer and waiting for a
* CONNECT_ACK to make this our primary connection.
*/
- S_CONNECTED_SWITCHING_CONNECT_SENT,
+ GNUNET_TRANSPORT_PS_CONNECTED_SWITCHING_CONNECT_SENT,
/**
* Disconnect in progress (we're sending the DISCONNECT message to the
* other peer; after that is finished, the state will be cleaned up).
*/
- S_DISCONNECT,
+ GNUNET_TRANSPORT_PS_DISCONNECT,
/**
* We're finished with the disconnect; and are cleaning up the state
* in this state virtually always means using memory that has been
* freed (the exception being the cleanup code in #free_neighbour()).
*/
- S_DISCONNECT_FINISHED
+ GNUNET_TRANSPORT_PS_DISCONNECT_FINISHED
};
+/**
+ * Current state of a validation process
+ */
+enum GNUNET_TRANSPORT_ValidationState
+{
+ /**
+ * Undefined state
+ *
+ * Used for final callback indicating operation done
+ */
+ GNUNET_TRANSPORT_VS_NONE,
+
+ /**
+ * Fresh validation entry
+ *
+ * Entry was just created, no validation process was executed
+ */
+ GNUNET_TRANSPORT_VS_NEW,
+
+ /**
+ * Updated validation entry
+ *
+ * This is an update for an existing validation entry
+ */
+ GNUNET_TRANSPORT_VS_UPDATE,
+ /**
+ * Timeout for validation entry
+ *
+ * A timeout occured during the validation process
+ */
+ GNUNET_TRANSPORT_VS_TIMEOUT,
+
+ /**
+ * Validation entry is removed
+ *
+ * The validation entry is getting removed due to a failed validation
+ */
+ GNUNET_TRANSPORT_VS_REMOVE,
+};
/**
* Function called by the transport for each received message.
/**
* Function to call with information about a peer
*
+ * If one_shot was set to GNUNET_YES to iterate over all peers once,
+ * 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
+ * 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
/**
* Function to call with validation information about a peer
*
+ * This function is called by the transport validation monitoring api to
+ * 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.
+ *
* @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 for disconnect notification in monitor mode
* @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 valid_until,
- struct GNUNET_TIME_Absolute next_validation);
+ const struct GNUNET_PeerIdentity *peer,
+ const struct GNUNET_HELLO_Address *address,
+ struct GNUNET_TIME_Absolute last_validation,
+ struct GNUNET_TIME_Absolute valid_until,
+ struct GNUNET_TIME_Absolute next_validation,
+ enum GNUNET_TRANSPORT_ValidationState state);
* @param state the state
*/
const char *
-GNUNET_TRANSPORT_p2s (enum GNUNET_TRANSPORT_PeerState state);
+GNUNET_TRANSPORT_ps2s (enum GNUNET_TRANSPORT_PeerState state);
/**
int
GNUNET_TRANSPORT_is_connected (enum GNUNET_TRANSPORT_PeerState state);
+
+/**
+ * Convert validation state to human-readable string.
+ *
+ * @param state the state value
+ * @return corresponding string
+ */
+const char *
+GNUNET_TRANSPORT_vs2s (enum GNUNET_TRANSPORT_ValidationState state);
+
+
/**
* Return information about a specific peer or all peers currently known to
* transport service once or in monitoring mode. To obtain information about
* 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
+ * the peer_callback!
+ *
* @param cfg configuration to use
* @param peer a specific peer identity to obtain information for,
* NULL for all peers
/* ifndef GNUNET_TRANSPORT_SERVICE_H */
#endif
/* end of gnunet_transport_service.h */
+
+
projects / oweals / gnunet.git / blobdiff