Home | History | Annotate | Download | only in lib
      1 #ifndef HEADER_CURL_CONNECT_H
      2 #define HEADER_CURL_CONNECT_H
      3 /***************************************************************************
      4  *                                  _   _ ____  _
      5  *  Project                     ___| | | |  _ \| |
      6  *                             / __| | | | |_) | |
      7  *                            | (__| |_| |  _ <| |___
      8  *                             \___|\___/|_| \_\_____|
      9  *
     10  * Copyright (C) 1998 - 2017, Daniel Stenberg, <daniel (at) 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.haxx.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  ***************************************************************************/
     24 #include "curl_setup.h"
     25 
     26 #include "nonblock.h" /* for curlx_nonblock(), formerly Curl_nonblock() */
     27 #include "sockaddr.h"
     28 #include "timeval.h"
     29 
     30 CURLcode Curl_is_connected(struct connectdata *conn,
     31                            int sockindex,
     32                            bool *connected);
     33 
     34 CURLcode Curl_connecthost(struct connectdata *conn,
     35                           const struct Curl_dns_entry *host);
     36 
     37 /* generic function that returns how much time there's 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 #define HAPPY_EYEBALLS_TIMEOUT     200 /* milliseconds to wait between
     45                                           IPv4/IPv6 connection attempts */
     46 
     47 /*
     48  * Used to extract socket and connectdata struct for the most recent
     49  * transfer on the given Curl_easy.
     50  *
     51  * The returned socket will be CURL_SOCKET_BAD in case of failure!
     52  */
     53 curl_socket_t Curl_getconnectinfo(struct Curl_easy *data,
     54                                   struct connectdata **connp);
     55 
     56 /*
     57  * Check if a connection seems to be alive.
     58  */
     59 bool Curl_connalive(struct connectdata *conn);
     60 
     61 #ifdef USE_WINSOCK
     62 /* When you run a program that uses the Windows Sockets API, you may
     63    experience slow performance when you copy data to a TCP server.
     64 
     65    https://support.microsoft.com/kb/823764
     66 
     67    Work-around: Make the Socket Send Buffer Size Larger Than the Program Send
     68    Buffer Size
     69 
     70 */
     71 void Curl_sndbufset(curl_socket_t sockfd);
     72 #else
     73 #define Curl_sndbufset(y) Curl_nop_stmt
     74 #endif
     75 
     76 void Curl_updateconninfo(struct connectdata *conn, curl_socket_t sockfd);
     77 void Curl_persistconninfo(struct connectdata *conn);
     78 int Curl_closesocket(struct connectdata *conn, curl_socket_t sock);
     79 
     80 /*
     81  * The Curl_sockaddr_ex structure is basically libcurl's external API
     82  * curl_sockaddr structure with enough space available to directly hold any
     83  * protocol-specific address structures. The variable declared here will be
     84  * used to pass / receive data to/from the fopensocket callback if this has
     85  * been set, before that, it is initialized from parameters.
     86  */
     87 struct Curl_sockaddr_ex {
     88   int family;
     89   int socktype;
     90   int protocol;
     91   unsigned int addrlen;
     92   union {
     93     struct sockaddr addr;
     94     struct Curl_sockaddr_storage buff;
     95   } _sa_ex_u;
     96 };
     97 #define sa_addr _sa_ex_u.addr
     98 
     99 /*
    100  * Create a socket based on info from 'conn' and 'ai'.
    101  *
    102  * Fill in 'addr' and 'sockfd' accordingly if OK is returned. If the open
    103  * socket callback is set, used that!
    104  *
    105  */
    106 CURLcode Curl_socket(struct connectdata *conn,
    107                      const Curl_addrinfo *ai,
    108                      struct Curl_sockaddr_ex *addr,
    109                      curl_socket_t *sockfd);
    110 
    111 void Curl_tcpnodelay(struct connectdata *conn, curl_socket_t sockfd);
    112 
    113 /*
    114  * Curl_conncontrol() marks the end of a connection/stream. The 'closeit'
    115  * argument specifies if it is the end of a connection or a stream.
    116  *
    117  * For stream-based protocols (such as HTTP/2), a stream close will not cause
    118  * a connection close. Other protocols will close the connection for both
    119  * cases.
    120  *
    121  * It sets the bit.close bit to TRUE (with an explanation for debug builds),
    122  * when the connection will close.
    123  */
    124 
    125 #define CONNCTRL_KEEP 0 /* undo a marked closure */
    126 #define CONNCTRL_CONNECTION 1
    127 #define CONNCTRL_STREAM 2
    128 
    129 void Curl_conncontrol(struct connectdata *conn,
    130                       int closeit
    131 #if defined(DEBUGBUILD) && !defined(CURL_DISABLE_VERBOSE_STRINGS)
    132                       , const char *reason
    133 #endif
    134   );
    135 
    136 #if defined(DEBUGBUILD) && !defined(CURL_DISABLE_VERBOSE_STRINGS)
    137 #define streamclose(x,y) Curl_conncontrol(x, CONNCTRL_STREAM, y)
    138 #define connclose(x,y) Curl_conncontrol(x, CONNCTRL_CONNECTION, y)
    139 #define connkeep(x,y) Curl_conncontrol(x, CONNCTRL_KEEP, y)
    140 #else /* if !DEBUGBUILD || CURL_DISABLE_VERBOSE_STRINGS */
    141 #define streamclose(x,y) Curl_conncontrol(x, CONNCTRL_STREAM)
    142 #define connclose(x,y) Curl_conncontrol(x, CONNCTRL_CONNECTION)
    143 #define connkeep(x,y) Curl_conncontrol(x, CONNCTRL_KEEP)
    144 #endif
    145 
    146 bool Curl_conn_data_pending(struct connectdata *conn, int sockindex);
    147 
    148 #endif /* HEADER_CURL_CONNECT_H */
    149