gnunet-svn
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[GNUnet-SVN] r33755 - in gnunet/src: fs include


From: gnunet
Subject: [GNUnet-SVN] r33755 - in gnunet/src: fs include
Date: Sun, 22 Jun 2014 22:24:36 +0200

Author: grothoff
Date: 2014-06-22 22:24:36 +0200 (Sun, 22 Jun 2014)
New Revision: 33755

Modified:
   gnunet/src/fs/fs_search.c
   gnunet/src/include/gnunet_transport_service.h
   gnunet/src/include/gnunet_tun_lib.h
Log:
-reordering API in header to make structure more obvious

Modified: gnunet/src/fs/fs_search.c
===================================================================
--- gnunet/src/fs/fs_search.c   2014-06-22 20:15:18 UTC (rev 33754)
+++ gnunet/src/fs/fs_search.c   2014-06-22 20:24:36 UTC (rev 33755)
@@ -1383,7 +1383,7 @@
  */
 static int
 search_result_suspend (void *cls,
-                       const struct GNUNET_HashCode * key,
+                       const struct GNUNET_HashCode *key,
                        void *value)
 {
   struct GNUNET_FS_SearchContext *sc = cls;

Modified: gnunet/src/include/gnunet_transport_service.h
===================================================================
--- gnunet/src/include/gnunet_transport_service.h       2014-06-22 20:15:18 UTC 
(rev 33754)
+++ gnunet/src/include/gnunet_transport_service.h       2014-06-22 20:24:36 UTC 
(rev 33755)
@@ -45,186 +45,11 @@
 
 
 /**
- * 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
-};
-
-
-/**
- * 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
-{
-  /**
-   * 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.
  *
  * @param cls closure
  * @param peer (claimed) identity of the other peer
  * @param message the message
- * @param ats performance data
- * @param ats_count number of entries in @a ats
  */
 typedef void
 (*GNUNET_TRANSPORT_ReceiveCallback) (void *cls,
@@ -244,8 +69,6 @@
  *
  * @param cls closure
  * @param peer the peer that connected
- * @param ats performance data
- * @param ats_count number of entries in @a ats (excluding 0-termination)
  */
 typedef void
 (*GNUNET_TRANSPORT_NotifyConnect) (void *cls,
@@ -264,97 +87,6 @@
 
 
 /**
- * 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_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 @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 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,
-                                             int res);
-
-
-/**
- * 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
- * @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,
-                                         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);
-
-
-/**
  * Connect to the transport service.  Note that the connection may
  * complete (or fail) asynchronously.
  *
@@ -388,7 +120,7 @@
  * See also the "max carry" in `struct GNUNET_BANDWIDTH_Tracker`.
  *
  * @param cls the closure
- * @param peer peer that we have excess bandwidth to
+ * @param neighbour peer that we have excess bandwidth to
  */
 typedef void
 (*GNUNET_TRANSPORT_NotifyExcessBandwidth)(void *cls,
@@ -428,12 +160,25 @@
 GNUNET_TRANSPORT_disconnect (struct GNUNET_TRANSPORT_Handle *handle);
 
 
+/* ************************* Connections *********************** */
+
 /**
  * Opaque handle for a transmission-ready request.
  */
 struct GNUNET_TRANSPORT_TryConnectHandle;
 
+/**
+ * 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_TryConnectCallback) (void *cls,
+                                        const int result);
 
+
 /**
  * Ask the transport service to establish a connection to
  * the given peer.
@@ -464,8 +209,7 @@
 
 
 /**
- * Ask the transport service to establish a disconnect from
- * the given peer.
+ * Ask the transport service to disconnect from the given peer.
  *
  * @param handle connection to transport service
  * @param target who we should try to disconnect from
@@ -483,8 +227,8 @@
 
 
 /**
- * Cancel the request to transport to try a disconnect
- * Callback will not be called
+ * Cancel the request to transport to disconnect.
+ * Callback will not be called anymore.
  *
  * @param tch handle for operation to cancel
  */
@@ -492,6 +236,8 @@
 GNUNET_TRANSPORT_try_disconnect_cancel (struct 
GNUNET_TRANSPORT_TryConnectHandle *tch);
 
 
+/* ************************* Sending *************************** */
+
 /**
  * Opaque handle for a transmission-ready request.
  */
@@ -530,7 +276,7 @@
  * @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)
+ *         using #GNUNET_TRANSPORT_notify_transmit_ready_cancel())
  */
 struct GNUNET_TRANSPORT_TransmitHandle *
 GNUNET_TRANSPORT_notify_transmit_ready (struct GNUNET_TRANSPORT_Handle *handle,
@@ -550,25 +296,8 @@
 GNUNET_TRANSPORT_notify_transmit_ready_cancel (struct 
GNUNET_TRANSPORT_TransmitHandle *th);
 
 
-/**
- * Function called whenever there is an update to the
- * HELLO of this peer.
- *
- * @param cls closure
- * @param hello our updated HELLO
- */
-typedef void
-(*GNUNET_TRANSPORT_HelloUpdateCallback) (void *cls,
-                                         const struct GNUNET_MessageHeader 
*hello);
 
-
 /**
- * Handle to cancel a #GNUNET_TRANSPORT_get_hello() operation.
- */
-struct GNUNET_TRANSPORT_GetHelloHandle;
-
-
-/**
  * Checks if a given peer is connected to us
  *
  * @param handle connection to transport service
@@ -580,6 +309,9 @@
                                        const struct GNUNET_PeerIdentity *peer);
 
 
+
+/* *********************** Metric manipulation ***************** */
+
 /**
  * Set transport metrics for a peer and a direction
  *
@@ -615,7 +347,28 @@
                                     size_t ats_count);
 
 
+/* *************************** HELLO *************************** */
+
+
 /**
+ * Function called whenever there is an update to the
+ * HELLO of this peer.
+ *
+ * @param cls closure
+ * @param hello our updated HELLO
+ */
+typedef void
+(*GNUNET_TRANSPORT_HelloUpdateCallback) (void *cls,
+                                         const struct GNUNET_MessageHeader 
*hello);
+
+
+/**
+ * Handle to cancel a #GNUNET_TRANSPORT_get_hello() operation.
+ */
+struct GNUNET_TRANSPORT_GetHelloHandle;
+
+
+/**
  * Obtain updates on changes to the HELLO message for this peer. The callback
  * given in this function is never called synchronously.
  *
@@ -674,6 +427,8 @@
 GNUNET_TRANSPORT_offer_hello_cancel (struct GNUNET_TRANSPORT_OfferHelloHandle 
*ohh);
 
 
+/* *********************** Address to String ******************* */
+
 /**
  * Handle to cancel a pending address lookup.
  */
@@ -681,6 +436,28 @@
 
 
 /**
+ * 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 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,
+                                             int res);
+
+
+/**
  * Convert a binary address into a human readable address.
  *
  * @param cfg configuration to use
@@ -710,7 +487,137 @@
 GNUNET_TRANSPORT_address_to_string_cancel (struct 
GNUNET_TRANSPORT_AddressToStringContext *pic);
 
 
+/* *********************** Monitoring ************************** */
+
+
 /**
+ * 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
+};
+
+
+/**
  * Convert a transport state to a human readable string.
  *
  * @param state the state
@@ -730,20 +637,37 @@
 
 
 /**
- * Convert validation state to human-readable string.
- *
- * @param state the state value
- * @return corresponding string
+ * Handle for a #GNUNET_TRANSPORT_monitor_peers operation.
  */
-const char *
-GNUNET_TRANSPORT_vs2s (enum GNUNET_TRANSPORT_ValidationState state);
+struct GNUNET_TRANSPORT_PeerMonitoringContext;
 
 
 /**
- * Handle for a #GNUNET_TRANSPORT_monitor_peers operation.
+ * 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
+ * @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
  */
-struct GNUNET_TRANSPORT_PeerMonitoringContext;
+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);
 
+
 /**
  * Return information about a specific peer or all peers currently known to
  * transport service once or in monitoring mode. To obtain information about
@@ -794,7 +718,94 @@
  */
 struct GNUNET_TRANSPORT_ValidationMonitoringContext;
 
+
 /**
+ * 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
+{
+  /**
+   * 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 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);
+
+
+/**
+ * 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 pending address validation operations for a 
specific
  * or all peers
  *
@@ -825,6 +836,8 @@
 GNUNET_TRANSPORT_monitor_validation_entries_cancel (struct 
GNUNET_TRANSPORT_ValidationMonitoringContext *vic);
 
 
+/* *********************** Blacklisting ************************ */
+
 /**
  * Handle for blacklisting peers.
  */
@@ -840,8 +853,7 @@
  */
 typedef int
 (*GNUNET_TRANSPORT_BlacklistCallback) (void *cls,
-                                       const struct
-                                       GNUNET_PeerIdentity * pid);
+                                       const struct GNUNET_PeerIdentity *pid);
 
 
 /**

Modified: gnunet/src/include/gnunet_tun_lib.h
===================================================================
--- gnunet/src/include/gnunet_tun_lib.h 2014-06-22 20:15:18 UTC (rev 33754)
+++ gnunet/src/include/gnunet_tun_lib.h 2014-06-22 20:24:36 UTC (rev 33755)
@@ -185,6 +185,18 @@
 
 
 /**
+ * TCP flags.
+ */
+#define GNUNET_TUN_TCP_FLAGS_FIN 1
+#define GNUNET_TUN_TCP_FLAGS_SYN 2
+#define GNUNET_TUN_TCP_FLAGS_RST 4
+#define GNUNET_TUN_TCP_FLAGS_PSH 8
+#define GNUNET_TUN_TCP_FLAGS_ACK 16
+#define GNUNET_TUN_TCP_FLAGS_URG 32
+#define GNUNET_TUN_TCP_FLAGS_ECE 64
+#define GNUNET_TUN_TCP_FLAGS_CWR 128
+
+/**
  * TCP packet header.
  */
 struct GNUNET_TUN_TcpHeader




reply via email to

[Prev in Thread] Current Thread [Next in Thread]