/*
This file is part of GNUnet.
- (C) 2009, 2010, 2011 Christian Grothoff (and other contributing authors)
+ (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
/**
* Version number of the transport API.
*/
-#define GNUNET_TRANSPORT_VERSION 0x00000000
+#define GNUNET_TRANSPORT_VERSION 0x00000001
+
+
+/**
+ * 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
+ * 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
+ * (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 #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
+ * (and notify everyone about the new connection and send
+ * back a SESSION_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
+ * 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
+ * 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
+ * sure. If the operation times out
+ * we go to #GNUNET_TRANSPORT_PS_CONNECTED (and notify ATS that the given alternative
+ * address is "invalid").
+ *
+ * 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
+ * states, we could receive a 'CONNECT' 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'
+ * 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'
+ * to 0).
+ *
+ */
+enum GNUNET_TRANSPORT_PeerState
+{
+ /**
+ * Fresh peer or completely disconnected
+ */
+ GNUNET_TRANSPORT_PS_NOT_CONNECTED = 0,
+
+ /**
+ * Asked to initiate connection, trying to get address from ATS
+ */
+ GNUNET_TRANSPORT_PS_INIT_ATS,
+
+ /**
+ * Sent CONNECT message to other peer, waiting for CONNECT_ACK
+ */
+ GNUNET_TRANSPORT_PS_CONNECT_SENT,
+
+ /**
+ * Received a CONNECT, asking ATS about address suggestions.
+ */
+ GNUNET_TRANSPORT_PS_CONNECT_RECV_ATS,
+
+ /**
+ * CONNECT request from other peer was CONNECT_ACK'ed, waiting for
+ * SESSION_ACK.
+ */
+ GNUNET_TRANSPORT_PS_CONNECT_RECV_ACK,
+
+ /**
+ * Got our CONNECT_ACK/SESSION_ACK, connection is up.
+ */
+ 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.
+ */
+ GNUNET_TRANSPORT_PS_RECONNECT_ATS,
+
+ /**
+ * 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.
+ */
+ GNUNET_TRANSPORT_PS_RECONNECT_SENT,
+
+ /**
+ * We have some primary connection, but ATS suggested we switch
+ * to some alternative; we now sent a CONNECT message for the
+ * alternative session to the other peer and waiting for a
+ * CONNECT_ACK to make this our primary connection.
+ */
+ 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).
+ */
+ GNUNET_TRANSPORT_PS_DISCONNECT,
+
+ /**
+ * We're finished with the disconnect; and are cleaning up the state
+ * now! We put the struct into this state when we are really in the
+ * task that calls 'free' on it and are about to remove the record
+ * from the map. We should never find a 'struct NeighbourMapEntry'
+ * in this state in the map. Accessing a 'struct NeighbourMapEntry'
+ * in this state virtually always means using memory that has been
+ * freed (the exception being the cleanup code in #free_neighbour()).
+ */
+ GNUNET_TRANSPORT_PS_DISCONNECT_FINISHED
+};
-enum TRAFFIC_METRIC_DIRECTION
+
+/**
+ * Current state of a validation process.
+ *
+ * FIXME: what state is used to indicate that a validation
+ * was successful? If that is clarified/determined, "UGH" in
+ * ~gnunet-peerinfo-gtk.c:1103 should be resolved.
+ */
+enum GNUNET_TRANSPORT_ValidationState
{
- TM_SEND = 0,
- TM_RECEIVE = 1,
- TM_BOTH = 2
+ /**
+ * 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
};
* @param peer (claimed) identity of the other peer
* @param message the message
* @param ats performance data
- * @param ats_count number of entries in ats
+ * @param ats_count number of entries in @a ats
*/
-typedef void (*GNUNET_TRANSPORT_ReceiveCallback) (void *cls,
- const struct
- GNUNET_PeerIdentity * peer,
- const struct
- GNUNET_MessageHeader *
- message,
- const struct
- GNUNET_ATS_Information * ats,
- uint32_t ats_count);
+typedef void
+(*GNUNET_TRANSPORT_ReceiveCallback) (void *cls,
+ const struct GNUNET_PeerIdentity *peer,
+ const struct GNUNET_MessageHeader *message);
/**
* @param cls closure
* @param peer the peer that connected
* @param ats performance data
- * @param ats_count number of entries in ats (excluding 0-termination)
+ * @param ats_count number of entries in @a ats (excluding 0-termination)
*/
-typedef void (*GNUNET_TRANSPORT_NotifyConnect) (void *cls,
- const struct GNUNET_PeerIdentity
- * peer,
- const struct
- GNUNET_ATS_Information * ats,
- uint32_t ats_count);
+typedef void
+(*GNUNET_TRANSPORT_NotifyConnect) (void *cls,
+ const struct GNUNET_PeerIdentity *peer);
/**
* Function called to notify transport users that another
* @param cls closure
* @param peer the peer that disconnected
*/
-typedef void (*GNUNET_TRANSPORT_NotifyDisconnect) (void *cls,
- const struct
- GNUNET_PeerIdentity * peer);
+typedef void
+(*GNUNET_TRANSPORT_NotifyDisconnect) (void *cls,
+ const struct GNUNET_PeerIdentity *peer);
/**
*
*
* @param cls closure
- * @param result GNUNET_OK if message was transmitted to transport service
- * GNUNET_SYSERR if message was not transmitted to transport service
+ * @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_TryConnectCallback) (void *cls,
- const int result);
+typedef void
+(*GNUNET_TRANSPORT_TryConnectCallback) (void *cls,
+ const int result);
/**
- * 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 NULL to signal the end
- * of the iteration.
+ * 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
+ * always is the last call, regardless of the value in @a res.
*
* @param cls closure
- * @param address NULL on error or end of iteration,
- * otherwise 0-terminated printable UTF-8 string
+ * @param address NULL on end of iteration,
+ * otherwise 0-terminated printable UTF-8 string,
+ * in particular an empty string if @a res is #GNUNET_NO
+ * @param res result of the address to string conversion:
+ * if #GNUNET_OK: conversion successful
+ * if #GNUNET_NO: address was invalid (or not supported)
+ * if #GNUNET_SYSERR: communication error (IPC error)
*/
-typedef void (*GNUNET_TRANSPORT_AddressToStringCallback) (void *cls,
- const char *address);
+typedef void
+(*GNUNET_TRANSPORT_AddressToStringCallback) (void *cls,
+ const char *address,
+ int res);
/**
- * Function to call with a binary format of an address
+ * 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 (never NULL)
+ * @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 state current state this peer is in
+ * @param state_timeout timeout for the current state of the peer
*/
-typedef void (*GNUNET_TRANSPORT_PeerIterateCallback) (void *cls,
- const struct
- GNUNET_PeerIdentity *
- peer,
- const struct
- GNUNET_HELLO_Address *
- address);
+typedef void
+(*GNUNET_TRANSPORT_PeerIterateCallback) (void *cls,
+ const struct GNUNET_PeerIdentity *peer,
+ const struct GNUNET_HELLO_Address *address,
+ enum GNUNET_TRANSPORT_PeerState state,
+ struct GNUNET_TIME_Absolute state_timeout);
+
+
+/**
+ * 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 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
+ * @param state state in the validation state machine
+ */
+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,
+ struct GNUNET_TIME_Absolute next_validation,
+ enum GNUNET_TRANSPORT_ValidationState state);
/**
* @param self our own identity (API should check that it matches
* the identity found by transport), or NULL (no check)
* @param cls closure for the callbacks
- * @param rec receive function to call
- * @param nc function to call on connect events
- * @param nd function to call on disconnect events
+ * @param rec receive function to call, or NULL
+ * @param nc function to call on connect events, or NULL
+ * @param nd function to call on disconnect events, or NULL
* @return NULL on error
*/
struct GNUNET_TRANSPORT_Handle *
GNUNET_TRANSPORT_connect (const struct GNUNET_CONFIGURATION_Handle *cfg,
- const struct GNUNET_PeerIdentity *self, void *cls,
+ const struct GNUNET_PeerIdentity *self,
+ void *cls,
GNUNET_TRANSPORT_ReceiveCallback rec,
GNUNET_TRANSPORT_NotifyConnect nc,
GNUNET_TRANSPORT_NotifyDisconnect nd);
+/**
+ * Function called if we have "excess" bandwidth to a peer.
+ * The notification will happen the first time we have excess
+ * bandwidth, and then only again after the client has performed
+ * some transmission to the peer.
+ *
+ * Excess bandwidth is defined as being allowed (by ATS) to send
+ * more data, and us reaching the limit of the capacity build-up
+ * (which, if we go past it, means we don't use available bandwidth).
+ * See also the "max carry" in `struct GNUNET_BANDWIDTH_Tracker`.
+ *
+ * @param cls the closure
+ * @param peer peer that we have excess bandwidth to
+ */
+typedef void
+(*GNUNET_TRANSPORT_NotifyExcessBandwidth)(void *cls,
+ const struct GNUNET_PeerIdentity *neighbour);
+
+
+/**
+ * Connect to the transport service. Note that the connection may
+ * complete (or fail) asynchronously.
+ *
+ * @param cfg configuration to use
+ * @param self our own identity (API should check that it matches
+ * the identity found by transport), or NULL (no check)
+ * @param cls closure for the callbacks
+ * @param rec receive function to call, or NULL
+ * @param nc function to call on connect events, or NULL
+ * @param nd function to call on disconnect events, or NULL
+ * @param neb function to call if we have excess bandwidth to a peer
+ * @return NULL on error
+ */
+struct GNUNET_TRANSPORT_Handle *
+GNUNET_TRANSPORT_connect2 (const struct GNUNET_CONFIGURATION_Handle *cfg,
+ const struct GNUNET_PeerIdentity *self,
+ void *cls,
+ GNUNET_TRANSPORT_ReceiveCallback rec,
+ GNUNET_TRANSPORT_NotifyConnect nc,
+ GNUNET_TRANSPORT_NotifyDisconnect nd,
+ GNUNET_TRANSPORT_NotifyExcessBandwidth neb);
+
+
/**
* Disconnect from the transport service.
*
* @param target who we should try to connect to
* @param cb callback to be called when request was transmitted to transport
* service
- * @param cb_cls closure for the callback
- * @return a GNUNET_TRANSPORT_TryConnectHandle handle or
- * NULL on failure (cb will not be called)
+ * @param cb_cls closure for the callback @a cb
+ * @return a `struct GNUNET_TRANSPORT_TryConnectHandle` handle or
+ * NULL on failure (@a cb will not be called)
*/
struct GNUNET_TRANSPORT_TryConnectHandle *
GNUNET_TRANSPORT_try_connect (struct GNUNET_TRANSPORT_Handle *handle,
* Cancel the request to transport to try a connect
* Callback will not be called
*
- * @param tch GNUNET_TRANSPORT_TryConnectHandle handle to cancel
+ * @param tch handle to cancel
*/
void
GNUNET_TRANSPORT_try_connect_cancel (struct GNUNET_TRANSPORT_TryConnectHandle *tch);
+
+/**
+ * Ask the transport service to establish a disconnect from
+ * the given peer.
+ *
+ * @param handle connection to transport service
+ * @param target who we should try to disconnect from
+ * @param cb callback to be called when request was transmitted to transport
+ * service
+ * @param cb_cls closure for the callback @a cb
+ * @return a `struct GNUNET_TRANSPORT_TryConnectHandle` handle or
+ * NULL on failure (@a cb will not be called)
+ */
+struct GNUNET_TRANSPORT_TryConnectHandle *
+GNUNET_TRANSPORT_try_disconnect (struct GNUNET_TRANSPORT_Handle *handle,
+ const struct GNUNET_PeerIdentity *target,
+ GNUNET_TRANSPORT_TryConnectCallback cb,
+ void *cb_cls);
+
+
+/**
+ * Cancel the request to transport to try a disconnect
+ * Callback will not be called
+ *
+ * @param tch handle for operation to cancel
+ */
+void
+GNUNET_TRANSPORT_try_disconnect_cancel (struct GNUNET_TRANSPORT_TryConnectHandle *tch);
+
+
/**
* Opaque handle for a transmission-ready request.
*/
struct GNUNET_TRANSPORT_TransmitHandle;
+/**
+ * Function called to notify a client about the connection begin ready
+ * to queue more data. @a buf will be NULL and @a size zero if the
+ * connection was closed for writing in the meantime.
+ *
+ * @param cls closure
+ * @param size number of bytes available in @a buf
+ * @param buf where the callee should write the message
+ * @return number of bytes written to @a buf
+ */
+typedef size_t
+(*GNUNET_TRANSPORT_TransmitReadyNotify) (void *cls,
+ size_t size,
+ void *buf);
+
+
/**
* Check if we could queue a message of the given size for
* transmission. The transport service will take both its internal
* @param handle connection to transport service
* @param target who should receive the message
* @param size how big is the message we want to transmit?
- * @param priority how important is the message? @deprecated - remove?
* @param timeout after how long should we give up (and call
* notify with buf NULL and size 0)?
* @param notify function to call when we are ready to
* send such a message
- * @param notify_cls closure for notify
+ * @param notify_cls closure for @a notify
* @return NULL if someone else is already waiting to be notified
* non-NULL if the notify callback was queued (can be used to cancel
* using GNUNET_TRANSPORT_notify_transmit_ready_cancel)
*/
struct GNUNET_TRANSPORT_TransmitHandle *
GNUNET_TRANSPORT_notify_transmit_ready (struct GNUNET_TRANSPORT_Handle *handle,
- const struct GNUNET_PeerIdentity
- *target, size_t size, uint32_t priority,
+ const struct GNUNET_PeerIdentity *target,
+ size_t size,
struct GNUNET_TIME_Relative timeout,
- GNUNET_CONNECTION_TransmitReadyNotify
- notify, void *notify_cls);
+ GNUNET_TRANSPORT_TransmitReadyNotify notify,
+ void *notify_cls);
/**
* @param th handle of the transmission notification request to cancel
*/
void
-GNUNET_TRANSPORT_notify_transmit_ready_cancel (struct
- GNUNET_TRANSPORT_TransmitHandle
- *th);
-
+GNUNET_TRANSPORT_notify_transmit_ready_cancel (struct GNUNET_TRANSPORT_TransmitHandle *th);
/**
* @param cls closure
* @param hello our updated HELLO
*/
-typedef void (*GNUNET_TRANSPORT_HelloUpdateCallback) (void *cls,
- const struct
- GNUNET_MessageHeader *
- hello);
+typedef void
+(*GNUNET_TRANSPORT_HelloUpdateCallback) (void *cls,
+ const struct GNUNET_MessageHeader *hello);
/**
- * Handle to cancel a 'GNUNET_TRANSPORT_get_hello' operation.
+ * Handle to cancel a #GNUNET_TRANSPORT_get_hello() operation.
*/
struct GNUNET_TRANSPORT_GetHelloHandle;
/**
- * Checks if a neighbour is connected
- *
- * @param handle connection to transport service
- * @peer the peer to check
- * @return GNUNET_YES or GNUNET_NO
- *
- */
+ * Checks if a given peer is connected to us
+ *
+ * @param handle connection to transport service
+ * @param peer the peer to check
+ * @return #GNUNET_YES (connected) or #GNUNET_NO (disconnected)
+ */
int
-GNUNET_TRANSPORT_check_neighbour_connected (struct GNUNET_TRANSPORT_Handle *handle,
- const struct GNUNET_PeerIdentity *peer);
+GNUNET_TRANSPORT_check_peer_connected (struct GNUNET_TRANSPORT_Handle *handle,
+ const struct GNUNET_PeerIdentity *peer);
/**
*
* @param handle transport handle
* @param peer the peer to set the metric for
- * @param direction can be: TM_SEND, TM_RECV, TM_BOTH
+ * @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 #hops)
+ * #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:
*/
void
GNUNET_TRANSPORT_set_traffic_metric (struct GNUNET_TRANSPORT_Handle *handle,
- const struct GNUNET_PeerIdentity *peer,
- int direction,
- const struct GNUNET_ATS_Information *ats,
- size_t ats_count);
+ const struct GNUNET_PeerIdentity *peer,
+ int inbound,
+ int outbound,
+ const struct GNUNET_ATS_Information *ats,
+ size_t ats_count);
/**
*
* @param handle connection to transport service
* @param rec function to call with the HELLO
- * @param rec_cls closure for rec
+ * @param rec_cls closure for @a rec
* @return handle to cancel the operation
*/
struct GNUNET_TRANSPORT_GetHelloHandle *
GNUNET_TRANSPORT_get_hello_cancel (struct GNUNET_TRANSPORT_GetHelloHandle *ghh);
+/**
+ * Handle for a #GNUNET_TRANSPORT_offer_hello operation
+ */
+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
* @param handle connection to transport service
* @param hello the hello message
* @param cont continuation to call when HELLO has been sent,
- * tc reason GNUNET_SCHEDULER_REASON_TIMEOUT for fail
- * tc reasong GNUNET_SCHEDULER_REASON_READ_READY for success
+ * tc reason #GNUNET_SCHEDULER_REASON_TIMEOUT for fail
+ * tc reasong #GNUNET_SCHEDULER_REASON_READ_READY for success
* @param cls closure for continuation
* @return a GNUNET_TRANSPORT_OfferHelloHandle handle or NULL on failure,
* in case of failure cont will not be called
/**
* Cancel the request to transport to offer the HELLO message
*
- * @param ohh the GNUNET_TRANSPORT_OfferHelloHandle to cancel
+ * @param ohh the `struct GNUNET_TRANSPORT_OfferHelloHandle` to cancel
*/
void
GNUNET_TRANSPORT_offer_hello_cancel (struct GNUNET_TRANSPORT_OfferHelloHandle *ohh);
+
/**
* Handle to cancel a pending address lookup.
*/
* (otherwise do reverse DNS lookup)
* @param timeout how long is the lookup allowed to take at most
* @param aluc function to call with the results
- * @param aluc_cls closure for aluc
+ * @param aluc_cls closure for @a aluc
* @return handle to cancel the operation, NULL on error
*/
struct GNUNET_TRANSPORT_AddressToStringContext *
-GNUNET_TRANSPORT_address_to_string (const struct GNUNET_CONFIGURATION_Handle
- *cfg,
+GNUNET_TRANSPORT_address_to_string (const struct GNUNET_CONFIGURATION_Handle *cfg,
const struct GNUNET_HELLO_Address *address,
int numeric,
struct GNUNET_TIME_Relative timeout,
- GNUNET_TRANSPORT_AddressToStringCallback
- aluc, void *aluc_cls);
+ GNUNET_TRANSPORT_AddressToStringCallback aluc,
+ void *aluc_cls);
/**
* Cancel request for address conversion.
*
- * @param alc handle for the request to cancel
+ * @param pic the context handle
*/
void
-GNUNET_TRANSPORT_address_to_string_cancel (struct
- GNUNET_TRANSPORT_AddressToStringContext
- *alc);
+GNUNET_TRANSPORT_address_to_string_cancel (struct GNUNET_TRANSPORT_AddressToStringContext *pic);
/**
- * Return all the known addresses for a specific peer or all peers.
- * Returns continuously all address if one_shot is set to GNUNET_NO
+ * Convert a transport state to a human readable string.
*
- * CHANGE: Returns the address(es) that we are currently using for this
- * peer. Upon completion, the 'AddressLookUpCallback' is called one more
- * time with 'NULL' for the address and the peer. After this, the operation must no
- * longer be explicitly cancelled.
+ * @param state the state
+ */
+const char *
+GNUNET_TRANSPORT_ps2s (enum GNUNET_TRANSPORT_PeerState state);
+
+
+/**
+ * Check if a state is defined as connected
+ *
+ * @param state the state value
+ * @return #GNUNET_YES or #GNUNET_NO
+ */
+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);
+
+
+/**
+ * Handle for a #GNUNET_TRANSPORT_monitor_peers operation.
+ */
+struct GNUNET_TRANSPORT_PeerMonitoringContext;
+
+/**
+ * Return information about a specific peer or all peers currently known to
+ * transport service once or in monitoring mode. To obtain information about
+ * a specific peer, a peer identity can be passed. To obtain information about
+ * all peers currently known to transport service, NULL can be passed as peer
+ * identity.
+ *
+ * For each peer, the callback is called with information about the address used
+ * 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
+ * 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
+ * @param one_shot #GNUNET_YES to return the current state and then end (with NULL+NULL),
+ * #GNUNET_NO to monitor peers continuously
+ * @param timeout how long is the lookup allowed to take at most
+ * @param peer_callback function to call with the results
+ * @param peer_callback_cls closure for @a peer_callback
+ */
+struct GNUNET_TRANSPORT_PeerMonitoringContext *
+GNUNET_TRANSPORT_monitor_peers (const struct GNUNET_CONFIGURATION_Handle *cfg,
+ const struct GNUNET_PeerIdentity *peer,
+ int one_shot,
+ struct GNUNET_TIME_Relative timeout,
+ GNUNET_TRANSPORT_PeerIterateCallback peer_callback,
+ void *peer_callback_cls);
+
+
+/**
+ * Cancel request to monitor peers
+ *
+ * @param pic handle for the request to cancel
+ */
+void
+GNUNET_TRANSPORT_monitor_peers_cancel (struct GNUNET_TRANSPORT_PeerMonitoringContext *pic);
+
+
+/**
+ * Handle for a #GNUNET_TRANSPORT_monitor_validation_entries() operation.
+ */
+struct GNUNET_TRANSPORT_ValidationMonitoringContext;
+
+/**
+ * Return information about pending address validation operations for a specific
+ * or all peers
*
* @param cfg configuration to use
- * @param peer peer identity to look up the addresses of, CHANGE: allow NULL for all (connected) peers
- * @param one_shot GNUNET_YES to return the current state and then end (with NULL+NULL),
- * GNUNET_NO to monitor the set of addresses used (continuously, must be explicitly canceled, NOT implemented yet!)
+ * @param peer a specific peer identity to obtain validation entries for,
+ * NULL for all peers
+ * @param one_shot #GNUNET_YES to return all entries and then end (with NULL+NULL),
+ * #GNUNET_NO to monitor validation entries continuously
* @param timeout how long is the lookup allowed to take at most
- * @param peer_address_callback function to call with the results
- * @param peer_address_callback_cls closure for peer_address_callback
+ * @param validation_callback function to call with the results
+ * @param validation_callback_cls closure for @a validation_callback
*/
-struct GNUNET_TRANSPORT_PeerIterateContext *
-GNUNET_TRANSPORT_peer_get_active_addresses (const struct
- GNUNET_CONFIGURATION_Handle *cfg,
- const struct GNUNET_PeerIdentity
- *peer, int one_shot,
- struct GNUNET_TIME_Relative timeout,
- GNUNET_TRANSPORT_PeerIterateCallback
- peer_address_callback,
- void *peer_address_callback_cls);
+struct GNUNET_TRANSPORT_ValidationMonitoringContext *
+GNUNET_TRANSPORT_monitor_validation_entries (const struct GNUNET_CONFIGURATION_Handle *cfg,
+ const struct GNUNET_PeerIdentity *peer,
+ int one_shot,
+ struct GNUNET_TIME_Relative timeout,
+ GNUNET_TRANSPORT_ValidationIterateCallback validation_callback,
+ void *validation_callback_cls);
/**
- * Cancel request for peer lookup.
+ * Return information about all current pending validation operations
*
- * @param alc handle for the request to cancel
+ * @param vic handle for the request to cancel
*/
void
-GNUNET_TRANSPORT_peer_get_active_addresses_cancel (struct
- GNUNET_TRANSPORT_PeerIterateContext
- *alc);
+GNUNET_TRANSPORT_monitor_validation_entries_cancel (struct GNUNET_TRANSPORT_ValidationMonitoringContext *vic);
/**
*
* @param cls closure
* @param pid peer to approve or disapproave
- * @return GNUNET_OK if the connection is allowed, GNUNET_SYSERR if not
+ * @return #GNUNET_OK if the connection is allowed, #GNUNET_SYSERR if not
*/
-typedef int (*GNUNET_TRANSPORT_BlacklistCallback) (void *cls,
- const struct
- GNUNET_PeerIdentity * pid);
+typedef int
+(*GNUNET_TRANSPORT_BlacklistCallback) (void *cls,
+ const struct
+ GNUNET_PeerIdentity * pid);
/**
*
* @param cfg configuration to use
* @param cb callback to invoke to check if connections are allowed
- * @param cb_cls closure for cb
+ * @param cb_cls closure for @a cb
* @return NULL on error, otherwise handle for cancellation
*/
struct GNUNET_TRANSPORT_Blacklist *
/* ifndef GNUNET_TRANSPORT_SERVICE_H */
#endif
/* end of gnunet_transport_service.h */
+
+