Bertrand SIMONNET | e6cd738 | 2015-07-01 15:39:44 -0700 | [diff] [blame] | 1 | #ifndef HEADER_CURL_CONNECT_H |
| 2 | #define HEADER_CURL_CONNECT_H |
Kristian Monsen | 5ab5018 | 2010-05-14 18:53:44 +0100 | [diff] [blame] | 3 | /*************************************************************************** |
| 4 | * _ _ ____ _ |
| 5 | * Project ___| | | | _ \| | |
| 6 | * / __| | | | |_) | | |
| 7 | * | (__| |_| | _ <| |___ |
| 8 | * \___|\___/|_| \_\_____| |
| 9 | * |
Elliott Hughes | 82be86d | 2017-09-20 17:00:17 -0700 | [diff] [blame] | 10 | * Copyright (C) 1998 - 2017, Daniel Stenberg, <daniel@haxx.se>, et al. |
Kristian Monsen | 5ab5018 | 2010-05-14 18:53:44 +0100 | [diff] [blame] | 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 |
Alex Deymo | d15eaac | 2016-06-28 14:49:26 -0700 | [diff] [blame] | 14 | * are also available at https://curl.haxx.se/docs/copyright.html. |
Kristian Monsen | 5ab5018 | 2010-05-14 18:53:44 +0100 | [diff] [blame] | 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 | ***************************************************************************/ |
Bertrand SIMONNET | e6cd738 | 2015-07-01 15:39:44 -0700 | [diff] [blame] | 24 | #include "curl_setup.h" |
Kristian Monsen | 5ab5018 | 2010-05-14 18:53:44 +0100 | [diff] [blame] | 25 | |
| 26 | #include "nonblock.h" /* for curlx_nonblock(), formerly Curl_nonblock() */ |
Bertrand SIMONNET | e6cd738 | 2015-07-01 15:39:44 -0700 | [diff] [blame] | 27 | #include "sockaddr.h" |
Alex Deymo | 486467e | 2017-12-19 19:04:07 +0100 | [diff] [blame] | 28 | #include "timeval.h" |
Kristian Monsen | 5ab5018 | 2010-05-14 18:53:44 +0100 | [diff] [blame] | 29 | |
| 30 | CURLcode Curl_is_connected(struct connectdata *conn, |
| 31 | int sockindex, |
| 32 | bool *connected); |
| 33 | |
| 34 | CURLcode Curl_connecthost(struct connectdata *conn, |
Bertrand SIMONNET | e6cd738 | 2015-07-01 15:39:44 -0700 | [diff] [blame] | 35 | const struct Curl_dns_entry *host); |
Kristian Monsen | 5ab5018 | 2010-05-14 18:53:44 +0100 | [diff] [blame] | 36 | |
| 37 | /* generic function that returns how much time there's left to run, according |
| 38 | to the timeouts set */ |
Alex Deymo | 486467e | 2017-12-19 19:04:07 +0100 | [diff] [blame] | 39 | timediff_t Curl_timeleft(struct Curl_easy *data, |
| 40 | struct curltime *nowp, |
| 41 | bool duringconnect); |
Kristian Monsen | 5ab5018 | 2010-05-14 18:53:44 +0100 | [diff] [blame] | 42 | |
| 43 | #define DEFAULT_CONNECT_TIMEOUT 300000 /* milliseconds == five minutes */ |
| 44 | |
| 45 | /* |
| 46 | * Used to extract socket and connectdata struct for the most recent |
Alex Deymo | e3149cc | 2016-10-05 11:18:42 -0700 | [diff] [blame] | 47 | * transfer on the given Curl_easy. |
Kristian Monsen | 5ab5018 | 2010-05-14 18:53:44 +0100 | [diff] [blame] | 48 | * |
Lucas Eckels | 9bd90e6 | 2012-08-06 15:07:02 -0700 | [diff] [blame] | 49 | * The returned socket will be CURL_SOCKET_BAD in case of failure! |
Kristian Monsen | 5ab5018 | 2010-05-14 18:53:44 +0100 | [diff] [blame] | 50 | */ |
Alex Deymo | e3149cc | 2016-10-05 11:18:42 -0700 | [diff] [blame] | 51 | curl_socket_t Curl_getconnectinfo(struct Curl_easy *data, |
Lucas Eckels | 9bd90e6 | 2012-08-06 15:07:02 -0700 | [diff] [blame] | 52 | struct connectdata **connp); |
Kristian Monsen | 5ab5018 | 2010-05-14 18:53:44 +0100 | [diff] [blame] | 53 | |
Elliott Hughes | 82be86d | 2017-09-20 17:00:17 -0700 | [diff] [blame] | 54 | /* |
| 55 | * Check if a connection seems to be alive. |
| 56 | */ |
| 57 | bool Curl_connalive(struct connectdata *conn); |
| 58 | |
Bertrand SIMONNET | e6cd738 | 2015-07-01 15:39:44 -0700 | [diff] [blame] | 59 | #ifdef USE_WINSOCK |
Kristian Monsen | 5ab5018 | 2010-05-14 18:53:44 +0100 | [diff] [blame] | 60 | /* When you run a program that uses the Windows Sockets API, you may |
| 61 | experience slow performance when you copy data to a TCP server. |
| 62 | |
Alex Deymo | d15eaac | 2016-06-28 14:49:26 -0700 | [diff] [blame] | 63 | https://support.microsoft.com/kb/823764 |
Kristian Monsen | 5ab5018 | 2010-05-14 18:53:44 +0100 | [diff] [blame] | 64 | |
| 65 | Work-around: Make the Socket Send Buffer Size Larger Than the Program Send |
| 66 | Buffer Size |
| 67 | |
| 68 | */ |
| 69 | void Curl_sndbufset(curl_socket_t sockfd); |
| 70 | #else |
Bertrand SIMONNET | e6cd738 | 2015-07-01 15:39:44 -0700 | [diff] [blame] | 71 | #define Curl_sndbufset(y) Curl_nop_stmt |
Kristian Monsen | 5ab5018 | 2010-05-14 18:53:44 +0100 | [diff] [blame] | 72 | #endif |
| 73 | |
Lucas Eckels | 9bd90e6 | 2012-08-06 15:07:02 -0700 | [diff] [blame] | 74 | void Curl_updateconninfo(struct connectdata *conn, curl_socket_t sockfd); |
Bertrand SIMONNET | e6cd738 | 2015-07-01 15:39:44 -0700 | [diff] [blame] | 75 | void Curl_persistconninfo(struct connectdata *conn); |
| 76 | int Curl_closesocket(struct connectdata *conn, curl_socket_t sock); |
| 77 | |
| 78 | /* |
Elliott Hughes | cac3980 | 2018-04-27 16:19:43 -0700 | [diff] [blame] | 79 | * Get presentation format IP address and port from a sockaddr. |
| 80 | */ |
| 81 | bool Curl_getaddressinfo(struct sockaddr *sa, char *addr, long *port); |
| 82 | |
| 83 | /* |
Bertrand SIMONNET | e6cd738 | 2015-07-01 15:39:44 -0700 | [diff] [blame] | 84 | * The Curl_sockaddr_ex structure is basically libcurl's external API |
| 85 | * curl_sockaddr structure with enough space available to directly hold any |
| 86 | * protocol-specific address structures. The variable declared here will be |
| 87 | * used to pass / receive data to/from the fopensocket callback if this has |
| 88 | * been set, before that, it is initialized from parameters. |
| 89 | */ |
| 90 | struct Curl_sockaddr_ex { |
| 91 | int family; |
| 92 | int socktype; |
| 93 | int protocol; |
| 94 | unsigned int addrlen; |
| 95 | union { |
| 96 | struct sockaddr addr; |
| 97 | struct Curl_sockaddr_storage buff; |
| 98 | } _sa_ex_u; |
| 99 | }; |
| 100 | #define sa_addr _sa_ex_u.addr |
| 101 | |
| 102 | /* |
| 103 | * Create a socket based on info from 'conn' and 'ai'. |
| 104 | * |
| 105 | * Fill in 'addr' and 'sockfd' accordingly if OK is returned. If the open |
| 106 | * socket callback is set, used that! |
| 107 | * |
| 108 | */ |
| 109 | CURLcode Curl_socket(struct connectdata *conn, |
| 110 | const Curl_addrinfo *ai, |
| 111 | struct Curl_sockaddr_ex *addr, |
| 112 | curl_socket_t *sockfd); |
| 113 | |
Alex Deymo | d15eaac | 2016-06-28 14:49:26 -0700 | [diff] [blame] | 114 | void Curl_tcpnodelay(struct connectdata *conn, curl_socket_t sockfd); |
| 115 | |
Bertrand SIMONNET | e6cd738 | 2015-07-01 15:39:44 -0700 | [diff] [blame] | 116 | /* |
Elliott Hughes | cee0338 | 2017-06-23 12:17:18 -0700 | [diff] [blame] | 117 | * Curl_conncontrol() marks the end of a connection/stream. The 'closeit' |
| 118 | * argument specifies if it is the end of a connection or a stream. |
| 119 | * |
| 120 | * For stream-based protocols (such as HTTP/2), a stream close will not cause |
| 121 | * a connection close. Other protocols will close the connection for both |
| 122 | * cases. |
| 123 | * |
| 124 | * It sets the bit.close bit to TRUE (with an explanation for debug builds), |
| 125 | * when the connection will close. |
Bertrand SIMONNET | e6cd738 | 2015-07-01 15:39:44 -0700 | [diff] [blame] | 126 | */ |
Elliott Hughes | cee0338 | 2017-06-23 12:17:18 -0700 | [diff] [blame] | 127 | |
| 128 | #define CONNCTRL_KEEP 0 /* undo a marked closure */ |
| 129 | #define CONNCTRL_CONNECTION 1 |
| 130 | #define CONNCTRL_STREAM 2 |
| 131 | |
Bertrand SIMONNET | e6cd738 | 2015-07-01 15:39:44 -0700 | [diff] [blame] | 132 | void Curl_conncontrol(struct connectdata *conn, |
Elliott Hughes | cee0338 | 2017-06-23 12:17:18 -0700 | [diff] [blame] | 133 | int closeit |
Elliott Hughes | 82be86d | 2017-09-20 17:00:17 -0700 | [diff] [blame] | 134 | #if defined(DEBUGBUILD) && !defined(CURL_DISABLE_VERBOSE_STRINGS) |
Elliott Hughes | cee0338 | 2017-06-23 12:17:18 -0700 | [diff] [blame] | 135 | , const char *reason |
| 136 | #endif |
| 137 | ); |
| 138 | |
Elliott Hughes | 82be86d | 2017-09-20 17:00:17 -0700 | [diff] [blame] | 139 | #if defined(DEBUGBUILD) && !defined(CURL_DISABLE_VERBOSE_STRINGS) |
Elliott Hughes | cee0338 | 2017-06-23 12:17:18 -0700 | [diff] [blame] | 140 | #define streamclose(x,y) Curl_conncontrol(x, CONNCTRL_STREAM, y) |
| 141 | #define connclose(x,y) Curl_conncontrol(x, CONNCTRL_CONNECTION, y) |
| 142 | #define connkeep(x,y) Curl_conncontrol(x, CONNCTRL_KEEP, y) |
Elliott Hughes | 82be86d | 2017-09-20 17:00:17 -0700 | [diff] [blame] | 143 | #else /* if !DEBUGBUILD || CURL_DISABLE_VERBOSE_STRINGS */ |
Elliott Hughes | cee0338 | 2017-06-23 12:17:18 -0700 | [diff] [blame] | 144 | #define streamclose(x,y) Curl_conncontrol(x, CONNCTRL_STREAM) |
| 145 | #define connclose(x,y) Curl_conncontrol(x, CONNCTRL_CONNECTION) |
| 146 | #define connkeep(x,y) Curl_conncontrol(x, CONNCTRL_KEEP) |
Kristian Monsen | 5ab5018 | 2010-05-14 18:53:44 +0100 | [diff] [blame] | 147 | #endif |
Bertrand SIMONNET | e6cd738 | 2015-07-01 15:39:44 -0700 | [diff] [blame] | 148 | |
Elliott Hughes | 82be86d | 2017-09-20 17:00:17 -0700 | [diff] [blame] | 149 | bool Curl_conn_data_pending(struct connectdata *conn, int sockindex); |
| 150 | |
Bertrand SIMONNET | e6cd738 | 2015-07-01 15:39:44 -0700 | [diff] [blame] | 151 | #endif /* HEADER_CURL_CONNECT_H */ |