connect.h 5.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147
  1. #ifndef HEADER_CURL_CONNECT_H
  2. #define HEADER_CURL_CONNECT_H
  3. /***************************************************************************
  4. * _ _ ____ _
  5. * Project ___| | | | _ \| |
  6. * / __| | | | |_) | |
  7. * | (__| |_| | _ <| |___
  8. * \___|\___/|_| \_\_____|
  9. *
  10. * Copyright (C) 1998 - 2020, 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. bool Curl_addr2string(struct sockaddr *sa, curl_socklen_t salen,
  48. char *addr, long *port);
  49. /*
  50. * Check if a connection seems to be alive.
  51. */
  52. bool Curl_connalive(struct connectdata *conn);
  53. #ifdef USE_WINSOCK
  54. /* When you run a program that uses the Windows Sockets API, you may
  55. experience slow performance when you copy data to a TCP server.
  56. https://support.microsoft.com/kb/823764
  57. Work-around: Make the Socket Send Buffer Size Larger Than the Program Send
  58. Buffer Size
  59. */
  60. void Curl_sndbufset(curl_socket_t sockfd);
  61. #else
  62. #define Curl_sndbufset(y) Curl_nop_stmt
  63. #endif
  64. void Curl_updateconninfo(struct connectdata *conn, curl_socket_t sockfd);
  65. void Curl_persistconninfo(struct connectdata *conn);
  66. int Curl_closesocket(struct connectdata *conn, curl_socket_t sock);
  67. /*
  68. * The Curl_sockaddr_ex structure is basically libcurl's external API
  69. * curl_sockaddr structure with enough space available to directly hold any
  70. * protocol-specific address structures. The variable declared here will be
  71. * used to pass / receive data to/from the fopensocket callback if this has
  72. * been set, before that, it is initialized from parameters.
  73. */
  74. struct Curl_sockaddr_ex {
  75. int family;
  76. int socktype;
  77. int protocol;
  78. unsigned int addrlen;
  79. union {
  80. struct curl_struct_sockaddr addr;
  81. struct Curl_sockaddr_storage buff;
  82. } _sa_ex_u;
  83. };
  84. #define sa_addr _sa_ex_u.addr
  85. /*
  86. * Create a socket based on info from 'conn' and 'ai'.
  87. *
  88. * Fill in 'addr' and 'sockfd' accordingly if OK is returned. If the open
  89. * socket callback is set, used that!
  90. *
  91. */
  92. CURLcode Curl_socket(struct connectdata *conn,
  93. const struct Curl_addrinfo *ai,
  94. struct Curl_sockaddr_ex *addr,
  95. curl_socket_t *sockfd);
  96. /*
  97. * Curl_conncontrol() marks the end of a connection/stream. The 'closeit'
  98. * argument specifies if it is the end of a connection or a stream.
  99. *
  100. * For stream-based protocols (such as HTTP/2), a stream close will not cause
  101. * a connection close. Other protocols will close the connection for both
  102. * cases.
  103. *
  104. * It sets the bit.close bit to TRUE (with an explanation for debug builds),
  105. * when the connection will close.
  106. */
  107. #define CONNCTRL_KEEP 0 /* undo a marked closure */
  108. #define CONNCTRL_CONNECTION 1
  109. #define CONNCTRL_STREAM 2
  110. void Curl_conncontrol(struct connectdata *conn,
  111. int closeit
  112. #if defined(DEBUGBUILD) && !defined(CURL_DISABLE_VERBOSE_STRINGS)
  113. , const char *reason
  114. #endif
  115. );
  116. #if defined(DEBUGBUILD) && !defined(CURL_DISABLE_VERBOSE_STRINGS)
  117. #define streamclose(x,y) Curl_conncontrol(x, CONNCTRL_STREAM, y)
  118. #define connclose(x,y) Curl_conncontrol(x, CONNCTRL_CONNECTION, y)
  119. #define connkeep(x,y) Curl_conncontrol(x, CONNCTRL_KEEP, y)
  120. #else /* if !DEBUGBUILD || CURL_DISABLE_VERBOSE_STRINGS */
  121. #define streamclose(x,y) Curl_conncontrol(x, CONNCTRL_STREAM)
  122. #define connclose(x,y) Curl_conncontrol(x, CONNCTRL_CONNECTION)
  123. #define connkeep(x,y) Curl_conncontrol(x, CONNCTRL_KEEP)
  124. #endif
  125. bool Curl_conn_data_pending(struct connectdata *conn, int sockindex);
  126. #endif /* HEADER_CURL_CONNECT_H */