From d7fb329ea0191136a79cd7164f3684a570b74269 Mon Sep 17 00:00:00 2001 From: Nikos Mavrogiannopoulos Date: Tue, 4 Apr 2017 10:26:43 +0200 Subject: gnutls_transport_set_pull_timeout_function: doc update [ci skip] Clarified when this function should be set. Based on suggestion by Sean Greenslade. Signed-off-by: Nikos Mavrogiannopoulos --- lib/system_override.c | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) diff --git a/lib/system_override.c b/lib/system_override.c index 27959c3af4..fdf766509c 100644 --- a/lib/system_override.c +++ b/lib/system_override.c @@ -103,11 +103,15 @@ gnutls_transport_set_pull_function(gnutls_session_t session, * int (*gnutls_pull_timeout_func)(gnutls_transport_ptr_t, unsigned int ms); * * This callback is necessary when gnutls_handshake_set_timeout() or - * gnutls_record_set_timeout() are set. It will not be used when - * non-blocking sockets are in use. That is, this function will - * not operate when %GNUTLS_NONBLOCK is specified in gnutls_init(), - * or a custom pull function is registered without updating the - * pull timeout function. + * gnutls_record_set_timeout() are set, and for calculating the DTLS mode + * timeouts. + * + * In short, this callback should be set when a custom pull function is + * registered. The callback will not be used when the session is in TLS mode with + * non-blocking sockets. That is, when %GNUTLS_NONBLOCK is specified for a TLS + * session in gnutls_init(). For compatibility with future GnuTLS versions + * it is recommended to always set this function when a custom pull function + * is registered. * * The helper function gnutls_system_recv_timeout() is provided to * simplify writing callbacks. -- cgit v1.2.1