diff options
author | Christian Grothoff <christian@grothoff.org> | 2011-02-02 14:09:26 +0000 |
---|---|---|
committer | Christian Grothoff <christian@grothoff.org> | 2011-02-02 14:09:26 +0000 |
commit | 29739c21805faad15d90e7f02c906d28f5feb2f3 (patch) | |
tree | a43d0d7d93a185458924de53d03b65ba4e398275 /src/include/gnunet_core_service.h | |
parent | af4c483794311875e7b8c029e214f936591dde52 (diff) | |
download | gnunet-29739c21805faad15d90e7f02c906d28f5feb2f3.tar.gz gnunet-29739c21805faad15d90e7f02c906d28f5feb2f3.zip |
docu
Diffstat (limited to 'src/include/gnunet_core_service.h')
-rw-r--r-- | src/include/gnunet_core_service.h | 14 |
1 files changed, 10 insertions, 4 deletions
diff --git a/src/include/gnunet_core_service.h b/src/include/gnunet_core_service.h index 897979066..a66fe2343 100644 --- a/src/include/gnunet_core_service.h +++ b/src/include/gnunet_core_service.h | |||
@@ -389,9 +389,10 @@ struct GNUNET_CORE_TransmitHandle; | |||
389 | 389 | ||
390 | /** | 390 | /** |
391 | * Ask the core to call "notify" once it is ready to transmit the | 391 | * Ask the core to call "notify" once it is ready to transmit the |
392 | * given number of bytes to the specified "target". If we are not yet | 392 | * given number of bytes to the specified "target". Must only be |
393 | * connected to the specified peer, a call to this function will cause | 393 | * called after a connection to the respective peer has been |
394 | * us to try to establish a connection. | 394 | * established (and the client has been informed about this). |
395 | * | ||
395 | * | 396 | * |
396 | * @param handle connection to core service | 397 | * @param handle connection to core service |
397 | * @param priority how important is the message? | 398 | * @param priority how important is the message? |
@@ -402,7 +403,12 @@ struct GNUNET_CORE_TransmitHandle; | |||
402 | * @param notify function to call when buffer space is available; | 403 | * @param notify function to call when buffer space is available; |
403 | * will be called with NULL on timeout or if the overall queue | 404 | * will be called with NULL on timeout or if the overall queue |
404 | * for this peer is larger than queue_size and this is currently | 405 | * for this peer is larger than queue_size and this is currently |
405 | * the message with the lowest priority | 406 | * the message with the lowest priority; will also be called |
407 | * with 'NULL' buf if the peer disconnects; since the disconnect | ||
408 | * signal will be emmitted even later, clients MUST cancel | ||
409 | * all pending transmission requests DURING the disconnect | ||
410 | * handler (unless they ensure that 'notify' never calls | ||
411 | * 'GNUNET_CORE_notify_transmit_ready'). | ||
406 | * @param notify_cls closure for notify | 412 | * @param notify_cls closure for notify |
407 | * @return non-NULL if the notify callback was queued, | 413 | * @return non-NULL if the notify callback was queued, |
408 | * NULL if we can not even queue the request (insufficient | 414 | * NULL if we can not even queue the request (insufficient |