From 29739c21805faad15d90e7f02c906d28f5feb2f3 Mon Sep 17 00:00:00 2001 From: Christian Grothoff Date: Wed, 2 Feb 2011 14:09:26 +0000 Subject: [PATCH] docu --- src/core/core_api.c | 6 +++--- src/include/gnunet_core_service.h | 14 ++++++++++---- 2 files changed, 13 insertions(+), 7 deletions(-) diff --git a/src/core/core_api.c b/src/core/core_api.c index f5f421277..a2e0dae09 100644 --- a/src/core/core_api.c +++ b/src/core/core_api.c @@ -1478,9 +1478,9 @@ GNUNET_CORE_disconnect (struct GNUNET_CORE_Handle *handle) /** * Ask the core to call "notify" once it is ready to transmit the - * given number of bytes to the specified "target". If we are not yet - * connected to the specified peer, a call to this function will cause - * us to try to establish a connection. + * given number of bytes to the specified "target". Must only be + * called after a connection to the respective peer has been + * established (and the client has been informed about this). * * @param handle connection to core service * @param priority how important is the message? 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; /** * Ask the core to call "notify" once it is ready to transmit the - * given number of bytes to the specified "target". If we are not yet - * connected to the specified peer, a call to this function will cause - * us to try to establish a connection. + * given number of bytes to the specified "target". Must only be + * called after a connection to the respective peer has been + * established (and the client has been informed about this). + * * * @param handle connection to core service * @param priority how important is the message? @@ -402,7 +403,12 @@ struct GNUNET_CORE_TransmitHandle; * @param notify function to call when buffer space is available; * will be called with NULL on timeout or if the overall queue * for this peer is larger than queue_size and this is currently - * the message with the lowest priority + * the message with the lowest priority; will also be called + * with 'NULL' buf if the peer disconnects; since the disconnect + * signal will be emmitted even later, clients MUST cancel + * all pending transmission requests DURING the disconnect + * handler (unless they ensure that 'notify' never calls + * 'GNUNET_CORE_notify_transmit_ready'). * @param notify_cls closure for notify * @return non-NULL if the notify callback was queued, * NULL if we can not even queue the request (insufficient -- 2.25.1