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