diff options
Diffstat (limited to 'src/include/gnunet_transport_service.h')
-rw-r--r-- | src/include/gnunet_transport_service.h | 20 |
1 files changed, 11 insertions, 9 deletions
diff --git a/src/include/gnunet_transport_service.h b/src/include/gnunet_transport_service.h index 9e82a0dda..3a4d282e4 100644 --- a/src/include/gnunet_transport_service.h +++ b/src/include/gnunet_transport_service.h | |||
@@ -277,18 +277,20 @@ typedef void | |||
277 | 277 | ||
278 | 278 | ||
279 | /** | 279 | /** |
280 | * Function to call with a textual representation of an address. | 280 | * Function to call with a textual representation of an address. This |
281 | * This function will be called several times with different possible | 281 | * function will be called several times with different possible |
282 | * textual representations, and a last time with NULL to signal the end | 282 | * textual representations, and a last time with @address being NULL |
283 | * of the iteration. | 283 | * to signal the end of the iteration. Note that @address NULL |
284 | * always is the last call, regardless of the value in @a res. | ||
284 | * | 285 | * |
285 | * @param cls closure | 286 | * @param cls closure |
286 | * @param address NULL on error or end of iteration, | 287 | * @param address NULL on end of iteration, |
287 | * otherwise 0-terminated printable UTF-8 string | 288 | * otherwise 0-terminated printable UTF-8 string, |
289 | * in particular an empty string if @a res is #GNUNET_NO | ||
288 | * @param res result of the address to string conversion: | 290 | * @param res result of the address to string conversion: |
289 | * if #GNUNET_OK: address was valid (conversion to | 291 | * if #GNUNET_OK: conversion successful |
290 | * string might still have failed) | 292 | * if #GNUNET_NO: address was invalid (or not supported) |
291 | * if #GNUNET_SYSERR: address is invalid | 293 | * if #GNUNET_SYSERR: communication error (IPC error) |
292 | */ | 294 | */ |
293 | typedef void | 295 | typedef void |
294 | (*GNUNET_TRANSPORT_AddressToStringCallback) (void *cls, | 296 | (*GNUNET_TRANSPORT_AddressToStringCallback) (void *cls, |