mirror of
https://github.com/curl/curl.git
synced 2026-04-20 03:51:15 +03:00
7fd35f4c34
- make sure all UNITTEST prototypes mark in which unit test they are used, with "@unittest" markup - make sure all UNITTEST functions do not use Curl_ prefix, as that is a prefix we use for global private functions and these functions are static and therefore not global and the prefix is wrong - drop UNITTEST for functions not used in unit tests - make the extract-unit-protos script highlight the above issues if found - extract-unit-protos now also outputs the unit test number for all the generated protos in lib/unitprotos.h to aid readers. It also adds the source file and line number where the proto originates from. - extract-unit-protos now exits with a non-zero value if any of the above warnings are triggered - cf-dns: Curl_cf_dns_result => static cf_dns_result - hostip: Curl_ipv6works => static ipv6works - url: remove Curl_setup_conn() - not used anymore - connect: Curl_timeleft_now_ms => UNITTEST timeleft_now_ms Closes #21330
140 lines
5.1 KiB
C
140 lines
5.1 KiB
C
#ifndef HEADER_CURL_CONNECT_H
|
|
#define HEADER_CURL_CONNECT_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
|
|
*
|
|
***************************************************************************/
|
|
#include "curl_setup.h"
|
|
|
|
#include "hostip.h"
|
|
#include "curlx/timeval.h"
|
|
|
|
struct Curl_dns_entry;
|
|
struct ip_quadruple;
|
|
struct Curl_str;
|
|
|
|
enum alpnid Curl_alpn2alpnid(const unsigned char *name, size_t len);
|
|
enum alpnid Curl_str2alpnid(const struct Curl_str *cstr);
|
|
|
|
/* generic function that returns how much time there is left to run, according
|
|
to the timeouts set */
|
|
timediff_t Curl_timeleft_ms(struct Curl_easy *data);
|
|
|
|
#define DEFAULT_CONNECT_TIMEOUT 300000 /* milliseconds == five minutes */
|
|
|
|
#define DEFAULT_SHUTDOWN_TIMEOUT_MS (2 * 1000)
|
|
|
|
void Curl_shutdown_start(struct Curl_easy *data, int sockindex,
|
|
int timeout_ms);
|
|
|
|
/* return how much time there is left to shutdown the connection at
|
|
* sockindex. Returns 0 if there is no limit or shutdown has not started. */
|
|
timediff_t Curl_shutdown_timeleft(struct Curl_easy *data,
|
|
struct connectdata *conn,
|
|
int sockindex);
|
|
|
|
/* return how much time there is left to shutdown the connection.
|
|
* Returns 0 if there is no limit or shutdown has not started. */
|
|
timediff_t Curl_conn_shutdown_timeleft(struct Curl_easy *data,
|
|
struct connectdata *conn);
|
|
|
|
void Curl_shutdown_clear(struct Curl_easy *data, int sockindex);
|
|
|
|
/* TRUE iff shutdown has been started */
|
|
bool Curl_shutdown_started(struct Curl_easy *data, int sockindex);
|
|
|
|
/*
|
|
* Used to extract socket and connectdata struct for the most recent
|
|
* transfer on the given Curl_easy.
|
|
*
|
|
* The returned socket will be CURL_SOCKET_BAD in case of failure!
|
|
*/
|
|
curl_socket_t Curl_getconnectinfo(struct Curl_easy *data,
|
|
struct connectdata **connp);
|
|
|
|
bool Curl_addr2string(struct sockaddr *sa, curl_socklen_t salen,
|
|
char *addr, uint16_t *port);
|
|
|
|
/*
|
|
* Curl_conncontrol() marks the end of a connection/stream. The 'ctrl'
|
|
* argument specifies if it is the end of a connection or a stream.
|
|
*
|
|
* For stream-based protocols (such as HTTP/2), a stream close will not cause
|
|
* a connection close. Other protocols will close the connection for both
|
|
* cases.
|
|
*
|
|
* It sets the bit.close bit to TRUE (with an explanation for debug builds),
|
|
* when the connection will close.
|
|
*/
|
|
|
|
#define CONNCTRL_KEEP 0 /* undo a marked closure */
|
|
#define CONNCTRL_CONNECTION 1
|
|
#define CONNCTRL_STREAM 2
|
|
|
|
void Curl_conncontrol(struct connectdata *conn,
|
|
int ctrl
|
|
#if defined(DEBUGBUILD) && defined(CURLVERBOSE)
|
|
, const char *reason
|
|
#endif
|
|
);
|
|
|
|
#if defined(DEBUGBUILD) && defined(CURLVERBOSE)
|
|
#define streamclose(x, y) Curl_conncontrol(x, CONNCTRL_STREAM, y)
|
|
#define connclose(x, y) Curl_conncontrol(x, CONNCTRL_CONNECTION, y)
|
|
#define connkeep(x, y) Curl_conncontrol(x, CONNCTRL_KEEP, y)
|
|
#else /* !DEBUGBUILD || !CURLVERBOSE */
|
|
#define streamclose(x, y) Curl_conncontrol(x, CONNCTRL_STREAM)
|
|
#define connclose(x, y) Curl_conncontrol(x, CONNCTRL_CONNECTION)
|
|
#define connkeep(x, y) Curl_conncontrol(x, CONNCTRL_KEEP)
|
|
#endif
|
|
|
|
CURLcode Curl_cf_setup_insert_after(struct Curl_cfilter *cf_at,
|
|
struct Curl_easy *data,
|
|
uint8_t transport,
|
|
int ssl_mode);
|
|
|
|
/**
|
|
* Setup the cfilters at `sockindex` in connection `conn`.
|
|
* If no filter chain is installed yet, inspects the configuration
|
|
* in `data` and `conn? to install a suitable filter chain.
|
|
*/
|
|
CURLcode Curl_conn_setup(struct Curl_easy *data,
|
|
struct connectdata *conn,
|
|
int sockindex,
|
|
struct Curl_dns_entry *dns,
|
|
int ssl_mode);
|
|
|
|
/* Set conn to allow multiplexing. */
|
|
void Curl_conn_set_multiplex(struct connectdata *conn);
|
|
|
|
#ifdef USE_UNIX_SOCKETS
|
|
#ifndef CURL_DISABLE_PROXY
|
|
#define UNIX_SOCKET_PREFIX "localhost"
|
|
#endif
|
|
const char *Curl_conn_get_unix_path(struct connectdata *conn);
|
|
#else
|
|
#define Curl_conn_get_unix_path(c) NULL
|
|
#endif
|
|
|
|
extern struct Curl_cftype Curl_cft_setup;
|
|
|
|
#endif /* HEADER_CURL_CONNECT_H */
|