| 1 |
.\" ************************************************************************** |
| 2 |
.\" * _ _ ____ _ |
| 3 |
.\" * Project ___| | | | _ \| | |
| 4 |
.\" * / __| | | | |_) | | |
| 5 |
.\" * | (__| |_| | _ <| |___ |
| 6 |
.\" * \___|\___/|_| \_\_____| |
| 7 |
.\" * |
| 8 |
.\" * Copyright (C) 1998 - 2016, Daniel Stenberg, <[email protected]>, et al. |
| 9 |
.\" * |
| 10 |
.\" * This software is licensed as described in the file COPYING, which |
| 11 |
.\" * you should have received as part of this distribution. The terms |
| 12 |
.\" * are also available at https://curl.haxx.se/docs/copyright.html. |
| 13 |
.\" * |
| 14 |
.\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell |
| 15 |
.\" * copies of the Software, and permit persons to whom the Software is |
| 16 |
.\" * furnished to do so, under the terms of the COPYING file. |
| 17 |
.\" * |
| 18 |
.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY |
| 19 |
.\" * KIND, either express or implied. |
| 20 |
.\" * |
| 21 |
.\" ************************************************************************** |
| 22 |
.\" |
| 23 |
.TH curl_easy_recv 3 "29 April 2008" "libcurl 7.18.2" "libcurl Manual" |
| 24 |
.SH NAME |
| 25 |
curl_easy_recv - receives raw data on an "easy" connection |
| 26 |
.SH SYNOPSIS |
| 27 |
.B #include <curl/easy.h> |
| 28 |
.sp |
| 29 |
.BI "CURLcode curl_easy_recv( CURL *" curl ", void *" buffer "," |
| 30 |
.BI "size_t " buflen ", size_t *" n ");" |
| 31 |
.ad |
| 32 |
.SH DESCRIPTION |
| 33 |
This function receives raw data from the established connection. You may use |
| 34 |
it together with \fIcurl_easy_send(3)\fP to implement custom protocols using |
| 35 |
libcurl. This functionality can be particularly useful if you use proxies |
| 36 |
and/or SSL encryption: libcurl will take care of proxy negotiation and |
| 37 |
connection set-up. |
| 38 |
|
| 39 |
\fBbuffer\fP is a pointer to your buffer that will get the received |
| 40 |
data. \fBbuflen\fP is the maximum amount of data you can get in that |
| 41 |
buffer. The variable \fBn\fP points to will receive the number of received |
| 42 |
bytes. |
| 43 |
|
| 44 |
To establish the connection, set \fICURLOPT_CONNECT_ONLY(3)\fP option before |
| 45 |
calling \fIcurl_easy_perform(3)\fP or \fIcurl_multi_perform(3)\fP. Note that |
| 46 |
\fIcurl_easy_recv(3)\fP does not work on connections that were created without |
| 47 |
this option. |
| 48 |
|
| 49 |
The call will return \fBCURLE_AGAIN\fP if there is no data to read - the |
| 50 |
socket is used in non-blocking mode internally. When \fBCURLE_AGAIN\fP is |
| 51 |
returned, use your operating system facilities like \fIselect(2)\fP to wait |
| 52 |
for data. The socket may be obtained using \fIcurl_easy_getinfo(3)\fP with |
| 53 |
\fICURLINFO_ACTIVESOCKET(3)\fP. |
| 54 |
|
| 55 |
Wait on the socket only if \fIcurl_easy_recv(3)\fP returns \fBCURLE_AGAIN\fP. |
| 56 |
The reason for this is libcurl or the SSL library may internally cache some |
| 57 |
data, therefore you should call \fIcurl_easy_recv(3)\fP until all data is |
| 58 |
read which would include any cached data. |
| 59 |
|
| 60 |
Furthermore if you wait on the socket and it tells you there is data to read, |
| 61 |
\fIcurl_easy_recv(3)\fP may return \fBCURLE_AGAIN\fP if the only data that was |
| 62 |
read was for internal SSL processing, and no other data is available. |
| 63 |
|
| 64 |
.SH AVAILABILITY |
| 65 |
Added in 7.18.2. |
| 66 |
.SH RETURN VALUE |
| 67 |
On success, returns \fBCURLE_OK\fP, stores the received data into |
| 68 |
\fBbuffer\fP, and the number of bytes it actually read into \fB*n\fP. |
| 69 |
|
| 70 |
On failure, returns the appropriate error code. |
| 71 |
|
| 72 |
The function may return \fBCURLE_AGAIN\fP. In this case, use your operating |
| 73 |
system facilities to wait until data can be read, and retry. |
| 74 |
|
| 75 |
Reading exactly 0 bytes indicates a closed connection. |
| 76 |
|
| 77 |
If there's no socket available to use from the previous transfer, this function |
| 78 |
returns \fBCURLE_UNSUPPORTED_PROTOCOL\fP. |
| 79 |
.SH EXAMPLE |
| 80 |
See \fBsendrecv.c\fP in \fBdocs/examples\fP directory for usage example. |
| 81 |
.SH "SEE ALSO" |
| 82 |
.BR curl_easy_setopt "(3), " curl_easy_perform "(3), " |
| 83 |
.BR curl_easy_getinfo "(3), " |
| 84 |
.BR curl_easy_send "(3) " |