docs/libcurl/opts/CURLOPT_HEADERFUNCTION.3

   1 .\" **************************************************************************
   2 .\" *                                  _   _ ____  _
   3 .\" *  Project                     ___| | | |  _ \| |
   4 .\" *                             / __| | | | |_) | |
   5 .\" *                            | (__| |_| |  _ <| |___
   6 .\" *                             \___|\___/|_| \_\_____|
   7 .\" *
   8 .\" * Copyright (C) 1998 - 2018, 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 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 CURLOPT_HEADERFUNCTION 3 "February 16, 2018" "libcurl 7.59.0" "curl_easy_setopt options"
  24
  25 .SH NAME
  26 CURLOPT_HEADERFUNCTION \- callback that receives header data
  27 .SH SYNOPSIS
  28 #include <curl/curl.h>
  29
  30 size_t header_callback(char *buffer,
  31                        size_t size,
  32                        size_t nitems,
  33                        void *userdata);
  34
  35 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_HEADERFUNCTION, header_callback);
  36 .SH DESCRIPTION
  37 Pass a pointer to your callback function, which should match the prototype
  38 shown above.
  39
  40 This function gets called by libcurl as soon as it has received header
  41 data. The header callback will be called once for each header and only
  42 complete header lines are passed on to the callback. Parsing headers is very
  43 easy using this. The size of the data pointed to by \fIbuffer\fP is \fIsize\fP
  44 multiplied with \fInmemb\fP. Do not assume that the header line is zero
  45 terminated! The pointer named \fIuserdata\fP is the one you set with the
  46 \fICURLOPT_HEADERDATA(3)\fP option. This callback function must return the
  47 number of bytes actually taken care of. If that amount differs from the amount
  48 passed in to your function, it'll signal an error to the library. This will
  49 cause the transfer to get aborted and the libcurl function in progress will
  50 return \fICURLE_WRITE_ERROR\fP.
  51
  52 A complete HTTP header that is passed to this function can be up to
  53 \fICURL_MAX_HTTP_HEADER\fP (100K) bytes.
  54
  55 If this option is not set, or if it is set to NULL, but
  56 \fICURLOPT_HEADERDATA(3)\fP is set to anything but NULL, the function used to
  57 accept response data will be used instead. That is, it will be the function
  58 specified with \fICURLOPT_WRITEFUNCTION(3)\fP, or if it is not specified or
  59 NULL - the default, stream-writing function.
  60
  61 It's important to note that the callback will be invoked for the headers of
  62 all responses received after initiating a request and not just the final
  63 response. This includes all responses which occur during authentication
  64 negotiation. If you need to operate on only the headers from the final
  65 response, you will need to collect headers in the callback yourself and use
  66 HTTP status lines, for example, to delimit response boundaries.
  67
  68 When a server sends a chunked encoded transfer, it may contain a trailer. That
  69 trailer is identical to a HTTP header and if such a trailer is received it is
  70 passed to the application using this callback as well. There are several ways
  71 to detect it being a trailer and not an ordinary header: 1) it comes after the
  72 response-body. 2) it comes after the final header line (CR LF) 3) a Trailer:
  73 header among the regular response-headers mention what header(s) to expect in
  74 the trailer.
  75
  76 For non-HTTP protocols like FTP, POP3, IMAP and SMTP this function will get
  77 called with the server responses to the commands that libcurl sends.
  78 .SH LIMITATIONS
  79 libcurl does not unfold HTTP "folded headers" (deprecated since RFC 7230). A
  80 folded header is a header that continues on a subsequent line and starts with
  81 a whitespace. Such folds will be passed to the header callback as a separate
  82 one, although strictly it is just a continuation of the previous line.
  83 .SH DEFAULT
  84 Nothing.
  85 .SH PROTOCOLS
  86 Used for all protocols with headers or meta-data concept: HTTP, FTP, POP3,
  87 IMAP, SMTP and more.
  88 .SH EXAMPLE
  89 .nf
  90 static size_t header_callback(char *buffer, size_t size,
  91                               size_t nitems, void *userdata)
  92 {
  93   /* received header is nitems * size long in 'buffer' NOT ZERO TERMINATED */
  94   /* 'userdata' is set with CURLOPT_HEADERDATA */
  95   return nitems * size;
  96 }
  97
  98 CURL *curl = curl_easy_init();
  99 if(curl) {
 100   curl_easy_setopt(curl, CURLOPT_URL, "http://example.com");
 101
 102   curl_easy_setopt(curl, CURLOPT_HEADERFUNCTION, header_callback);
 103
 104   curl_easy_perform(curl);
 105 }
 106 .fi
 107 .SH AVAILABILITY
 108 Always
 109 .SH RETURN VALUE
 110 Returns CURLE_OK
 111 .SH "SEE ALSO"
 112 .BR CURLOPT_HEADERDATA "(3), " CURLOPT_WRITEFUNCTION "(3), "