socket_ops.hpp 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339
  1. //
  2. // detail/socket_ops.hpp
  3. // ~~~~~~~~~~~~~~~~~~~~~
  4. //
  5. // Copyright (c) 2003-2018 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. };
  44. typedef unsigned char state_type;
  45. struct noop_deleter { void operator()(void*) {} };
  46. typedef shared_ptr<void> shared_cancel_token_type;
  47. typedef weak_ptr<void> weak_cancel_token_type;
  48. #if !defined(BOOST_ASIO_WINDOWS_RUNTIME)
  49. BOOST_ASIO_DECL socket_type accept(socket_type s, socket_addr_type* addr,
  50. std::size_t* addrlen, boost::system::error_code& ec);
  51. BOOST_ASIO_DECL socket_type sync_accept(socket_type s,
  52. state_type state, socket_addr_type* addr,
  53. std::size_t* addrlen, boost::system::error_code& ec);
  54. #if defined(BOOST_ASIO_HAS_IOCP)
  55. BOOST_ASIO_DECL void complete_iocp_accept(socket_type s,
  56. void* output_buffer, DWORD address_length,
  57. socket_addr_type* addr, std::size_t* addrlen,
  58. socket_type new_socket, boost::system::error_code& ec);
  59. #else // defined(BOOST_ASIO_HAS_IOCP)
  60. BOOST_ASIO_DECL bool non_blocking_accept(socket_type s,
  61. state_type state, socket_addr_type* addr, std::size_t* addrlen,
  62. boost::system::error_code& ec, socket_type& new_socket);
  63. #endif // defined(BOOST_ASIO_HAS_IOCP)
  64. BOOST_ASIO_DECL int bind(socket_type s, const socket_addr_type* addr,
  65. std::size_t addrlen, boost::system::error_code& ec);
  66. BOOST_ASIO_DECL int close(socket_type s, state_type& state,
  67. bool destruction, boost::system::error_code& ec);
  68. BOOST_ASIO_DECL bool set_user_non_blocking(socket_type s,
  69. state_type& state, bool value, boost::system::error_code& ec);
  70. BOOST_ASIO_DECL bool set_internal_non_blocking(socket_type s,
  71. state_type& state, bool value, boost::system::error_code& ec);
  72. BOOST_ASIO_DECL int shutdown(socket_type s,
  73. int what, boost::system::error_code& ec);
  74. BOOST_ASIO_DECL int connect(socket_type s, const socket_addr_type* addr,
  75. std::size_t addrlen, boost::system::error_code& ec);
  76. BOOST_ASIO_DECL void sync_connect(socket_type s, const socket_addr_type* addr,
  77. std::size_t addrlen, boost::system::error_code& ec);
  78. #if defined(BOOST_ASIO_HAS_IOCP)
  79. BOOST_ASIO_DECL void complete_iocp_connect(socket_type s,
  80. boost::system::error_code& ec);
  81. #endif // defined(BOOST_ASIO_HAS_IOCP)
  82. BOOST_ASIO_DECL bool non_blocking_connect(socket_type s,
  83. boost::system::error_code& ec);
  84. BOOST_ASIO_DECL int socketpair(int af, int type, int protocol,
  85. socket_type sv[2], boost::system::error_code& ec);
  86. BOOST_ASIO_DECL bool sockatmark(socket_type s, boost::system::error_code& ec);
  87. BOOST_ASIO_DECL size_t available(socket_type s, boost::system::error_code& ec);
  88. BOOST_ASIO_DECL int listen(socket_type s,
  89. int backlog, boost::system::error_code& ec);
  90. #if defined(BOOST_ASIO_WINDOWS) || defined(__CYGWIN__)
  91. typedef WSABUF buf;
  92. #else // defined(BOOST_ASIO_WINDOWS) || defined(__CYGWIN__)
  93. typedef iovec buf;
  94. #endif // defined(BOOST_ASIO_WINDOWS) || defined(__CYGWIN__)
  95. BOOST_ASIO_DECL void init_buf(buf& b, void* data, size_t size);
  96. BOOST_ASIO_DECL void init_buf(buf& b, const void* data, size_t size);
  97. BOOST_ASIO_DECL signed_size_type recv(socket_type s, buf* bufs,
  98. size_t count, int flags, boost::system::error_code& ec);
  99. BOOST_ASIO_DECL size_t sync_recv(socket_type s, state_type state, buf* bufs,
  100. size_t count, int flags, bool all_empty, boost::system::error_code& ec);
  101. #if defined(BOOST_ASIO_HAS_IOCP)
  102. BOOST_ASIO_DECL void complete_iocp_recv(state_type state,
  103. const weak_cancel_token_type& cancel_token, bool all_empty,
  104. boost::system::error_code& ec, size_t bytes_transferred);
  105. #else // defined(BOOST_ASIO_HAS_IOCP)
  106. BOOST_ASIO_DECL bool non_blocking_recv(socket_type s,
  107. buf* bufs, size_t count, int flags, bool is_stream,
  108. boost::system::error_code& ec, size_t& bytes_transferred);
  109. #endif // defined(BOOST_ASIO_HAS_IOCP)
  110. BOOST_ASIO_DECL signed_size_type recvfrom(socket_type s, buf* bufs,
  111. size_t count, int flags, socket_addr_type* addr,
  112. std::size_t* addrlen, boost::system::error_code& ec);
  113. BOOST_ASIO_DECL size_t sync_recvfrom(socket_type s, state_type state,
  114. buf* bufs, size_t count, int flags, socket_addr_type* addr,
  115. std::size_t* addrlen, boost::system::error_code& ec);
  116. #if defined(BOOST_ASIO_HAS_IOCP)
  117. BOOST_ASIO_DECL void complete_iocp_recvfrom(
  118. const weak_cancel_token_type& cancel_token,
  119. boost::system::error_code& ec);
  120. #else // defined(BOOST_ASIO_HAS_IOCP)
  121. BOOST_ASIO_DECL bool non_blocking_recvfrom(socket_type s,
  122. buf* bufs, size_t count, int flags,
  123. socket_addr_type* addr, std::size_t* addrlen,
  124. boost::system::error_code& ec, size_t& bytes_transferred);
  125. #endif // defined(BOOST_ASIO_HAS_IOCP)
  126. BOOST_ASIO_DECL signed_size_type recvmsg(socket_type s, buf* bufs,
  127. size_t count, int in_flags, int& out_flags,
  128. boost::system::error_code& ec);
  129. BOOST_ASIO_DECL size_t sync_recvmsg(socket_type s, state_type state,
  130. buf* bufs, size_t count, int in_flags, int& out_flags,
  131. boost::system::error_code& ec);
  132. #if defined(BOOST_ASIO_HAS_IOCP)
  133. BOOST_ASIO_DECL void complete_iocp_recvmsg(
  134. const weak_cancel_token_type& cancel_token,
  135. boost::system::error_code& ec);
  136. #else // defined(BOOST_ASIO_HAS_IOCP)
  137. BOOST_ASIO_DECL bool non_blocking_recvmsg(socket_type s,
  138. buf* bufs, size_t count, int in_flags, int& out_flags,
  139. boost::system::error_code& ec, size_t& bytes_transferred);
  140. #endif // defined(BOOST_ASIO_HAS_IOCP)
  141. BOOST_ASIO_DECL signed_size_type send(socket_type s, const buf* bufs,
  142. size_t count, int flags, boost::system::error_code& ec);
  143. BOOST_ASIO_DECL size_t sync_send(socket_type s, state_type state,
  144. const buf* bufs, size_t count, int flags,
  145. bool all_empty, boost::system::error_code& ec);
  146. #if defined(BOOST_ASIO_HAS_IOCP)
  147. BOOST_ASIO_DECL void complete_iocp_send(
  148. const weak_cancel_token_type& cancel_token,
  149. boost::system::error_code& ec);
  150. #else // defined(BOOST_ASIO_HAS_IOCP)
  151. BOOST_ASIO_DECL bool non_blocking_send(socket_type s,
  152. const buf* bufs, size_t count, int flags,
  153. boost::system::error_code& ec, size_t& bytes_transferred);
  154. #endif // defined(BOOST_ASIO_HAS_IOCP)
  155. BOOST_ASIO_DECL signed_size_type sendto(socket_type s, const buf* bufs,
  156. size_t count, int flags, const socket_addr_type* addr,
  157. std::size_t addrlen, boost::system::error_code& ec);
  158. BOOST_ASIO_DECL size_t sync_sendto(socket_type s, state_type state,
  159. const buf* bufs, size_t count, int flags, const socket_addr_type* addr,
  160. std::size_t addrlen, boost::system::error_code& ec);
  161. #if !defined(BOOST_ASIO_HAS_IOCP)
  162. BOOST_ASIO_DECL bool non_blocking_sendto(socket_type s,
  163. const buf* bufs, size_t count, int flags,
  164. const socket_addr_type* addr, std::size_t addrlen,
  165. boost::system::error_code& ec, size_t& bytes_transferred);
  166. #endif // !defined(BOOST_ASIO_HAS_IOCP)
  167. BOOST_ASIO_DECL socket_type socket(int af, int type, int protocol,
  168. boost::system::error_code& ec);
  169. BOOST_ASIO_DECL int setsockopt(socket_type s, state_type& state,
  170. int level, int optname, const void* optval,
  171. std::size_t optlen, boost::system::error_code& ec);
  172. BOOST_ASIO_DECL int getsockopt(socket_type s, state_type state,
  173. int level, int optname, void* optval,
  174. size_t* optlen, boost::system::error_code& ec);
  175. BOOST_ASIO_DECL int getpeername(socket_type s, socket_addr_type* addr,
  176. std::size_t* addrlen, bool cached, boost::system::error_code& ec);
  177. BOOST_ASIO_DECL int getsockname(socket_type s, socket_addr_type* addr,
  178. std::size_t* addrlen, boost::system::error_code& ec);
  179. BOOST_ASIO_DECL int ioctl(socket_type s, state_type& state,
  180. int cmd, ioctl_arg_type* arg, boost::system::error_code& ec);
  181. BOOST_ASIO_DECL int select(int nfds, fd_set* readfds, fd_set* writefds,
  182. fd_set* exceptfds, timeval* timeout, boost::system::error_code& ec);
  183. BOOST_ASIO_DECL int poll_read(socket_type s,
  184. state_type state, int msec, boost::system::error_code& ec);
  185. BOOST_ASIO_DECL int poll_write(socket_type s,
  186. state_type state, int msec, boost::system::error_code& ec);
  187. BOOST_ASIO_DECL int poll_error(socket_type s,
  188. state_type state, int msec, boost::system::error_code& ec);
  189. BOOST_ASIO_DECL int poll_connect(socket_type s,
  190. int msec, boost::system::error_code& ec);
  191. #endif // !defined(BOOST_ASIO_WINDOWS_RUNTIME)
  192. BOOST_ASIO_DECL const char* inet_ntop(int af, const void* src, char* dest,
  193. size_t length, unsigned long scope_id, boost::system::error_code& ec);
  194. BOOST_ASIO_DECL int inet_pton(int af, const char* src, void* dest,
  195. unsigned long* scope_id, boost::system::error_code& ec);
  196. BOOST_ASIO_DECL int gethostname(char* name,
  197. int namelen, boost::system::error_code& ec);
  198. #if !defined(BOOST_ASIO_WINDOWS_RUNTIME)
  199. BOOST_ASIO_DECL boost::system::error_code getaddrinfo(const char* host,
  200. const char* service, const addrinfo_type& hints,
  201. addrinfo_type** result, boost::system::error_code& ec);
  202. BOOST_ASIO_DECL boost::system::error_code background_getaddrinfo(
  203. const weak_cancel_token_type& cancel_token, const char* host,
  204. const char* service, const addrinfo_type& hints,
  205. addrinfo_type** result, boost::system::error_code& ec);
  206. BOOST_ASIO_DECL void freeaddrinfo(addrinfo_type* ai);
  207. BOOST_ASIO_DECL boost::system::error_code getnameinfo(
  208. const socket_addr_type* addr, std::size_t addrlen,
  209. char* host, std::size_t hostlen, char* serv,
  210. std::size_t servlen, int flags, boost::system::error_code& ec);
  211. BOOST_ASIO_DECL boost::system::error_code sync_getnameinfo(
  212. const socket_addr_type* addr, std::size_t addrlen,
  213. char* host, std::size_t hostlen, char* serv,
  214. std::size_t servlen, int sock_type, boost::system::error_code& ec);
  215. BOOST_ASIO_DECL boost::system::error_code background_getnameinfo(
  216. const weak_cancel_token_type& cancel_token,
  217. const socket_addr_type* addr, std::size_t addrlen,
  218. char* host, std::size_t hostlen, char* serv,
  219. std::size_t servlen, int sock_type, boost::system::error_code& ec);
  220. #endif // !defined(BOOST_ASIO_WINDOWS_RUNTIME)
  221. BOOST_ASIO_DECL u_long_type network_to_host_long(u_long_type value);
  222. BOOST_ASIO_DECL u_long_type host_to_network_long(u_long_type value);
  223. BOOST_ASIO_DECL u_short_type network_to_host_short(u_short_type value);
  224. BOOST_ASIO_DECL u_short_type host_to_network_short(u_short_type value);
  225. } // namespace socket_ops
  226. } // namespace detail
  227. } // namespace asio
  228. } // namespace boost
  229. #include <boost/asio/detail/pop_options.hpp>
  230. #if defined(BOOST_ASIO_HEADER_ONLY)
  231. # include <boost/asio/detail/impl/socket_ops.ipp>
  232. #endif // defined(BOOST_ASIO_HEADER_ONLY)
  233. #endif // BOOST_ASIO_DETAIL_SOCKET_OPS_HPP