xref: /curl/src/tool_cb_hdr.h (revision 2bc1d775)
1 #ifndef HEADER_CURL_TOOL_CB_HDR_H
2 #define HEADER_CURL_TOOL_CB_HDR_H
3 /***************************************************************************
4  *                                  _   _ ____  _
5  *  Project                     ___| | | |  _ \| |
6  *                             / __| | | | |_) | |
7  *                            | (__| |_| |  _ <| |___
8  *                             \___|\___/|_| \_\_____|
9  *
10  * Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
11  *
12  * This software is licensed as described in the file COPYING, which
13  * you should have received as part of this distribution. The terms
14  * are also available at https://curl.se/docs/copyright.html.
15  *
16  * You may opt to use, copy, modify, merge, publish, distribute and/or sell
17  * copies of the Software, and permit persons to whom the Software is
18  * furnished to do so, under the terms of the COPYING file.
19  *
20  * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
21  * KIND, either express or implied.
22  *
23  * SPDX-License-Identifier: curl
24  *
25  ***************************************************************************/
26 #include "tool_setup.h"
27 
28 /*
29  * curl operates using a single HdrCbData struct variable, a
30  * pointer to this is passed as userdata pointer to tool_header_cb.
31  *
32  * 'outs' member is a pointer to the OutStruct variable used to keep
33  * track of information relative to curl's output writing.
34  *
35  * 'heads' member is a pointer to the OutStruct variable used to keep
36  * track of information relative to header response writing.
37  *
38  * 'honor_cd_filename' member is TRUE when tool_header_cb is allowed
39  * to honor Content-Disposition filename property and accordingly
40  * set 'outs' filename, otherwise FALSE;
41  */
42 
43 struct HdrCbData {
44   struct GlobalConfig *global;
45   struct OperationConfig *config;
46   struct OutStruct *outs;
47   struct OutStruct *heads;
48   struct OutStruct *etag_save;
49   bool honor_cd_filename;
50 };
51 
52 /*
53 ** callback for CURLOPT_HEADERFUNCTION
54 */
55 
56 size_t tool_header_cb(char *ptr, size_t size, size_t nmemb, void *userdata);
57 
58 #endif /* HEADER_CURL_TOOL_CB_HDR_H */
59