connect.h 5.0 KB

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