moparisthebest/curl
1
0
Fork 0
mirror of https://github.com/moparisthebest/curl synced 2024-11-16 06:25:03 -05:00
Code Issues Releases Wiki Activity

CURLOPT_HEADER.3: clarify problems with different data sizes

Browse Source
This commit is contained in:
Daniel Stenberg 2018-02-16 11:23:12 +01:00
parent 70cbb92134
commit 174212972c
No known key found for this signature in database
GPG Key ID: 5CC908FDB71E12C2
1 changed files with 12 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
docs/libcurl/opts/CURLOPT_HEADER.3
View File

@ -5,7 +5,7 @@
.\" * | (__| |_| | _ <| |___ .\" * | (__| |_| | _ <| |___
.\" * \___|\___/|_| \_\_____| .\" * \___|\___/|_| \_\_____|
.\" * .\" *
.\" * Copyright (C) 1998 - 2015, Daniel Stenberg, <daniel@haxx.se>, et al. .\" * Copyright (C) 1998 - 2018, Daniel Stenberg, <daniel@haxx.se>, et al.
.\" * .\" *
.\" * This software is licensed as described in the file COPYING, which .\" * This software is licensed as described in the file COPYING, which
.\" * you should have received as part of this distribution. The terms .\" * you should have received as part of this distribution. The terms
@ -28,14 +28,20 @@ CURLOPT_HEADER \- pass headers to the data stream
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_HEADER, long onoff); CURLcode curl_easy_setopt(CURL *handle, CURLOPT_HEADER, long onoff);
.SH DESCRIPTION .SH DESCRIPTION
Pass in \fIonoff\fP set to 1 to tell the library to include the header in the Pass the long value \fIonoff\fP set to 1 to ask libcurl to include the headers
body output for requests with this \fIhandle\fP. This option is relevant for in the write callback (\fICURLOPT_WRITEFUNCTION(3)\fP). This option is
protocols that actually have headers or other meta-data (like HTTP and FTP). relevant for protocols that actually have headers or other meta-data (like
HTTP and FTP).
When asking to get the header info passed to the same callback as the body, it When asking to get the headers passed to the same callback as the body, it is
is not possible to accurately separate them again without detailed knowledge not possible to accurately separate them again without detailed knowledge
about the protocol in use. about the protocol in use.
Further: the \fCURLOPT_WRITEFUNCTION(3)\fP callback is limited to only ever
get a maximum of \fICURL_MAX_WRITE_SIZE\fP bytes passed to it (16KB), while a
header can be longer and the \fICURLOPT_HEADERFUNCTION(3)\fP supports getting
called with headers up to \fICURL_MAX_HTTP_HEADER\fP bytes big (100KB).
It is often better to use \fICURLOPT_HEADERFUNCTION(3)\fP to get the header It is often better to use \fICURLOPT_HEADERFUNCTION(3)\fP to get the header
data separately. data separately.