diff options
author | Matthias Wachs <wachs@net.in.tum.de> | 2014-04-03 08:21:04 +0000 |
---|---|---|
committer | Matthias Wachs <wachs@net.in.tum.de> | 2014-04-03 08:21:04 +0000 |
commit | 05c4d0f2433df51a628b8f772af961ce1329d65e (patch) | |
tree | 09622cedbdabef00f3da08756e0713282120ccb0 /src/include/gnunet_transport_service.h | |
parent | 50ac7449a83e66afa7e73ad1461337bd265c2807 (diff) | |
download | gnunet-05c4d0f2433df51a628b8f772af961ce1329d65e.tar.gz gnunet-05c4d0f2433df51a628b8f772af961ce1329d65e.zip |
doxygen docu
Diffstat (limited to 'src/include/gnunet_transport_service.h')
-rw-r--r-- | src/include/gnunet_transport_service.h | 40 |
1 files changed, 16 insertions, 24 deletions
diff --git a/src/include/gnunet_transport_service.h b/src/include/gnunet_transport_service.h index 0c719d955..69dcefb21 100644 --- a/src/include/gnunet_transport_service.h +++ b/src/include/gnunet_transport_service.h | |||
@@ -47,46 +47,38 @@ extern "C" | |||
47 | /** | 47 | /** |
48 | * Possible state of a neighbour. Initially, we are #GNUNET_TRANSPORT_PS_NOT_CONNECTED. | 48 | * Possible state of a neighbour. Initially, we are #GNUNET_TRANSPORT_PS_NOT_CONNECTED. |
49 | * | 49 | * |
50 | * Then, there are two main paths. If we receive a CONNECT message, we | 50 | * Then, there are two main paths. If we receive a CONNECT message, we give |
51 | * first run a check against the blacklist if we are allowed to communicate with | 51 | * the inbound address to ATS. After the check we ask ATS for a suggestion |
52 | * this peer (#GNUNET_TRANSPORT_PS_CONNECT_RECV_BLACKLIST_INBOUND). | 52 | * (#GNUNET_TRANSPORT_PS_CONNECT_RECV_ATS). If ATS makes a suggestion, we |
53 | * If this check is successful, we give the inbound address to ATS. | 53 | * send our CONNECT_ACK and go to #GNUNET_TRANSPORT_PS_CONNECT_RECV_ACK. |
54 | * After the check we ask ATS for a suggestion (#GNUNET_TRANSPORT_PS_CONNECT_RECV_ATS). | 54 | * If we receive a SESSION_ACK, we go to #GNUNET_TRANSPORT_PS_CONNECTED |
55 | * If ATS makes a suggestion, we ALSO give that suggestion to the blacklist | 55 | * (and notify everyone about the new connection). If the operation times out, |
56 | * (#GNUNET_TRANSPORT_PS_CONNECT_RECV_BLACKLIST). Once the blacklist approves the | 56 | * we go to #GNUNET_TRANSPORT_PS_DISCONNECT. |
57 | * address we got from ATS, we send our CONNECT_ACK and go to | ||
58 | * #GNUNET_TRANSPORT_PS_CONNECT_RECV_ACK. If we receive a SESSION_ACK, we go to | ||
59 | * #GNUNET_TRANSPORT_PS_CONNECTED (and notify everyone about the new connection). | ||
60 | * If the operation times out, we go to #GNUNET_TRANSPORT_PS_DISCONNECT. | ||
61 | * | 57 | * |
62 | * The other case is where we transmit a CONNECT message first. We | 58 | * The other case is where we transmit a CONNECT message first. We |
63 | * start with #GNUNET_TRANSPORT_PS_INIT_ATS. If we get an address, we enter | 59 | * start with #GNUNET_TRANSPORT_PS_INIT_ATS. If we get an address, we send |
64 | * #GNUNET_TRANSPORT_PS_INIT_BLACKLIST and check the blacklist. If the blacklist is OK | 60 | * the CONNECT message and go to state #GNUNET_TRANSPORT_PS_CONNECT_SENT. |
65 | * with the connection, we actually send the CONNECT message and go to | 61 | * Once we receive a CONNECT_ACK, we go to #GNUNET_TRANSPORT_PS_CONNECTED |
66 | * state #GNUNET_TRANSPORT_PS_CONNECT_SENT. Once we receive a CONNECT_ACK, we go to | 62 | * (and notify everyone about the new connection and send |
67 | * #GNUNET_TRANSPORT_PS_CONNECTED (and notify everyone about the new connection and send | ||
68 | * back a SESSION_ACK). If the operation times out, we go to | 63 | * back a SESSION_ACK). If the operation times out, we go to |
69 | * #GNUNET_TRANSPORT_PS_DISCONNECT. | 64 | * #GNUNET_TRANSPORT_PS_DISCONNECT. |
70 | * | 65 | * |
71 | * If the session is in trouble (i.e. transport-level disconnect or | 66 | * If the session is in trouble (i.e. transport-level disconnect or |
72 | * timeout), we go to #GNUNET_TRANSPORT_PS_RECONNECT_ATS where we ask ATS for a new | 67 | * timeout), we go to #GNUNET_TRANSPORT_PS_RECONNECT_ATS where we ask ATS for a new |
73 | * address (we don't notify anyone about the disconnect yet). Once we | 68 | * address (we don't notify anyone about the disconnect yet). Once we |
74 | * have a new address, we go to #GNUNET_TRANSPORT_PS_RECONNECT_BLACKLIST to check the new | 69 | * have a new address, we enter #GNUNET_TRANSPORT_PS_RECONNECT_SENT and send a |
75 | * address against the blacklist. If the blacklist approves, we enter | 70 | * CONNECT message. If we receive a |
76 | * #GNUNET_TRANSPORT_PS_RECONNECT_SENT and send a CONNECT message. If we receive a | ||
77 | * CONNECT_ACK, we go to #GNUNET_TRANSPORT_PS_CONNECTED and nobody noticed that we had | 71 | * CONNECT_ACK, we go to #GNUNET_TRANSPORT_PS_CONNECTED and nobody noticed that we had |
78 | * trouble; we also send a SESSION_ACK at this time just in case. If | 72 | * trouble; we also send a SESSION_ACK at this time just in case. If |
79 | * the operation times out, we go to #GNUNET_TRANSPORT_PS_DISCONNECT (and notify everyone | 73 | * the operation times out, we go to #GNUNET_TRANSPORT_PS_DISCONNECT (and notify everyone |
80 | * about the lost connection). | 74 | * about the lost connection). |
81 | * | 75 | * |
82 | * If ATS decides to switch addresses while we have a normal | 76 | * If ATS decides to switch addresses while we have a normal |
83 | * connection, we go to #GNUNET_TRANSPORT_PS_CONNECTED_SWITCHING_BLACKLIST to check the | 77 | * connection, we go to #GNUNET_TRANSPORT_PS_CONNECTED_SWITCHING_CONNECT_SENT |
84 | * new address against the blacklist. If the blacklist approves, we | 78 | * and send a SESSION_CONNECT. If we get a SESSION_ACK back, we switch the |
85 | * go to #GNUNET_TRANSPORT_PS_CONNECTED_SWITCHING_CONNECT_SENT and send a | ||
86 | * SESSION_CONNECT. If we get a SESSION_ACK back, we switch the | ||
87 | * primary connection to the suggested alternative from ATS, go back | 79 | * primary connection to the suggested alternative from ATS, go back |
88 | * to #GNUNET_TRANSPORT_PS_CONNECTED and send a SESSION_ACK to the other peer just to be | 80 | * to #GNUNET_TRANSPORT_PS_CONNECTED and send a SESSION_ACK to the other peer just to be |
89 | * sure. If the operation times out (or the blacklist disapproves), | 81 | * sure. If the operation times out |
90 | * we go to #GNUNET_TRANSPORT_PS_CONNECTED (and notify ATS that the given alternative | 82 | * we go to #GNUNET_TRANSPORT_PS_CONNECTED (and notify ATS that the given alternative |
91 | * address is "invalid"). | 83 | * address is "invalid"). |
92 | * | 84 | * |