2
0

cf-socket.h 6.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171
  1. #ifndef HEADER_CURL_CF_SOCKET_H
  2. #define HEADER_CURL_CF_SOCKET_H
  3. /***************************************************************************
  4. * _ _ ____ _
  5. * Project ___| | | | _ \| |
  6. * / __| | | | |_) | |
  7. * | (__| |_| | _ <| |___
  8. * \___|\___/|_| \_\_____|
  9. *
  10. * Copyright (C) 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.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. * SPDX-License-Identifier: curl
  24. *
  25. ***************************************************************************/
  26. #include "curl_setup.h"
  27. #include "nonblock.h" /* for curlx_nonblock(), formerly Curl_nonblock() */
  28. #include "sockaddr.h"
  29. struct Curl_addrinfo;
  30. struct Curl_cfilter;
  31. struct Curl_easy;
  32. struct connectdata;
  33. struct Curl_sockaddr_ex;
  34. struct ip_quadruple;
  35. /*
  36. * The Curl_sockaddr_ex structure is basically libcurl's external API
  37. * curl_sockaddr structure with enough space available to directly hold any
  38. * protocol-specific address structures. The variable declared here will be
  39. * used to pass / receive data to/from the fopensocket callback if this has
  40. * been set, before that, it is initialized from parameters.
  41. */
  42. struct Curl_sockaddr_ex {
  43. int family;
  44. int socktype;
  45. int protocol;
  46. unsigned int addrlen;
  47. union {
  48. struct sockaddr addr;
  49. struct Curl_sockaddr_storage buff;
  50. } _sa_ex_u;
  51. };
  52. #define sa_addr _sa_ex_u.addr
  53. /*
  54. * Create a socket based on info from 'conn' and 'ai'.
  55. *
  56. * Fill in 'addr' and 'sockfd' accordingly if OK is returned. If the open
  57. * socket callback is set, used that!
  58. *
  59. */
  60. CURLcode Curl_socket_open(struct Curl_easy *data,
  61. const struct Curl_addrinfo *ai,
  62. struct Curl_sockaddr_ex *addr,
  63. int transport,
  64. curl_socket_t *sockfd);
  65. int Curl_socket_close(struct Curl_easy *data, struct connectdata *conn,
  66. curl_socket_t sock);
  67. #ifdef USE_WINSOCK
  68. /* When you run a program that uses the Windows Sockets API, you may
  69. experience slow performance when you copy data to a TCP server.
  70. https://support.microsoft.com/kb/823764
  71. Work-around: Make the Socket Send Buffer Size Larger Than the Program Send
  72. Buffer Size
  73. */
  74. void Curl_sndbufset(curl_socket_t sockfd);
  75. #else
  76. #define Curl_sndbufset(y) Curl_nop_stmt
  77. #endif
  78. /**
  79. * Assign the address `ai` to the Curl_sockaddr_ex `dest` and
  80. * set the transport used.
  81. */
  82. void Curl_sock_assign_addr(struct Curl_sockaddr_ex *dest,
  83. const struct Curl_addrinfo *ai,
  84. int transport);
  85. /**
  86. * Creates a cfilter that opens a TCP socket to the given address
  87. * when calling its `connect` implementation.
  88. * The filter will not touch any connection/data flags and can be
  89. * used in happy eyeballing. Once selected for use, its `_active()`
  90. * method needs to be called.
  91. */
  92. CURLcode Curl_cf_tcp_create(struct Curl_cfilter **pcf,
  93. struct Curl_easy *data,
  94. struct connectdata *conn,
  95. const struct Curl_addrinfo *ai,
  96. int transport);
  97. /**
  98. * Creates a cfilter that opens a UDP socket to the given address
  99. * when calling its `connect` implementation.
  100. * The filter will not touch any connection/data flags and can be
  101. * used in happy eyeballing. Once selected for use, its `_active()`
  102. * method needs to be called.
  103. */
  104. CURLcode Curl_cf_udp_create(struct Curl_cfilter **pcf,
  105. struct Curl_easy *data,
  106. struct connectdata *conn,
  107. const struct Curl_addrinfo *ai,
  108. int transport);
  109. /**
  110. * Creates a cfilter that opens a UNIX socket to the given address
  111. * when calling its `connect` implementation.
  112. * The filter will not touch any connection/data flags and can be
  113. * used in happy eyeballing. Once selected for use, its `_active()`
  114. * method needs to be called.
  115. */
  116. CURLcode Curl_cf_unix_create(struct Curl_cfilter **pcf,
  117. struct Curl_easy *data,
  118. struct connectdata *conn,
  119. const struct Curl_addrinfo *ai,
  120. int transport);
  121. /**
  122. * Creates a cfilter that keeps a listening socket.
  123. */
  124. CURLcode Curl_conn_tcp_listen_set(struct Curl_easy *data,
  125. struct connectdata *conn,
  126. int sockindex,
  127. curl_socket_t *s);
  128. /**
  129. * Replace the listen socket with the accept()ed one.
  130. */
  131. CURLcode Curl_conn_tcp_accepted_set(struct Curl_easy *data,
  132. struct connectdata *conn,
  133. int sockindex,
  134. curl_socket_t *s);
  135. /**
  136. * Peek at the socket and remote ip/port the socket filter is using.
  137. * The filter owns all returned values.
  138. * @param psock pointer to hold socket descriptor or NULL
  139. * @param paddr pointer to hold addr reference or NULL
  140. * @param pip pointer to get IP quadruple or NULL
  141. * Returns error if the filter is of invalid type.
  142. */
  143. CURLcode Curl_cf_socket_peek(struct Curl_cfilter *cf,
  144. struct Curl_easy *data,
  145. curl_socket_t *psock,
  146. const struct Curl_sockaddr_ex **paddr,
  147. struct ip_quadruple *pip);
  148. extern struct Curl_cftype Curl_cft_tcp;
  149. extern struct Curl_cftype Curl_cft_udp;
  150. extern struct Curl_cftype Curl_cft_unix;
  151. extern struct Curl_cftype Curl_cft_tcp_accept;
  152. #endif /* HEADER_CURL_CF_SOCKET_H */