xref: /curl/lib/transfer.h (revision 8dd81bd5)
1 #ifndef HEADER_CURL_TRANSFER_H
2 #define HEADER_CURL_TRANSFER_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 
27 #define Curl_headersep(x) ((((x)==':') || ((x)==';')))
28 char *Curl_checkheaders(const struct Curl_easy *data,
29                         const char *thisheader,
30                         const size_t thislen);
31 
32 void Curl_init_CONNECT(struct Curl_easy *data);
33 
34 CURLcode Curl_pretransfer(struct Curl_easy *data);
35 CURLcode Curl_posttransfer(struct Curl_easy *data);
36 
37 typedef enum {
38   FOLLOW_NONE,  /* not used within the function, just a placeholder to
39                    allow initing to this */
40   FOLLOW_FAKE,  /* only records stuff, not actually following */
41   FOLLOW_RETRY, /* set if this is a request retry as opposed to a real
42                    redirect following */
43   FOLLOW_REDIR /* a full true redirect */
44 } followtype;
45 
46 CURLcode Curl_follow(struct Curl_easy *data, char *newurl,
47                      followtype type);
48 CURLcode Curl_readwrite(struct Curl_easy *data);
49 int Curl_single_getsock(struct Curl_easy *data,
50                         struct connectdata *conn, curl_socket_t *socks);
51 CURLcode Curl_retry_request(struct Curl_easy *data, char **url);
52 bool Curl_meets_timecondition(struct Curl_easy *data, time_t timeofdoc);
53 
54 /**
55  * Write the transfer raw response bytes, as received from the connection.
56  * Will handle all passed bytes or return an error. By default, this will
57  * write the bytes as BODY to the client. Protocols may provide a
58  * "write_resp" callback in their handler to add specific treatment. E.g.
59  * HTTP parses response headers and passes them differently to the client.
60  * @param data     the transfer
61  * @param buf      the raw response bytes
62  * @param blen     the amount of bytes in `buf`
63  * @param is_eos   TRUE iff the connection indicates this to be the last
64  *                 bytes of the response
65  */
66 CURLcode Curl_xfer_write_resp(struct Curl_easy *data,
67                               const char *buf, size_t blen,
68                               bool is_eos);
69 
70 /**
71  * Write a single "header" line from a server response.
72  * @param hd0      the 0-terminated, single header line
73  * @param hdlen    the length of the header line
74  * @param is_eos   TRUE iff this is the end of the response
75  */
76 CURLcode Curl_xfer_write_resp_hd(struct Curl_easy *data,
77                                  const char *hd0, size_t hdlen, bool is_eos);
78 
79 /* This sets up a forthcoming transfer */
80 void Curl_xfer_setup(struct Curl_easy *data,
81                      int sockindex,     /* socket index to read from or -1 */
82                      curl_off_t size,   /* -1 if unknown at this point */
83                      bool getheader,    /* TRUE if header parsing is wanted */
84                      int writesockindex /* socket index to write to. May be
85                                            the same we read from. -1
86                                            disables */
87   );
88 
89 /**
90  * Multi has set transfer to DONE. Last chance to trigger
91  * missing response things like writing an EOS to the client.
92  */
93 CURLcode Curl_xfer_write_done(struct Curl_easy *data, bool premature);
94 
95 /**
96  * Send data on the socket/connection filter designated
97  * for transfer's outgoing data.
98  * Will return CURLE_OK on blocking with (*pnwritten == 0).
99  */
100 CURLcode Curl_xfer_send(struct Curl_easy *data,
101                         const void *buf, size_t blen,
102                         size_t *pnwritten);
103 
104 /**
105  * Receive data on the socket/connection filter designated
106  * for transfer's incoming data.
107  * Will return CURLE_AGAIN on blocking with (*pnrcvd == 0).
108  */
109 CURLcode Curl_xfer_recv(struct Curl_easy *data,
110                         char *buf, size_t blen,
111                         ssize_t *pnrcvd);
112 
113 CURLcode Curl_xfer_send_close(struct Curl_easy *data);
114 
115 #endif /* HEADER_CURL_TRANSFER_H */
116