mingw/share/man/man3/curl_easy_recv.3

   1 .\" **************************************************************************
   2 .\" *                                  _   _ ____  _
   3 .\" *  Project                     ___| | | |  _ \| |
   4 .\" *                             / __| | | | |_) | |
   5 .\" *                            | (__| |_| |  _ <| |___
   6 .\" *                             \___|\___/|_| \_\_____|
   7 .\" *
   8 .\" * Copyright (C) 1998 - 2008, Daniel Stenberg, <daniel@haxx.se>, 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 http://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 .\" * $Id: curl_easy_recv.3,v 1.1 2008-05-12 21:43:28 bagder Exp $
  22 .\" **************************************************************************
  23 .\"
  24 .TH curl_easy_recv 3 "29 April 2008" "libcurl 7.18.2" "libcurl Manual"
  25 .SH NAME
  26 curl_easy_recv - receives raw data on an "easy" connection
  27 .SH SYNOPSIS
  28 .B #include <curl/easy.h>
  29 .sp
  30 .BI "CURLcode curl_easy_recv( CURL *" curl ", void *" buffer ","
  31 .BI "size_t " buflen ", size_t *" n ");"
  32 .ad
  33 .SH DESCRIPTION
  34 This function receives raw data from the established connection. You may use
  35 it together with \fIcurl_easy_send(3)\fP to implement custom protocols using
  36 libcurl. This functionality can be particularly useful if you use proxies
  37 and/or SSL encryption: libcurl will take care of proxy negotiation and
  38 connection set-up.
  39
  40 \fBbuffer\fP is a pointer to your buffer that will get the received
  41 data. \fBbuflen\fP is the maximum amount of data you can get in that
  42 buffer. The variable \fBn\fP points to will receive the number of received
  43 bytes.
  44
  45 To establish the connection, set \fBCURLOPT_CONNECT_ONLY\fP option before
  46 calling \fIcurl_easy_perform(3)\fP. Note that \fIcurl_easy_recv(3)\fP does not
  47 work on connections that were created without this option.
  48
  49 You must ensure that the socket has data to read before calling
  50 \fIcurl_easy_recv(3)\fP, otherwise the call will return \fBCURLE_AGAIN\fP -
  51 the socket is used in non-blocking mode internally. Use
  52 \fIcurl_easy_getinfo(3)\fP with \fBCURLINFO_LASTSOCKET\fP to obtain the
  53 socket; use your operating system facilities like \fIselect(2)\fP to check if
  54 it has any data you can read.
  55 .SH AVAILABILITY
  56 Added in 7.18.2.
  57 .SH RETURN VALUE
  58 On success, returns \fBCURLE_OK\fP, stores the received data into
  59 \fBbuffer\fP, and the number of bytes it actually read into \fB*n\fP.
  60
  61 On failure, returns the appropriate error code.
  62
  63 If there is no data to read, the function returns \fBCURLE_AGAIN\fP. Use
  64 your operating system facilities to wait until the data is ready, and retry.
  65 .SH EXAMPLE
  66 See \fBsendrecv.c\fP in \fBdocs/examples\fP directory for usage example.
  67 .SH "SEE ALSO"
  68 .BR curl_easy_setopt "(3), " curl_easy_perform "(3), "
  69 .BR curl_easy_getinfo "(3), "
  70 .BR curl_easy_send "(3) "