1 #ifndef HEADER_CURL_CONNECT_H
2 #define HEADER_CURL_CONNECT_H
3 /***************************************************************************
5 * Project ___| | | | _ \| |
7 * | (__| |_| | _ <| |___
8 * \___|\___/|_| \_\_____|
10 * Copyright (C) 1998 - 2016, Daniel Stenberg, <daniel@haxx.se>, et al.
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.haxx.se/docs/copyright.html.
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.
20 * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
21 * KIND, either express or implied.
23 ***************************************************************************/
24 #include "curl_setup.h"
26 #include "nonblock.h" /* for curlx_nonblock(), formerly Curl_nonblock() */
29 CURLcode Curl_is_connected(struct connectdata *conn,
33 CURLcode Curl_connecthost(struct connectdata *conn,
34 const struct Curl_dns_entry *host);
36 /* generic function that returns how much time there's left to run, according
37 to the timeouts set */
38 time_t Curl_timeleft(struct Curl_easy *data,
42 #define DEFAULT_CONNECT_TIMEOUT 300000 /* milliseconds == five minutes */
43 #define HAPPY_EYEBALLS_TIMEOUT 200 /* milliseconds to wait between
44 IPv4/IPv6 connection attempts */
47 * Used to extract socket and connectdata struct for the most recent
48 * transfer on the given Curl_easy.
50 * The returned socket will be CURL_SOCKET_BAD in case of failure!
52 curl_socket_t Curl_getconnectinfo(struct Curl_easy *data,
53 struct connectdata **connp);
56 * Check if a connection seems to be alive.
58 bool Curl_connalive(struct connectdata *conn);
61 /* When you run a program that uses the Windows Sockets API, you may
62 experience slow performance when you copy data to a TCP server.
64 https://support.microsoft.com/kb/823764
66 Work-around: Make the Socket Send Buffer Size Larger Than the Program Send
70 void Curl_sndbufset(curl_socket_t sockfd);
72 #define Curl_sndbufset(y) Curl_nop_stmt
75 void Curl_updateconninfo(struct connectdata *conn, curl_socket_t sockfd);
76 void Curl_persistconninfo(struct connectdata *conn);
77 int Curl_closesocket(struct connectdata *conn, curl_socket_t sock);
80 * The Curl_sockaddr_ex structure is basically libcurl's external API
81 * curl_sockaddr structure with enough space available to directly hold any
82 * protocol-specific address structures. The variable declared here will be
83 * used to pass / receive data to/from the fopensocket callback if this has
84 * been set, before that, it is initialized from parameters.
86 struct Curl_sockaddr_ex {
93 struct Curl_sockaddr_storage buff;
96 #define sa_addr _sa_ex_u.addr
99 * Create a socket based on info from 'conn' and 'ai'.
101 * Fill in 'addr' and 'sockfd' accordingly if OK is returned. If the open
102 * socket callback is set, used that!
105 CURLcode Curl_socket(struct connectdata *conn,
106 const Curl_addrinfo *ai,
107 struct Curl_sockaddr_ex *addr,
108 curl_socket_t *sockfd);
110 void Curl_tcpnodelay(struct connectdata *conn, curl_socket_t sockfd);
113 * Curl_conncontrol() marks the end of a connection/stream. The 'closeit'
114 * argument specifies if it is the end of a connection or a stream.
116 * For stream-based protocols (such as HTTP/2), a stream close will not cause
117 * a connection close. Other protocols will close the connection for both
120 * It sets the bit.close bit to TRUE (with an explanation for debug builds),
121 * when the connection will close.
124 #define CONNCTRL_KEEP 0 /* undo a marked closure */
125 #define CONNCTRL_CONNECTION 1
126 #define CONNCTRL_STREAM 2
128 void Curl_conncontrol(struct connectdata *conn,
136 #define streamclose(x,y) Curl_conncontrol(x, CONNCTRL_STREAM, y)
137 #define connclose(x,y) Curl_conncontrol(x, CONNCTRL_CONNECTION, y)
138 #define connkeep(x,y) Curl_conncontrol(x, CONNCTRL_KEEP, y)
139 #else /* if !CURLDEBUG */
140 #define streamclose(x,y) Curl_conncontrol(x, CONNCTRL_STREAM)
141 #define connclose(x,y) Curl_conncontrol(x, CONNCTRL_CONNECTION)
142 #define connkeep(x,y) Curl_conncontrol(x, CONNCTRL_KEEP)
145 bool Curl_conn_data_pending(struct connectdata *conn, int sockindex);
147 #endif /* HEADER_CURL_CONNECT_H */