connect.h (5963B)
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 "curlx/nonblock.h" /* for curlx_nonblock() */ 29 #include "sockaddr.h" 30 #include "curlx/timeval.h" 31 32 struct Curl_dns_entry; 33 struct ip_quadruple; 34 35 enum alpnid Curl_alpn2alpnid(const char *name, size_t len); 36 37 /* generic function that returns how much time there is left to run, according 38 to the timeouts set */ 39 timediff_t Curl_timeleft(struct Curl_easy *data, 40 struct curltime *nowp, 41 bool duringconnect); 42 43 #define DEFAULT_CONNECT_TIMEOUT 300000 /* milliseconds == five minutes */ 44 45 #define DEFAULT_SHUTDOWN_TIMEOUT_MS (2 * 1000) 46 47 void Curl_shutdown_start(struct Curl_easy *data, int sockindex, 48 int timeout_ms, struct curltime *nowp); 49 50 /* return how much time there is left to shutdown the connection at 51 * sockindex. Returns 0 if there is no limit or shutdown has not started. */ 52 timediff_t Curl_shutdown_timeleft(struct connectdata *conn, int sockindex, 53 struct curltime *nowp); 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 connectdata *conn, 58 struct curltime *nowp); 59 60 void Curl_shutdown_clear(struct Curl_easy *data, int sockindex); 61 62 /* TRUE iff shutdown has been started */ 63 bool Curl_shutdown_started(struct Curl_easy *data, int 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 bool Curl_addr2string(struct sockaddr *sa, curl_socklen_t salen, 75 char *addr, int *port); 76 77 /* 78 * Curl_conncontrol() marks the end of a connection/stream. The 'closeit' 79 * argument specifies if it is the end of a connection or a stream. 80 * 81 * For stream-based protocols (such as HTTP/2), a stream close will not cause 82 * a connection close. Other protocols will close the connection for both 83 * cases. 84 * 85 * It sets the bit.close bit to TRUE (with an explanation for debug builds), 86 * when the connection will close. 87 */ 88 89 #define CONNCTRL_KEEP 0 /* undo a marked closure */ 90 #define CONNCTRL_CONNECTION 1 91 #define CONNCTRL_STREAM 2 92 93 void Curl_conncontrol(struct connectdata *conn, 94 int closeit 95 #if defined(DEBUGBUILD) && !defined(CURL_DISABLE_VERBOSE_STRINGS) 96 , const char *reason 97 #endif 98 ); 99 100 #if defined(DEBUGBUILD) && !defined(CURL_DISABLE_VERBOSE_STRINGS) 101 #define streamclose(x,y) Curl_conncontrol(x, CONNCTRL_STREAM, y) 102 #define connclose(x,y) Curl_conncontrol(x, CONNCTRL_CONNECTION, y) 103 #define connkeep(x,y) Curl_conncontrol(x, CONNCTRL_KEEP, y) 104 #else /* if !DEBUGBUILD || CURL_DISABLE_VERBOSE_STRINGS */ 105 #define streamclose(x,y) Curl_conncontrol(x, CONNCTRL_STREAM) 106 #define connclose(x,y) Curl_conncontrol(x, CONNCTRL_CONNECTION) 107 #define connkeep(x,y) Curl_conncontrol(x, CONNCTRL_KEEP) 108 #endif 109 110 /** 111 * Create a cfilter for making an "ip" connection to the 112 * given address, using parameters from `conn`. The "ip" connection 113 * can be a TCP socket, a UDP socket or even a QUIC connection. 114 * 115 * It MUST use only the supplied `ai` for its connection attempt. 116 * 117 * Such a filter may be used in "happy eyeball" scenarios, and its 118 * `connect` implementation needs to support non-blocking. Once connected, 119 * it MAY be installed in the connection filter chain to serve transfers. 120 */ 121 typedef CURLcode cf_ip_connect_create(struct Curl_cfilter **pcf, 122 struct Curl_easy *data, 123 struct connectdata *conn, 124 const struct Curl_addrinfo *ai, 125 int transport); 126 127 CURLcode Curl_cf_setup_insert_after(struct Curl_cfilter *cf_at, 128 struct Curl_easy *data, 129 int transport, 130 int ssl_mode); 131 132 /** 133 * Setup the cfilters at `sockindex` in connection `conn`. 134 * If no filter chain is installed yet, inspects the configuration 135 * in `data` and `conn? to install a suitable filter chain. 136 */ 137 CURLcode Curl_conn_setup(struct Curl_easy *data, 138 struct connectdata *conn, 139 int sockindex, 140 struct Curl_dns_entry *dns, 141 int ssl_mode); 142 143 extern struct Curl_cftype Curl_cft_happy_eyeballs; 144 extern struct Curl_cftype Curl_cft_setup; 145 146 #ifdef UNITTESTS 147 void Curl_debug_set_transport_provider(int transport, 148 cf_ip_connect_create *cf_create); 149 #endif 150 151 #endif /* HEADER_CURL_CONNECT_H */