1curl_easy_recv(3)               libcurl Manual               curl_easy_recv(3)
2
3
4

NAME

6       curl_easy_recv - receives raw data on an "easy" connection
7

SYNOPSIS

9       #include <curl/easy.h>
10
11       CURLcode  curl_easy_recv(  CURL  *curl,  void  *buffer,  size_t buflen,
12       size_t *n);
13

DESCRIPTION

15       This function receives raw data from the  established  connection.  You
16       may  use  it together with curl_easy_send(3) to implement custom proto‐
17       cols using libcurl. This functionality can be  particularly  useful  if
18       you  use proxies and/or SSL encryption: libcurl will take care of proxy
19       negotiation and connection set-up.
20
21       buffer is a pointer to your buffer that will  get  the  received  data.
22       buflen  is  the  maximum amount of data you can get in that buffer. The
23       variable n points to will receive the number of received bytes.
24
25       To establish the connection,  set  CURLOPT_CONNECT_ONLY  option  before
26       calling curl_easy_perform(3). Note that curl_easy_recv(3) does not work
27       on connections that were created without this option.
28
29       You must ensure that  the  socket  has  data  to  read  before  calling
30       curl_easy_recv(3),  otherwise  the  call  will return CURLE_AGAIN - the
31       socket is used in  non-blocking  mode  internally.  Use  curl_easy_get‐
32       info(3) with CURLINFO_LASTSOCKET to obtain the socket; use your operat‐
33       ing system facilities like select(2) to check if it has  any  data  you
34       can read.
35

AVAILABILITY

37       Added in 7.18.2.
38

RETURN VALUE

40       On success, returns CURLE_OK, stores the received data into buffer, and
41       the number of bytes it actually read into *n.
42
43       On failure, returns the appropriate error code.
44
45       If there is no data to read, the function returns CURLE_AGAIN. Use your
46       operating system facilities to wait until the data is ready, and retry.
47

EXAMPLE

49       See sendrecv.c in docs/examples directory for usage example.
50

SEE ALSO

52       curl_easy_setopt(3),     curl_easy_perform(3),    curl_easy_getinfo(3),
53       curl_easy_send(3)
54
55
56
57libcurl 7.18.2                   29 April 2008               curl_easy_recv(3)
Impressum