socket_ops.hpp 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382
  1. //
  2. // detail/socket_ops.hpp
  3. // ~~~~~~~~~~~~~~~~~~~~~
  4. //
  5. // Copyright (c) 2003-2025 Christopher M. Kohlhoff (chris at kohlhoff dot com)
  6. //
  7. // Distributed under the Boost Software License, Version 1.0. (See accompanying
  8. // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
  9. //
  10. #ifndef BOOST_ASIO_DETAIL_SOCKET_OPS_HPP
  11. #define BOOST_ASIO_DETAIL_SOCKET_OPS_HPP
  12. #if defined(_MSC_VER) && (_MSC_VER >= 1200)
  13. # pragma once
  14. #endif // defined(_MSC_VER) && (_MSC_VER >= 1200)
  15. #include <boost/asio/detail/config.hpp>
  16. #include <boost/system/error_code.hpp>
  17. #include <boost/asio/detail/memory.hpp>
  18. #include <boost/asio/detail/socket_types.hpp>
  19. #include <boost/asio/detail/push_options.hpp>
  20. namespace boost {
  21. namespace asio {
  22. namespace detail {
  23. namespace socket_ops {
  24. // Socket state bits.
  25. enum
  26. {
  27. // The user wants a non-blocking socket.
  28. user_set_non_blocking = 1,
  29. // The socket has been set non-blocking.
  30. internal_non_blocking = 2,
  31. // Helper "state" used to determine whether the socket is non-blocking.
  32. non_blocking = user_set_non_blocking | internal_non_blocking,
  33. // User wants connection_aborted errors, which are disabled by default.
  34. enable_connection_aborted = 4,
  35. // The user set the linger option. Needs to be checked when closing.
  36. user_set_linger = 8,
  37. // The socket is stream-oriented.
  38. stream_oriented = 16,
  39. // The socket is datagram-oriented.
  40. datagram_oriented = 32,
  41. // The socket may have been dup()-ed.
  42. possible_dup = 64,
  43. // When using an edge-triggered reactor (epoll) the user wants the edge to be
  44. // reset following a partial read on a stream-oriented socket.
  45. reset_edge_on_partial_read = 128
  46. };
  47. typedef unsigned char state_type;
  48. struct noop_deleter { void operator()(void*) {} };
  49. typedef shared_ptr<void> shared_cancel_token_type;
  50. typedef weak_ptr<void> weak_cancel_token_type;
  51. #if !defined(BOOST_ASIO_WINDOWS_RUNTIME)
  52. BOOST_ASIO_DECL socket_type accept(socket_type s, void* addr,
  53. std::size_t* addrlen, boost::system::error_code& ec);
  54. BOOST_ASIO_DECL socket_type sync_accept(socket_type s, state_type state,
  55. void* addr, std::size_t* addrlen, boost::system::error_code& ec);
  56. #if defined(BOOST_ASIO_HAS_IOCP)
  57. BOOST_ASIO_DECL void complete_iocp_accept(socket_type s, void* output_buffer,
  58. DWORD address_length, void* addr, std::size_t* addrlen,
  59. socket_type new_socket, boost::system::error_code& ec);
  60. #else // defined(BOOST_ASIO_HAS_IOCP)
  61. BOOST_ASIO_DECL bool non_blocking_accept(socket_type s,
  62. state_type state, void* addr, std::size_t* addrlen,
  63. boost::system::error_code& ec, socket_type& new_socket);
  64. #endif // defined(BOOST_ASIO_HAS_IOCP)
  65. BOOST_ASIO_DECL int bind(socket_type s, const void* addr,
  66. std::size_t addrlen, boost::system::error_code& ec);
  67. BOOST_ASIO_DECL int close(socket_type s, state_type& state,
  68. bool destruction, boost::system::error_code& ec);
  69. BOOST_ASIO_DECL bool set_user_non_blocking(socket_type s,
  70. state_type& state, bool value, boost::system::error_code& ec);
  71. BOOST_ASIO_DECL bool set_internal_non_blocking(socket_type s,
  72. state_type& state, bool value, boost::system::error_code& ec);
  73. BOOST_ASIO_DECL int shutdown(socket_type s,
  74. int what, boost::system::error_code& ec);
  75. BOOST_ASIO_DECL int connect(socket_type s, const void* addr,
  76. std::size_t addrlen, boost::system::error_code& ec);
  77. BOOST_ASIO_DECL void sync_connect(socket_type s, const void* addr,
  78. std::size_t addrlen, boost::system::error_code& ec);
  79. #if defined(BOOST_ASIO_HAS_IOCP)
  80. BOOST_ASIO_DECL void complete_iocp_connect(socket_type s,
  81. boost::system::error_code& ec);
  82. #endif // defined(BOOST_ASIO_HAS_IOCP)
  83. BOOST_ASIO_DECL bool non_blocking_connect(socket_type s,
  84. boost::system::error_code& ec);
  85. BOOST_ASIO_DECL int socketpair(int af, int type, int protocol,
  86. socket_type sv[2], boost::system::error_code& ec);
  87. BOOST_ASIO_DECL bool sockatmark(socket_type s, boost::system::error_code& ec);
  88. BOOST_ASIO_DECL size_t available(socket_type s, boost::system::error_code& ec);
  89. BOOST_ASIO_DECL int listen(socket_type s,
  90. int backlog, boost::system::error_code& ec);
  91. #if defined(BOOST_ASIO_WINDOWS) || defined(__CYGWIN__)
  92. typedef WSABUF buf;
  93. #else // defined(BOOST_ASIO_WINDOWS) || defined(__CYGWIN__)
  94. typedef iovec buf;
  95. #endif // defined(BOOST_ASIO_WINDOWS) || defined(__CYGWIN__)
  96. BOOST_ASIO_DECL void init_buf(buf& b, void* data, size_t size);
  97. BOOST_ASIO_DECL void init_buf(buf& b, const void* data, size_t size);
  98. BOOST_ASIO_DECL signed_size_type recv(socket_type s, buf* bufs,
  99. size_t count, int flags, boost::system::error_code& ec);
  100. BOOST_ASIO_DECL signed_size_type recv1(socket_type s,
  101. void* data, size_t size, int flags, boost::system::error_code& ec);
  102. BOOST_ASIO_DECL size_t sync_recv(socket_type s, state_type state, buf* bufs,
  103. size_t count, int flags, bool all_empty, boost::system::error_code& ec);
  104. BOOST_ASIO_DECL size_t sync_recv1(socket_type s, state_type state,
  105. void* data, size_t size, int flags, boost::system::error_code& ec);
  106. #if defined(BOOST_ASIO_HAS_IOCP)
  107. BOOST_ASIO_DECL void complete_iocp_recv(state_type state,
  108. const weak_cancel_token_type& cancel_token, bool all_empty,
  109. boost::system::error_code& ec, size_t bytes_transferred);
  110. #else // defined(BOOST_ASIO_HAS_IOCP)
  111. BOOST_ASIO_DECL bool non_blocking_recv(socket_type s,
  112. buf* bufs, size_t count, int flags, bool is_stream,
  113. boost::system::error_code& ec, size_t& bytes_transferred);
  114. BOOST_ASIO_DECL bool non_blocking_recv1(socket_type s,
  115. void* data, size_t size, int flags, bool is_stream,
  116. boost::system::error_code& ec, size_t& bytes_transferred);
  117. #endif // defined(BOOST_ASIO_HAS_IOCP)
  118. BOOST_ASIO_DECL signed_size_type recvfrom(socket_type s,
  119. buf* bufs, size_t count, int flags, void* addr,
  120. std::size_t* addrlen, boost::system::error_code& ec);
  121. BOOST_ASIO_DECL signed_size_type recvfrom1(socket_type s,
  122. void* data, size_t size, int flags, void* addr,
  123. std::size_t* addrlen, boost::system::error_code& ec);
  124. BOOST_ASIO_DECL size_t sync_recvfrom(socket_type s, state_type state,
  125. buf* bufs, size_t count, int flags, void* addr,
  126. std::size_t* addrlen, boost::system::error_code& ec);
  127. BOOST_ASIO_DECL size_t sync_recvfrom1(socket_type s, state_type state,
  128. void* data, size_t size, int flags, void* addr,
  129. std::size_t* addrlen, boost::system::error_code& ec);
  130. #if defined(BOOST_ASIO_HAS_IOCP)
  131. BOOST_ASIO_DECL void complete_iocp_recvfrom(
  132. const weak_cancel_token_type& cancel_token,
  133. boost::system::error_code& ec);
  134. #else // defined(BOOST_ASIO_HAS_IOCP)
  135. BOOST_ASIO_DECL bool non_blocking_recvfrom(socket_type s, buf* bufs,
  136. size_t count, int flags, void* addr, std::size_t* addrlen,
  137. boost::system::error_code& ec, size_t& bytes_transferred);
  138. BOOST_ASIO_DECL bool non_blocking_recvfrom1(socket_type s, void* data,
  139. size_t size, int flags, void* addr, std::size_t* addrlen,
  140. boost::system::error_code& ec, size_t& bytes_transferred);
  141. #endif // defined(BOOST_ASIO_HAS_IOCP)
  142. BOOST_ASIO_DECL signed_size_type recvmsg(socket_type s, buf* bufs,
  143. size_t count, int in_flags, int& out_flags,
  144. boost::system::error_code& ec);
  145. BOOST_ASIO_DECL size_t sync_recvmsg(socket_type s, state_type state,
  146. buf* bufs, size_t count, int in_flags, int& out_flags,
  147. boost::system::error_code& ec);
  148. #if defined(BOOST_ASIO_HAS_IOCP)
  149. BOOST_ASIO_DECL void complete_iocp_recvmsg(
  150. const weak_cancel_token_type& cancel_token,
  151. boost::system::error_code& ec);
  152. #else // defined(BOOST_ASIO_HAS_IOCP)
  153. BOOST_ASIO_DECL bool non_blocking_recvmsg(socket_type s,
  154. buf* bufs, size_t count, int in_flags, int& out_flags,
  155. boost::system::error_code& ec, size_t& bytes_transferred);
  156. #endif // defined(BOOST_ASIO_HAS_IOCP)
  157. BOOST_ASIO_DECL signed_size_type send(socket_type s, const buf* bufs,
  158. size_t count, int flags, boost::system::error_code& ec);
  159. BOOST_ASIO_DECL signed_size_type send1(socket_type s,
  160. const void* data, size_t size, int flags, boost::system::error_code& ec);
  161. BOOST_ASIO_DECL size_t sync_send(socket_type s, state_type state,
  162. const buf* bufs, size_t count, int flags,
  163. bool all_empty, boost::system::error_code& ec);
  164. BOOST_ASIO_DECL size_t sync_send1(socket_type s, state_type state,
  165. const void* data, size_t size, int flags, boost::system::error_code& ec);
  166. #if defined(BOOST_ASIO_HAS_IOCP)
  167. BOOST_ASIO_DECL void complete_iocp_send(
  168. const weak_cancel_token_type& cancel_token,
  169. boost::system::error_code& ec);
  170. #else // defined(BOOST_ASIO_HAS_IOCP)
  171. BOOST_ASIO_DECL bool non_blocking_send(socket_type s,
  172. const buf* bufs, size_t count, int flags,
  173. boost::system::error_code& ec, size_t& bytes_transferred);
  174. BOOST_ASIO_DECL bool non_blocking_send1(socket_type s,
  175. const void* data, size_t size, int flags,
  176. boost::system::error_code& ec, size_t& bytes_transferred);
  177. #endif // defined(BOOST_ASIO_HAS_IOCP)
  178. BOOST_ASIO_DECL signed_size_type sendto(socket_type s,
  179. const buf* bufs, size_t count, int flags, const void* addr,
  180. std::size_t addrlen, boost::system::error_code& ec);
  181. BOOST_ASIO_DECL signed_size_type sendto1(socket_type s,
  182. const void* data, size_t size, int flags, const void* addr,
  183. std::size_t addrlen, boost::system::error_code& ec);
  184. BOOST_ASIO_DECL size_t sync_sendto(socket_type s, state_type state,
  185. const buf* bufs, size_t count, int flags, const void* addr,
  186. std::size_t addrlen, boost::system::error_code& ec);
  187. BOOST_ASIO_DECL size_t sync_sendto1(socket_type s, state_type state,
  188. const void* data, size_t size, int flags, const void* addr,
  189. std::size_t addrlen, boost::system::error_code& ec);
  190. #if !defined(BOOST_ASIO_HAS_IOCP)
  191. BOOST_ASIO_DECL bool non_blocking_sendto(socket_type s, const buf* bufs,
  192. size_t count, int flags, const void* addr, std::size_t addrlen,
  193. boost::system::error_code& ec, size_t& bytes_transferred);
  194. BOOST_ASIO_DECL bool non_blocking_sendto1(socket_type s, const void* data,
  195. size_t size, int flags, const void* addr, std::size_t addrlen,
  196. boost::system::error_code& ec, size_t& bytes_transferred);
  197. #endif // !defined(BOOST_ASIO_HAS_IOCP)
  198. BOOST_ASIO_DECL socket_type socket(int af, int type, int protocol,
  199. boost::system::error_code& ec);
  200. BOOST_ASIO_DECL int setsockopt(socket_type s, state_type& state,
  201. int level, int optname, const void* optval,
  202. std::size_t optlen, boost::system::error_code& ec);
  203. BOOST_ASIO_DECL int getsockopt(socket_type s, state_type state,
  204. int level, int optname, void* optval,
  205. size_t* optlen, boost::system::error_code& ec);
  206. BOOST_ASIO_DECL int getpeername(socket_type s, void* addr,
  207. std::size_t* addrlen, bool cached, boost::system::error_code& ec);
  208. BOOST_ASIO_DECL int getsockname(socket_type s, void* addr,
  209. std::size_t* addrlen, boost::system::error_code& ec);
  210. BOOST_ASIO_DECL int ioctl(socket_type s, state_type& state,
  211. int cmd, ioctl_arg_type* arg, boost::system::error_code& ec);
  212. BOOST_ASIO_DECL int select(int nfds, fd_set* readfds, fd_set* writefds,
  213. fd_set* exceptfds, timeval* timeout, boost::system::error_code& ec);
  214. BOOST_ASIO_DECL int poll_read(socket_type s,
  215. state_type state, int msec, boost::system::error_code& ec);
  216. BOOST_ASIO_DECL int poll_write(socket_type s,
  217. state_type state, int msec, boost::system::error_code& ec);
  218. BOOST_ASIO_DECL int poll_error(socket_type s,
  219. state_type state, int msec, boost::system::error_code& ec);
  220. BOOST_ASIO_DECL int poll_connect(socket_type s,
  221. int msec, boost::system::error_code& ec);
  222. #endif // !defined(BOOST_ASIO_WINDOWS_RUNTIME)
  223. BOOST_ASIO_DECL const char* inet_ntop(int af, const void* src, char* dest,
  224. size_t length, unsigned long scope_id, boost::system::error_code& ec);
  225. BOOST_ASIO_DECL int inet_pton(int af, const char* src, void* dest,
  226. unsigned long* scope_id, boost::system::error_code& ec);
  227. BOOST_ASIO_DECL int gethostname(char* name,
  228. int namelen, boost::system::error_code& ec);
  229. #if !defined(BOOST_ASIO_WINDOWS_RUNTIME)
  230. BOOST_ASIO_DECL boost::system::error_code getaddrinfo(const char* host,
  231. const char* service, const addrinfo_type& hints,
  232. addrinfo_type** result, boost::system::error_code& ec);
  233. BOOST_ASIO_DECL boost::system::error_code background_getaddrinfo(
  234. const weak_cancel_token_type& cancel_token, const char* host,
  235. const char* service, const addrinfo_type& hints,
  236. addrinfo_type** result, boost::system::error_code& ec);
  237. BOOST_ASIO_DECL void freeaddrinfo(addrinfo_type* ai);
  238. BOOST_ASIO_DECL boost::system::error_code getnameinfo(const void* addr,
  239. std::size_t addrlen, char* host, std::size_t hostlen, char* serv,
  240. std::size_t servlen, int flags, boost::system::error_code& ec);
  241. BOOST_ASIO_DECL boost::system::error_code sync_getnameinfo(const void* addr,
  242. std::size_t addrlen, char* host, std::size_t hostlen, char* serv,
  243. std::size_t servlen, int sock_type, boost::system::error_code& ec);
  244. BOOST_ASIO_DECL boost::system::error_code background_getnameinfo(
  245. const weak_cancel_token_type& cancel_token,
  246. const void* addr, std::size_t addrlen,
  247. char* host, std::size_t hostlen, char* serv,
  248. std::size_t servlen, int sock_type, boost::system::error_code& ec);
  249. #endif // !defined(BOOST_ASIO_WINDOWS_RUNTIME)
  250. BOOST_ASIO_DECL u_long_type network_to_host_long(u_long_type value);
  251. BOOST_ASIO_DECL u_long_type host_to_network_long(u_long_type value);
  252. BOOST_ASIO_DECL u_short_type network_to_host_short(u_short_type value);
  253. BOOST_ASIO_DECL u_short_type host_to_network_short(u_short_type value);
  254. } // namespace socket_ops
  255. } // namespace detail
  256. } // namespace asio
  257. } // namespace boost
  258. #include <boost/asio/detail/pop_options.hpp>
  259. #if defined(BOOST_ASIO_HEADER_ONLY)
  260. # include <boost/asio/detail/impl/socket_ops.ipp>
  261. #endif // defined(BOOST_ASIO_HEADER_ONLY)
  262. #endif // BOOST_ASIO_DETAIL_SOCKET_OPS_HPP