mirror of
https://github.com/curl/curl.git
synced 2025-01-12 13:55:11 +08:00
d7b6ce64ce
This clarifies the handling of server responses by folding the code for
the complicated protocols into their protocol handlers. This concerns
mainly HTTP and its bastard sibling RTSP.
The terms "read" and "write" are often used without clear context if
they refer to the connect or the client/application side of a
transfer. This PR uses "read/write" for operations on the client side
and "send/receive" for the connection, e.g. server side. If this is
considered useful, we can revisit renaming of further methods in another
PR.
Curl's protocol handler `readwrite()` method been changed:
```diff
- CURLcode (*readwrite)(struct Curl_easy *data, struct connectdata *conn,
- const char *buf, size_t blen,
- size_t *pconsumed, bool *readmore);
+ CURLcode (*write_resp)(struct Curl_easy *data, const char *buf, size_t blen,
+ bool is_eos, bool *done);
```
The name was changed to clarify that this writes reponse data to the
client side. The parameter changes are:
* `conn` removed as it always operates on `data->conn`
* `pconsumed` removed as the method needs to handle all data on success
* `readmore` removed as no longer necessary
* `is_eos` as indicator that this is the last call for the transfer
response (end-of-stream).
* `done` TRUE on return iff the transfer response is to be treated as
finished
This change affects many files only because of updated comments in
handlers that provide no implementation. The real change is that the
HTTP protocol handlers now provide an implementation.
The HTTP protocol handlers `write_resp()` implementation will get passed
**all** raw data of a server response for the transfer. The HTTP/1.x
formatted status and headers, as well as the undecoded response
body. `Curl_http_write_resp_hds()` is used internally to parse the
response headers and pass them on. This method is public as the RTSP
protocol handler also uses it.
HTTP/1.1 "chunked" transport encoding is now part of the general
*content encoding* writer stack, just like other encodings. A new flag
`CLIENTWRITE_EOS` was added for the last client write. This allows
writers to verify that they are in a valid end state. The chunked
decoder will check if it indeed has seen the last chunk.
The general response handling in `transfer.c:466` happens in function
`readwrite_data()`. This mainly operates now like:
```
static CURLcode readwrite_data(data, ...)
{
do {
Curl_xfer_recv_resp(data, buf)
...
Curl_xfer_write_resp(data, buf)
...
} while(interested);
...
}
```
All the response data handling is implemented in
`Curl_xfer_write_resp()`. It calls the protocol handler's `write_resp()`
implementation if available, or does the default behaviour.
All raw response data needs to pass through this function. Which also
means that anyone in possession of such data may call
`Curl_xfer_write_resp()`.
Closes #12480
89 lines
3.8 KiB
C
89 lines
3.8 KiB
C
#ifndef HEADER_CURL_TRANSFER_H
|
|
#define HEADER_CURL_TRANSFER_H
|
|
/***************************************************************************
|
|
* _ _ ____ _
|
|
* Project ___| | | | _ \| |
|
|
* / __| | | | |_) | |
|
|
* | (__| |_| | _ <| |___
|
|
* \___|\___/|_| \_\_____|
|
|
*
|
|
* Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
|
|
*
|
|
* This software is licensed as described in the file COPYING, which
|
|
* you should have received as part of this distribution. The terms
|
|
* are also available at https://curl.se/docs/copyright.html.
|
|
*
|
|
* You may opt to use, copy, modify, merge, publish, distribute and/or sell
|
|
* copies of the Software, and permit persons to whom the Software is
|
|
* furnished to do so, under the terms of the COPYING file.
|
|
*
|
|
* This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
|
|
* KIND, either express or implied.
|
|
*
|
|
* SPDX-License-Identifier: curl
|
|
*
|
|
***************************************************************************/
|
|
|
|
#define Curl_headersep(x) ((((x)==':') || ((x)==';')))
|
|
char *Curl_checkheaders(const struct Curl_easy *data,
|
|
const char *thisheader,
|
|
const size_t thislen);
|
|
|
|
void Curl_init_CONNECT(struct Curl_easy *data);
|
|
|
|
CURLcode Curl_pretransfer(struct Curl_easy *data);
|
|
CURLcode Curl_posttransfer(struct Curl_easy *data);
|
|
|
|
typedef enum {
|
|
FOLLOW_NONE, /* not used within the function, just a placeholder to
|
|
allow initing to this */
|
|
FOLLOW_FAKE, /* only records stuff, not actually following */
|
|
FOLLOW_RETRY, /* set if this is a request retry as opposed to a real
|
|
redirect following */
|
|
FOLLOW_REDIR /* a full true redirect */
|
|
} followtype;
|
|
|
|
CURLcode Curl_follow(struct Curl_easy *data, char *newurl,
|
|
followtype type);
|
|
CURLcode Curl_readwrite(struct Curl_easy *data, bool *done);
|
|
int Curl_single_getsock(struct Curl_easy *data,
|
|
struct connectdata *conn, curl_socket_t *socks);
|
|
CURLcode Curl_fillreadbuffer(struct Curl_easy *data, size_t bytes,
|
|
size_t *nreadp);
|
|
CURLcode Curl_retry_request(struct Curl_easy *data, char **url);
|
|
bool Curl_meets_timecondition(struct Curl_easy *data, time_t timeofdoc);
|
|
CURLcode Curl_get_upload_buffer(struct Curl_easy *data);
|
|
|
|
CURLcode Curl_done_sending(struct Curl_easy *data,
|
|
struct SingleRequest *k);
|
|
|
|
/**
|
|
* Write the transfer raw response bytes, as received from the connection.
|
|
* Will handle all passed bytes or return an error. By default, this will
|
|
* write the bytes as BODY to the client. Protocols may provide a
|
|
* "write_resp" callback in their handler to add specific treatment. E.g.
|
|
* HTTP parses response headers and passes them differently to the client.
|
|
* @param data the transfer
|
|
* @param buf the raw response bytes
|
|
* @param blen the amount of bytes in `buf`
|
|
* @param is_eos TRUE iff the connection indicates this to be the last
|
|
* bytes of the response
|
|
* @param done on returnm, TRUE iff the response is complete
|
|
*/
|
|
CURLcode Curl_xfer_write_resp(struct Curl_easy *data,
|
|
char *buf, size_t blen,
|
|
bool is_eos, bool *done);
|
|
|
|
/* This sets up a forthcoming transfer */
|
|
void
|
|
Curl_setup_transfer (struct Curl_easy *data,
|
|
int sockindex, /* socket index to read from or -1 */
|
|
curl_off_t size, /* -1 if unknown at this point */
|
|
bool getheader, /* TRUE if header parsing is wanted */
|
|
int writesockindex /* socket index to write to. May be
|
|
the same we read from. -1
|
|
disables */
|
|
);
|
|
|
|
#endif /* HEADER_CURL_TRANSFER_H */
|