150 lines
5.7 KiB
C
150 lines
5.7 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_sendrecv(struct Curl_easy *data, struct curltime *nowp);
|
|
CURLcode Curl_retry_request(struct Curl_easy *data, char **url);
|
|
bool Curl_meets_timecondition(struct Curl_easy *data, time_t timeofdoc);
|
|
|
|
/**
|
|
* 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
|
|
*/
|
|
CURLcode Curl_xfer_write_resp(struct Curl_easy *data,
|
|
const char *buf, size_t blen,
|
|
bool is_eos);
|
|
|
|
bool Curl_xfer_write_is_paused(struct Curl_easy *data);
|
|
|
|
/**
|
|
* Write a single "header" line from a server response.
|
|
* @param hd0 the null-terminated, single header line
|
|
* @param hdlen the length of the header line
|
|
* @param is_eos TRUE iff this is the end of the response
|
|
*/
|
|
CURLcode Curl_xfer_write_resp_hd(struct Curl_easy *data,
|
|
const char *hd0, size_t hdlen, bool is_eos);
|
|
|
|
/* The transfer is neither receiving nor sending. */
|
|
void Curl_xfer_setup_nop(struct Curl_easy *data);
|
|
|
|
/* The transfer sends data on the given socket index */
|
|
void Curl_xfer_setup_send(struct Curl_easy *data,
|
|
int sockindex);
|
|
|
|
/* The transfer receives data on the given socket index, the
|
|
* amount to receive (or -1 if unknown). */
|
|
void Curl_xfer_setup_recv(struct Curl_easy *data,
|
|
int sockindex,
|
|
curl_off_t recv_size);
|
|
|
|
/* *After* Curl_xfer_setup_xxx(), tell the transfer to shutdown the
|
|
* connection at the end. Let the transfer either fail or ignore any
|
|
* errors during shutdown. */
|
|
void Curl_xfer_set_shutdown(struct Curl_easy *data,
|
|
bool shutdown,
|
|
bool ignore_errors);
|
|
|
|
/**
|
|
* The transfer will use socket 1 to send/recv. `recv_size` is
|
|
* the amount to receive or -1 if unknown.
|
|
*/
|
|
void Curl_xfer_setup_sendrecv(struct Curl_easy *data,
|
|
int sockindex,
|
|
curl_off_t recv_size);
|
|
|
|
/**
|
|
* Multi has set transfer to DONE. Last chance to trigger
|
|
* missing response things like writing an EOS to the client.
|
|
*/
|
|
CURLcode Curl_xfer_write_done(struct Curl_easy *data, bool premature);
|
|
|
|
/**
|
|
* Return TRUE iff transfer has pending data to send. Checks involved
|
|
* connection filters.
|
|
*/
|
|
bool Curl_xfer_needs_flush(struct Curl_easy *data);
|
|
|
|
/**
|
|
* Flush any pending send data on the transfer connection.
|
|
*/
|
|
CURLcode Curl_xfer_flush(struct Curl_easy *data);
|
|
|
|
/**
|
|
* Send data on the socket/connection filter designated
|
|
* for transfer's outgoing data.
|
|
* Will return CURLE_OK on blocking with (*pnwritten == 0).
|
|
*/
|
|
CURLcode Curl_xfer_send(struct Curl_easy *data,
|
|
const void *buf, size_t blen, bool eos,
|
|
size_t *pnwritten);
|
|
|
|
/**
|
|
* Receive data on the socket/connection filter designated
|
|
* for transfer's incoming data.
|
|
* Will return CURLE_AGAIN on blocking with (*pnrcvd == 0).
|
|
*/
|
|
CURLcode Curl_xfer_recv(struct Curl_easy *data,
|
|
char *buf, size_t blen,
|
|
size_t *pnrcvd);
|
|
|
|
CURLcode Curl_xfer_send_close(struct Curl_easy *data);
|
|
CURLcode Curl_xfer_send_shutdown(struct Curl_easy *data, bool *done);
|
|
|
|
/* Return TRUE if the transfer is not done, but further progress
|
|
* is blocked. For example when it is only receiving and its writer
|
|
* is PAUSED. */
|
|
bool Curl_xfer_is_blocked(struct Curl_easy *data);
|
|
|
|
/* Query if send/recv for transfer is paused. */
|
|
bool Curl_xfer_send_is_paused(struct Curl_easy *data);
|
|
bool Curl_xfer_recv_is_paused(struct Curl_easy *data);
|
|
|
|
/* Enable/Disable pausing of send/recv for the transfer. */
|
|
CURLcode Curl_xfer_pause_send(struct Curl_easy *data, bool enable);
|
|
CURLcode Curl_xfer_pause_recv(struct Curl_easy *data, bool enable);
|
|
|
|
/* Query if transfer has expire timeout TOOFAST set. */
|
|
bool Curl_xfer_is_too_fast(struct Curl_easy *data);
|
|
|
|
#endif /* HEADER_CURL_TRANSFER_H */
|