From: Nikos Mavrogiannopoulos <nmav@gnutls.org>
Date: Fri, 18 Mar 2011 19:46:19 +0000 (+0100)
Subject: quickly discuss callback format.
X-Git-Tag: gnutls_2_99_0~100
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=0ee91c39a7ced6260cdd5c0d85c45a22a19d67d5;p=thirdparty%2Fgnutls.git

quickly discuss callback format.
---

diff --git a/lib/system_override.c b/lib/system_override.c
index b529a5f55e..3822189f21 100644
--- a/lib/system_override.c
+++ b/lib/system_override.c
@@ -99,6 +99,8 @@ gnutls_transport_set_global_errno (int err)
  * This is the function where you set a function for gnutls to receive
  * data.  Normally, if you use berkeley style sockets, do not need to
  * use this function since the default (recv(2)) will probably be ok.
+ * The callback should return 0 on connection termination, a positive
+ * number indicating the number of bytes received, and -1 on error.
  *
  * gnutls_pull_func is of the form,
  * ssize_t (*gnutls_pull_func)(gnutls_transport_ptr_t, void*, size_t);
@@ -146,6 +148,8 @@ gnutls_transport_set_pull_timeout_function (gnutls_session_t session,
  * sockets, you do not need to use this function since the default
  * (send(2)) will probably be ok.  Otherwise you should specify this
  * function for gnutls to be able to send data.
+ * The callback should return a positive number indicating the
+ * bytes sent, and -1 on error.
  *
  * push_func is of the form,
  * ssize_t (*gnutls_push_func)(gnutls_transport_ptr_t, const void*, size_t);