/src/curl/lib/connect.h

Source
#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_peer;
struct Curl_str;

enum alpnid Curl_alpn2alpnid(const unsigned char *name, size_t len);

/* 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 connectdata *conn, 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);

/*
 * Curl_conncontrol() manipulates the `conn->bits.close` bit on
 * a connection:
 * - CONNCTRL_CONN_KEEP: clear the bit
 * - CONNCTRL_CONN_CLOSE: set the bit
 * - CONNCTRL_STREAM_CLOSE: set the bit when the connection is not
 *                          multiplexed
 * The call does *NOT* cause any immediate connection close.
 */
#define CONNCTRL_CONN_KEEP       0
#define CONNCTRL_CONN_CLOSE      1
#define CONNCTRL_STREAM_CLOSE    2

void Curl_conncontrol(struct connectdata *conn, int ctrl);

#define streamclose(x) Curl_conncontrol((x), CONNCTRL_STREAM_CLOSE)
#define connclose(x)   Curl_conncontrol((x), CONNCTRL_CONN_CLOSE)
#define connkeep(x)    Curl_conncontrol((x), CONNCTRL_CONN_KEEP)

/**
 * 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,
                         int ssl_mode);

/**
 * Bring the filter chain at `sockindex` for connection `data->conn` into
 * connected state. Which will set `*done` to TRUE.
 * This can be called on an already connected chain with no side effects.
 * When not `blocking`, calls may return without error and `*done != TRUE`,
 * while the individual filters negotiated the connection.
 */
CURLcode Curl_conn_connect(struct Curl_easy *data, int sockindex,
                           bool blocking, bool *done);

/* Set conn to allow multiplexing. */
void Curl_conn_set_multiplex(struct connectdata *conn);

/* Get the origin peer at sockindex. */
struct Curl_peer *Curl_conn_get_origin(struct connectdata *conn,
                                       int sockindex);

/* Get the peer the connection actually connects to at sockindex.
 * Often the same as "origin", but can be redirected via "connect-to"
 * or "alt-svc". May tunnel through proxies. */
struct Curl_peer *Curl_conn_get_destination(struct connectdata *conn,
                                            int sockindex);

/* Get the peer curl connects its socket to.
 * Can be origin, "connect-to" or the first proxy. */
struct Curl_peer *Curl_conn_get_first_peer(struct connectdata *conn,
                                           int sockindex);

#endif /* HEADER_CURL_CONNECT_H */

Line	Count	Source
1		#ifndef HEADER_CURL_CONNECT_H
2		#define HEADER_CURL_CONNECT_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 "curl_setup.h"
27
28		#include "hostip.h"
29		#include "curlx/timeval.h"
30
31		struct Curl_peer;
32		struct Curl_str;
33
34		enum alpnid Curl_alpn2alpnid(const unsigned char *name, size_t len);
35
36		/* generic function that returns how much time there is left to run, according
37		to the timeouts set */
38		timediff_t Curl_timeleft_ms(struct Curl_easy *data);
39
40	0	#define DEFAULT_CONNECT_TIMEOUT 300000 /* milliseconds == five minutes */
41
42	0	#define DEFAULT_SHUTDOWN_TIMEOUT_MS (2 * 1000)
43
44		void Curl_shutdown_start(struct Curl_easy *data, int sockindex,
45		int timeout_ms);
46
47		/* return how much time there is left to shutdown the connection at
48		* sockindex. Returns 0 if there is no limit or shutdown has not started. */
49		timediff_t Curl_shutdown_timeleft(struct Curl_easy *data,
50		struct connectdata *conn,
51		int sockindex);
52
53		/* return how much time there is left to shutdown the connection.
54		* Returns 0 if there is no limit or shutdown has not started. */
55		timediff_t Curl_conn_shutdown_timeleft(struct Curl_easy *data,
56		struct connectdata *conn);
57
58		void Curl_shutdown_clear(struct Curl_easy *data, int sockindex);
59
60		/* TRUE iff shutdown has been started */
61		bool Curl_shutdown_started(struct connectdata *conn, int sockindex);
62
63		/*
64		* Used to extract socket and connectdata struct for the most recent
65		* transfer on the given Curl_easy.
66		*
67		* The returned socket will be CURL_SOCKET_BAD in case of failure!
68		*/
69		curl_socket_t Curl_getconnectinfo(struct Curl_easy *data,
70		struct connectdata **connp);
71
72		/*
73		* Curl_conncontrol() manipulates the `conn->bits.close` bit on
74		* a connection:
75		* - CONNCTRL_CONN_KEEP: clear the bit
76		* - CONNCTRL_CONN_CLOSE: set the bit
77		* - CONNCTRL_STREAM_CLOSE: set the bit when the connection is not
78		* multiplexed
79		* The call does NOT cause any immediate connection close.
80		*/
81	0	#define CONNCTRL_CONN_KEEP 0
82	0	#define CONNCTRL_CONN_CLOSE 1
83	0	#define CONNCTRL_STREAM_CLOSE 2
84
85		void Curl_conncontrol(struct connectdata *conn, int ctrl);
86
87	0	#define streamclose(x) Curl_conncontrol((x), CONNCTRL_STREAM_CLOSE)
88	0	#define connclose(x) Curl_conncontrol((x), CONNCTRL_CONN_CLOSE)
89	0	#define connkeep(x) Curl_conncontrol((x), CONNCTRL_CONN_KEEP)
90
91		/**
92		* Setup the cfilters at `sockindex` in connection `conn`.
93		* If no filter chain is installed yet, inspects the configuration
94		* in `data` and `conn` to install a suitable filter chain.
95		*/
96		CURLcode Curl_conn_setup(struct Curl_easy *data,
97		struct connectdata *conn,
98		int sockindex,
99		int ssl_mode);
100
101		/**
102		* Bring the filter chain at `sockindex` for connection `data->conn` into
103		* connected state. Which will set `*done` to TRUE.
104		* This can be called on an already connected chain with no side effects.
105		* When not `blocking`, calls may return without error and `*done != TRUE`,
106		* while the individual filters negotiated the connection.
107		*/
108		CURLcode Curl_conn_connect(struct Curl_easy *data, int sockindex,
109		bool blocking, bool *done);
110
111		/* Set conn to allow multiplexing. */
112		void Curl_conn_set_multiplex(struct connectdata *conn);
113
114		/* Get the origin peer at sockindex. */
115		struct Curl_peer Curl_conn_get_origin(struct connectdata conn,
116		int sockindex);
117
118		/* Get the peer the connection actually connects to at sockindex.
119		* Often the same as "origin", but can be redirected via "connect-to"
120		* or "alt-svc". May tunnel through proxies. */
121		struct Curl_peer Curl_conn_get_destination(struct connectdata conn,
122		int sockindex);
123
124		/* Get the peer curl connects its socket to.
125		* Can be origin, "connect-to" or the first proxy. */
126		struct Curl_peer Curl_conn_get_first_peer(struct connectdata conn,
127		int sockindex);
128
129		#endif /* HEADER_CURL_CONNECT_H */

Coverage Report

Created: 2026-07-30 07:03