diff options
Diffstat (limited to 'src/include/gnunet_transport_service.h')
-rw-r--r-- | src/include/gnunet_transport_service.h | 23 |
1 files changed, 22 insertions, 1 deletions
diff --git a/src/include/gnunet_transport_service.h b/src/include/gnunet_transport_service.h index a2f1e07b7..989a33d16 100644 --- a/src/include/gnunet_transport_service.h +++ b/src/include/gnunet_transport_service.h | |||
@@ -206,30 +206,43 @@ enum GNUNET_TRANSPORT_PeerState | |||
206 | GNUNET_TRANSPORT_PS_DISCONNECT_FINISHED | 206 | GNUNET_TRANSPORT_PS_DISCONNECT_FINISHED |
207 | }; | 207 | }; |
208 | 208 | ||
209 | /** | ||
210 | * Current state of a validation process | ||
211 | */ | ||
209 | enum GNUNET_TRANSPORT_ValidationState | 212 | enum GNUNET_TRANSPORT_ValidationState |
210 | { | 213 | { |
211 | /** | 214 | /** |
212 | * Undefined state | 215 | * Undefined state |
216 | * | ||
217 | * Used for final callback indicating operation done | ||
213 | */ | 218 | */ |
214 | GNUNET_TRANSPORT_VS_NONE, | 219 | GNUNET_TRANSPORT_VS_NONE, |
215 | 220 | ||
216 | /** | 221 | /** |
217 | * Fresh validation entry | 222 | * Fresh validation entry |
223 | * | ||
224 | * Entry was just created, no validation process was executed | ||
218 | */ | 225 | */ |
219 | GNUNET_TRANSPORT_VS_NEW, | 226 | GNUNET_TRANSPORT_VS_NEW, |
220 | 227 | ||
221 | /** | 228 | /** |
222 | * Updated validation entry | 229 | * Updated validation entry |
230 | * | ||
231 | * This is an update for an existing validation entry | ||
223 | */ | 232 | */ |
224 | GNUNET_TRANSPORT_VS_UPDATE, | 233 | GNUNET_TRANSPORT_VS_UPDATE, |
225 | 234 | ||
226 | /** | 235 | /** |
227 | * Timeout for validation entry | 236 | * Timeout for validation entry |
237 | * | ||
238 | * A timeout occured during the validation process | ||
228 | */ | 239 | */ |
229 | GNUNET_TRANSPORT_VS_TIMEOUT, | 240 | GNUNET_TRANSPORT_VS_TIMEOUT, |
230 | 241 | ||
231 | /** | 242 | /** |
232 | * Validation entry is removed | 243 | * Validation entry is removed |
244 | * | ||
245 | * The validation entry is getting removed due to a failed validation | ||
233 | */ | 246 | */ |
234 | GNUNET_TRANSPORT_VS_REMOVE, | 247 | GNUNET_TRANSPORT_VS_REMOVE, |
235 | }; | 248 | }; |
@@ -336,10 +349,18 @@ typedef void (*GNUNET_TRANSPORT_PeerIterateCallback) (void *cls, | |||
336 | /** | 349 | /** |
337 | * Function to call with validation information about a peer | 350 | * Function to call with validation information about a peer |
338 | * | 351 | * |
352 | * This function is called by the transport validation monitoring api to | ||
353 | * indicate a change to a validation entry. The information included represent | ||
354 | * the current state of the validation entry, | ||
355 | * | ||
356 | * If the monitoring was called with one_shot=GNUNET_YES, a final callback | ||
357 | * with peer==NULL and address==NULL is executed. | ||
358 | * | ||
339 | * @param cls closure | 359 | * @param cls closure |
340 | * @param peer peer this update is about, | 360 | * @param peer peer this update is about, |
341 | * NULL if this is the final last callback for a iteration operation | 361 | * NULL if this is the final last callback for a iteration operation |
342 | * @param address address, NULL for disconnect notification in monitor mode | 362 | * @param address address, |
363 | * NULL for disconnect notification in monitor mode | ||
343 | * @param valid_until when does this address expire | 364 | * @param valid_until when does this address expire |
344 | * @param next_validation time of the next validation operation | 365 | * @param next_validation time of the next validation operation |
345 | * | 366 | * |