From d90b9aee64a186c549689ed54113dca10ded26c8 Mon Sep 17 00:00:00 2001 From: Daniel Stenberg Date: Sat, 19 Jan 2013 22:58:02 +0100 Subject: [PATCH] curl_easy_recv.3: document return codes Reported by: Craig Davison Bug: http://curl.haxx.se/mail/lib-2013-01/0234.html --- docs/libcurl/curl_easy_recv.3 | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/docs/libcurl/curl_easy_recv.3 b/docs/libcurl/curl_easy_recv.3 index 1ede58944..0de6037ba 100644 --- a/docs/libcurl/curl_easy_recv.3 +++ b/docs/libcurl/curl_easy_recv.3 @@ -5,7 +5,7 @@ .\" * | (__| |_| | _ <| |___ .\" * \___|\___/|_| \_\_____| .\" * -.\" * Copyright (C) 1998 - 2008, Daniel Stenberg, , et al. +.\" * Copyright (C) 1998 - 2013, Daniel Stenberg, , et al. .\" * .\" * This software is licensed as described in the file COPYING, which .\" * you should have received as part of this distribution. The terms @@ -59,8 +59,13 @@ On success, returns \fBCURLE_OK\fP, stores the received data into On failure, returns the appropriate error code. -If there is no data to read, the function returns \fBCURLE_AGAIN\fP. Use -your operating system facilities to wait until the data is ready, and retry. +If there is no data to read, the function returns \fBCURLE_AGAIN\fP. Use your +operating system facilities to wait until the data is ready, and retry. + +Reading exactly 0 bytes would indicate a closed connection. + +If there's no socket available to use from the previous transfer, this function +returns CURLE_UNSUPPORTED_PROTOCOL. .SH EXAMPLE See \fBsendrecv.c\fP in \fBdocs/examples\fP directory for usage example. .SH "SEE ALSO"