// basic_socket.hpp
// ~~~~~~~~~~~~~~~~
//
-// Copyright (c) 2003-2018 Christopher M. Kohlhoff (chris at kohlhoff dot com)
+// Copyright (c) 2003-2019 Christopher M. Kohlhoff (chris at kohlhoff dot com)
//
// Distributed under the Boost Software License, Version 1.0. (See accompanying
// file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
#include <boost/asio/detail/config.hpp>
#include <boost/asio/async_result.hpp>
-#include <boost/asio/basic_io_object.hpp>
#include <boost/asio/detail/handler_type_requirements.hpp>
+#include <boost/asio/detail/io_object_impl.hpp>
+#include <boost/asio/detail/non_const_lvalue.hpp>
#include <boost/asio/detail/throw_error.hpp>
#include <boost/asio/detail/type_traits.hpp>
#include <boost/asio/error.hpp>
+#include <boost/asio/execution_context.hpp>
+#include <boost/asio/executor.hpp>
#include <boost/asio/post.hpp>
#include <boost/asio/socket_base.hpp>
+#if defined(BOOST_ASIO_WINDOWS_RUNTIME)
+# include <boost/asio/detail/null_socket_service.hpp>
+#elif defined(BOOST_ASIO_HAS_IOCP)
+# include <boost/asio/detail/win_iocp_socket_service.hpp>
+#else
+# include <boost/asio/detail/reactive_socket_service.hpp>
+#endif
+
#if defined(BOOST_ASIO_HAS_MOVE)
# include <utility>
#endif // defined(BOOST_ASIO_HAS_MOVE)
-#if !defined(BOOST_ASIO_ENABLE_OLD_SERVICES)
-# if defined(BOOST_ASIO_WINDOWS_RUNTIME)
-# include <boost/asio/detail/winrt_ssocket_service.hpp>
-# define BOOST_ASIO_SVC_T detail::winrt_ssocket_service<Protocol>
-# elif defined(BOOST_ASIO_HAS_IOCP)
-# include <boost/asio/detail/win_iocp_socket_service.hpp>
-# define BOOST_ASIO_SVC_T detail::win_iocp_socket_service<Protocol>
-# else
-# include <boost/asio/detail/reactive_socket_service.hpp>
-# define BOOST_ASIO_SVC_T detail::reactive_socket_service<Protocol>
-# endif
-#endif // !defined(BOOST_ASIO_ENABLE_OLD_SERVICES)
-
#include <boost/asio/detail/push_options.hpp>
namespace boost {
namespace asio {
+#if !defined(BOOST_ASIO_BASIC_SOCKET_FWD_DECL)
+#define BOOST_ASIO_BASIC_SOCKET_FWD_DECL
+
+// Forward declaration with defaulted arguments.
+template <typename Protocol, typename Executor = executor>
+class basic_socket;
+
+#endif // !defined(BOOST_ASIO_BASIC_SOCKET_FWD_DECL)
+
/// Provides socket functionality.
/**
* The basic_socket class template provides functionality that is common to both
* @e Distinct @e objects: Safe.@n
* @e Shared @e objects: Unsafe.
*/
-template <typename Protocol BOOST_ASIO_SVC_TPARAM>
+template <typename Protocol, typename Executor>
class basic_socket
- : BOOST_ASIO_SVC_ACCESS basic_io_object<BOOST_ASIO_SVC_T>,
- public socket_base
+ : public socket_base
{
public:
/// The type of the executor associated with the object.
- typedef io_context::executor_type executor_type;
+ typedef Executor executor_type;
+
+ /// Rebinds the socket type to another executor.
+ template <typename Executor1>
+ struct rebind_executor
+ {
+ /// The socket type when rebound to the specified executor.
+ typedef basic_socket<Protocol, Executor1> other;
+ };
/// The native representation of a socket.
#if defined(GENERATING_DOCUMENTATION)
typedef implementation_defined native_handle_type;
+#elif defined(BOOST_ASIO_WINDOWS_RUNTIME)
+ typedef typename detail::null_socket_service<
+ Protocol>::native_handle_type native_handle_type;
+#elif defined(BOOST_ASIO_HAS_IOCP)
+ typedef typename detail::win_iocp_socket_service<
+ Protocol>::native_handle_type native_handle_type;
#else
- typedef typename BOOST_ASIO_SVC_T::native_handle_type native_handle_type;
+ typedef typename detail::reactive_socket_service<
+ Protocol>::native_handle_type native_handle_type;
#endif
/// The protocol type.
#if !defined(BOOST_ASIO_NO_EXTENSIONS)
/// A basic_socket is always the lowest layer.
- typedef basic_socket<Protocol BOOST_ASIO_SVC_TARG> lowest_layer_type;
+ typedef basic_socket<Protocol, Executor> lowest_layer_type;
#endif // !defined(BOOST_ASIO_NO_EXTENSIONS)
/// Construct a basic_socket without opening it.
/**
* This constructor creates a socket without opening it.
*
- * @param io_context The io_context object that the socket will use to
+ * @param ex The I/O executor that the socket will use, by default, to
* dispatch handlers for any asynchronous operations performed on the socket.
*/
- explicit basic_socket(boost::asio::io_context& io_context)
- : basic_io_object<BOOST_ASIO_SVC_T>(io_context)
+ explicit basic_socket(const executor_type& ex)
+ : impl_(ex)
+ {
+ }
+
+ /// Construct a basic_socket without opening it.
+ /**
+ * This constructor creates a socket without opening it.
+ *
+ * @param context An execution context which provides the I/O executor that
+ * the socket will use, by default, to dispatch handlers for any asynchronous
+ * operations performed on the socket.
+ */
+ template <typename ExecutionContext>
+ explicit basic_socket(ExecutionContext& context,
+ typename enable_if<
+ is_convertible<ExecutionContext&, execution_context&>::value
+ >::type* = 0)
+ : impl_(context)
{
}
/**
* This constructor creates and opens a socket.
*
- * @param io_context The io_context object that the socket will use to
+ * @param ex The I/O executor that the socket will use, by default, to
* dispatch handlers for any asynchronous operations performed on the socket.
*
* @param protocol An object specifying protocol parameters to be used.
*
* @throws boost::system::system_error Thrown on failure.
*/
- basic_socket(boost::asio::io_context& io_context,
- const protocol_type& protocol)
- : basic_io_object<BOOST_ASIO_SVC_T>(io_context)
+ basic_socket(const executor_type& ex, const protocol_type& protocol)
+ : impl_(ex)
+ {
+ boost::system::error_code ec;
+ impl_.get_service().open(impl_.get_implementation(), protocol, ec);
+ boost::asio::detail::throw_error(ec, "open");
+ }
+
+ /// Construct and open a basic_socket.
+ /**
+ * This constructor creates and opens a socket.
+ *
+ * @param context An execution context which provides the I/O executor that
+ * the socket will use, by default, to dispatch handlers for any asynchronous
+ * operations performed on the socket.
+ *
+ * @param protocol An object specifying protocol parameters to be used.
+ *
+ * @throws boost::system::system_error Thrown on failure.
+ */
+ template <typename ExecutionContext>
+ basic_socket(ExecutionContext& context, const protocol_type& protocol,
+ typename enable_if<
+ is_convertible<ExecutionContext&, execution_context&>::value
+ >::type* = 0)
+ : impl_(context)
{
boost::system::error_code ec;
- this->get_service().open(this->get_implementation(), protocol, ec);
+ impl_.get_service().open(impl_.get_implementation(), protocol, ec);
boost::asio::detail::throw_error(ec, "open");
}
* specified endpoint on the local machine. The protocol used is the protocol
* associated with the given endpoint.
*
- * @param io_context The io_context object that the socket will use to
+ * @param ex The I/O executor that the socket will use, by default, to
* dispatch handlers for any asynchronous operations performed on the socket.
*
* @param endpoint An endpoint on the local machine to which the socket will
*
* @throws boost::system::system_error Thrown on failure.
*/
- basic_socket(boost::asio::io_context& io_context,
- const endpoint_type& endpoint)
- : basic_io_object<BOOST_ASIO_SVC_T>(io_context)
+ basic_socket(const executor_type& ex, const endpoint_type& endpoint)
+ : impl_(ex)
{
boost::system::error_code ec;
const protocol_type protocol = endpoint.protocol();
- this->get_service().open(this->get_implementation(), protocol, ec);
+ impl_.get_service().open(impl_.get_implementation(), protocol, ec);
boost::asio::detail::throw_error(ec, "open");
- this->get_service().bind(this->get_implementation(), endpoint, ec);
+ impl_.get_service().bind(impl_.get_implementation(), endpoint, ec);
+ boost::asio::detail::throw_error(ec, "bind");
+ }
+
+ /// Construct a basic_socket, opening it and binding it to the given local
+ /// endpoint.
+ /**
+ * This constructor creates a socket and automatically opens it bound to the
+ * specified endpoint on the local machine. The protocol used is the protocol
+ * associated with the given endpoint.
+ *
+ * @param context An execution context which provides the I/O executor that
+ * the socket will use, by default, to dispatch handlers for any asynchronous
+ * operations performed on the socket.
+ *
+ * @param endpoint An endpoint on the local machine to which the socket will
+ * be bound.
+ *
+ * @throws boost::system::system_error Thrown on failure.
+ */
+ template <typename ExecutionContext>
+ basic_socket(ExecutionContext& context, const endpoint_type& endpoint,
+ typename enable_if<
+ is_convertible<ExecutionContext&, execution_context&>::value
+ >::type* = 0)
+ : impl_(context)
+ {
+ boost::system::error_code ec;
+ const protocol_type protocol = endpoint.protocol();
+ impl_.get_service().open(impl_.get_implementation(), protocol, ec);
+ boost::asio::detail::throw_error(ec, "open");
+ impl_.get_service().bind(impl_.get_implementation(), endpoint, ec);
boost::asio::detail::throw_error(ec, "bind");
}
/**
* This constructor creates a socket object to hold an existing native socket.
*
- * @param io_context The io_context object that the socket will use to
+ * @param ex The I/O executor that the socket will use, by default, to
* dispatch handlers for any asynchronous operations performed on the socket.
*
* @param protocol An object specifying protocol parameters to be used.
*
* @throws boost::system::system_error Thrown on failure.
*/
- basic_socket(boost::asio::io_context& io_context,
- const protocol_type& protocol, const native_handle_type& native_socket)
- : basic_io_object<BOOST_ASIO_SVC_T>(io_context)
+ basic_socket(const executor_type& ex, const protocol_type& protocol,
+ const native_handle_type& native_socket)
+ : impl_(ex)
+ {
+ boost::system::error_code ec;
+ impl_.get_service().assign(impl_.get_implementation(),
+ protocol, native_socket, ec);
+ boost::asio::detail::throw_error(ec, "assign");
+ }
+
+ /// Construct a basic_socket on an existing native socket.
+ /**
+ * This constructor creates a socket object to hold an existing native socket.
+ *
+ * @param context An execution context which provides the I/O executor that
+ * the socket will use, by default, to dispatch handlers for any asynchronous
+ * operations performed on the socket.
+ *
+ * @param protocol An object specifying protocol parameters to be used.
+ *
+ * @param native_socket A native socket.
+ *
+ * @throws boost::system::system_error Thrown on failure.
+ */
+ template <typename ExecutionContext>
+ basic_socket(ExecutionContext& context, const protocol_type& protocol,
+ const native_handle_type& native_socket,
+ typename enable_if<
+ is_convertible<ExecutionContext&, execution_context&>::value
+ >::type* = 0)
+ : impl_(context)
{
boost::system::error_code ec;
- this->get_service().assign(this->get_implementation(),
+ impl_.get_service().assign(impl_.get_implementation(),
protocol, native_socket, ec);
boost::asio::detail::throw_error(ec, "assign");
}
* occur.
*
* @note Following the move, the moved-from object is in the same state as if
- * constructed using the @c basic_socket(io_context&) constructor.
+ * constructed using the @c basic_socket(const executor_type&) constructor.
*/
- basic_socket(basic_socket&& other)
- : basic_io_object<BOOST_ASIO_SVC_T>(std::move(other))
+ basic_socket(basic_socket&& other) BOOST_ASIO_NOEXCEPT
+ : impl_(std::move(other.impl_))
{
}
* occur.
*
* @note Following the move, the moved-from object is in the same state as if
- * constructed using the @c basic_socket(io_context&) constructor.
+ * constructed using the @c basic_socket(const executor_type&) constructor.
*/
basic_socket& operator=(basic_socket&& other)
{
- basic_io_object<BOOST_ASIO_SVC_T>::operator=(std::move(other));
+ impl_ = std::move(other.impl_);
return *this;
}
// All sockets have access to each other's implementations.
- template <typename Protocol1 BOOST_ASIO_SVC_TPARAM1>
+ template <typename Protocol1, typename Executor1>
friend class basic_socket;
/// Move-construct a basic_socket from a socket of another protocol type.
* occur.
*
* @note Following the move, the moved-from object is in the same state as if
- * constructed using the @c basic_socket(io_context&) constructor.
+ * constructed using the @c basic_socket(const executor_type&) constructor.
*/
- template <typename Protocol1 BOOST_ASIO_SVC_TPARAM1>
- basic_socket(basic_socket<Protocol1 BOOST_ASIO_SVC_TARG1>&& other,
- typename enable_if<is_convertible<Protocol1, Protocol>::value>::type* = 0)
- : basic_io_object<BOOST_ASIO_SVC_T>(
- other.get_service(), other.get_implementation())
+ template <typename Protocol1, typename Executor1>
+ basic_socket(basic_socket<Protocol1, Executor1>&& other,
+ typename enable_if<
+ is_convertible<Protocol1, Protocol>::value
+ && is_convertible<Executor1, Executor>::value
+ >::type* = 0)
+ : impl_(std::move(other.impl_))
{
}
* occur.
*
* @note Following the move, the moved-from object is in the same state as if
- * constructed using the @c basic_socket(io_context&) constructor.
+ * constructed using the @c basic_socket(const executor_type&) constructor.
*/
- template <typename Protocol1 BOOST_ASIO_SVC_TPARAM1>
- typename enable_if<is_convertible<Protocol1, Protocol>::value,
- basic_socket>::type& operator=(
- basic_socket<Protocol1 BOOST_ASIO_SVC_TARG1>&& other)
+ template <typename Protocol1, typename Executor1>
+ typename enable_if<
+ is_convertible<Protocol1, Protocol>::value
+ && is_convertible<Executor1, Executor>::value,
+ basic_socket&
+ >::type operator=(basic_socket<Protocol1, Executor1> && other)
{
basic_socket tmp(std::move(other));
- basic_io_object<BOOST_ASIO_SVC_T>::operator=(std::move(tmp));
+ impl_ = std::move(tmp.impl_);
return *this;
}
#endif // defined(BOOST_ASIO_HAS_MOVE) || defined(GENERATING_DOCUMENTATION)
-#if defined(BOOST_ASIO_ENABLE_OLD_SERVICES)
- // These functions are provided by basic_io_object<>.
-#else // defined(BOOST_ASIO_ENABLE_OLD_SERVICES)
-#if !defined(BOOST_ASIO_NO_DEPRECATED)
- /// (Deprecated: Use get_executor().) Get the io_context associated with the
- /// object.
- /**
- * This function may be used to obtain the io_context object that the I/O
- * object uses to dispatch handlers for asynchronous operations.
- *
- * @return A reference to the io_context object that the I/O object will use
- * to dispatch handlers. Ownership is not transferred to the caller.
- */
- boost::asio::io_context& get_io_context()
- {
- return basic_io_object<BOOST_ASIO_SVC_T>::get_io_context();
- }
-
- /// (Deprecated: Use get_executor().) Get the io_context associated with the
- /// object.
- /**
- * This function may be used to obtain the io_context object that the I/O
- * object uses to dispatch handlers for asynchronous operations.
- *
- * @return A reference to the io_context object that the I/O object will use
- * to dispatch handlers. Ownership is not transferred to the caller.
- */
- boost::asio::io_context& get_io_service()
- {
- return basic_io_object<BOOST_ASIO_SVC_T>::get_io_service();
- }
-#endif // !defined(BOOST_ASIO_NO_DEPRECATED)
-
/// Get the executor associated with the object.
executor_type get_executor() BOOST_ASIO_NOEXCEPT
{
- return basic_io_object<BOOST_ASIO_SVC_T>::get_executor();
+ return impl_.get_executor();
}
-#endif // defined(BOOST_ASIO_ENABLE_OLD_SERVICES)
#if !defined(BOOST_ASIO_NO_EXTENSIONS)
/// Get a reference to the lowest layer.
*
* @par Example
* @code
- * boost::asio::ip::tcp::socket socket(io_context);
+ * boost::asio::ip::tcp::socket socket(my_context);
* socket.open(boost::asio::ip::tcp::v4());
* @endcode
*/
void open(const protocol_type& protocol = protocol_type())
{
boost::system::error_code ec;
- this->get_service().open(this->get_implementation(), protocol, ec);
+ impl_.get_service().open(impl_.get_implementation(), protocol, ec);
boost::asio::detail::throw_error(ec, "open");
}
*
* @par Example
* @code
- * boost::asio::ip::tcp::socket socket(io_context);
+ * boost::asio::ip::tcp::socket socket(my_context);
* boost::system::error_code ec;
* socket.open(boost::asio::ip::tcp::v4(), ec);
* if (ec)
BOOST_ASIO_SYNC_OP_VOID open(const protocol_type& protocol,
boost::system::error_code& ec)
{
- this->get_service().open(this->get_implementation(), protocol, ec);
+ impl_.get_service().open(impl_.get_implementation(), protocol, ec);
BOOST_ASIO_SYNC_OP_VOID_RETURN(ec);
}
const native_handle_type& native_socket)
{
boost::system::error_code ec;
- this->get_service().assign(this->get_implementation(),
+ impl_.get_service().assign(impl_.get_implementation(),
protocol, native_socket, ec);
boost::asio::detail::throw_error(ec, "assign");
}
BOOST_ASIO_SYNC_OP_VOID assign(const protocol_type& protocol,
const native_handle_type& native_socket, boost::system::error_code& ec)
{
- this->get_service().assign(this->get_implementation(),
+ impl_.get_service().assign(impl_.get_implementation(),
protocol, native_socket, ec);
BOOST_ASIO_SYNC_OP_VOID_RETURN(ec);
}
/// Determine whether the socket is open.
bool is_open() const
{
- return this->get_service().is_open(this->get_implementation());
+ return impl_.get_service().is_open(impl_.get_implementation());
}
/// Close the socket.
void close()
{
boost::system::error_code ec;
- this->get_service().close(this->get_implementation(), ec);
+ impl_.get_service().close(impl_.get_implementation(), ec);
boost::asio::detail::throw_error(ec, "close");
}
*
* @par Example
* @code
- * boost::asio::ip::tcp::socket socket(io_context);
+ * boost::asio::ip::tcp::socket socket(my_context);
* ...
* boost::system::error_code ec;
* socket.close(ec);
*/
BOOST_ASIO_SYNC_OP_VOID close(boost::system::error_code& ec)
{
- this->get_service().close(this->get_implementation(), ec);
+ impl_.get_service().close(impl_.get_implementation(), ec);
BOOST_ASIO_SYNC_OP_VOID_RETURN(ec);
}
native_handle_type release()
{
boost::system::error_code ec;
- native_handle_type s = this->get_service().release(
- this->get_implementation(), ec);
+ native_handle_type s = impl_.get_service().release(
+ impl_.get_implementation(), ec);
boost::asio::detail::throw_error(ec, "release");
return s;
}
#endif
native_handle_type release(boost::system::error_code& ec)
{
- return this->get_service().release(this->get_implementation(), ec);
+ return impl_.get_service().release(impl_.get_implementation(), ec);
}
/// Get the native socket representation.
*/
native_handle_type native_handle()
{
- return this->get_service().native_handle(this->get_implementation());
+ return impl_.get_service().native_handle(impl_.get_implementation());
}
/// Cancel all asynchronous operations associated with the socket.
void cancel()
{
boost::system::error_code ec;
- this->get_service().cancel(this->get_implementation(), ec);
+ impl_.get_service().cancel(impl_.get_implementation(), ec);
boost::asio::detail::throw_error(ec, "cancel");
}
#endif
BOOST_ASIO_SYNC_OP_VOID cancel(boost::system::error_code& ec)
{
- this->get_service().cancel(this->get_implementation(), ec);
+ impl_.get_service().cancel(impl_.get_implementation(), ec);
BOOST_ASIO_SYNC_OP_VOID_RETURN(ec);
}
bool at_mark() const
{
boost::system::error_code ec;
- bool b = this->get_service().at_mark(this->get_implementation(), ec);
+ bool b = impl_.get_service().at_mark(impl_.get_implementation(), ec);
boost::asio::detail::throw_error(ec, "at_mark");
return b;
}
*/
bool at_mark(boost::system::error_code& ec) const
{
- return this->get_service().at_mark(this->get_implementation(), ec);
+ return impl_.get_service().at_mark(impl_.get_implementation(), ec);
}
/// Determine the number of bytes available for reading.
std::size_t available() const
{
boost::system::error_code ec;
- std::size_t s = this->get_service().available(
- this->get_implementation(), ec);
+ std::size_t s = impl_.get_service().available(
+ impl_.get_implementation(), ec);
boost::asio::detail::throw_error(ec, "available");
return s;
}
*/
std::size_t available(boost::system::error_code& ec) const
{
- return this->get_service().available(this->get_implementation(), ec);
+ return impl_.get_service().available(impl_.get_implementation(), ec);
}
/// Bind the socket to the given local endpoint.
*
* @par Example
* @code
- * boost::asio::ip::tcp::socket socket(io_context);
+ * boost::asio::ip::tcp::socket socket(my_context);
* socket.open(boost::asio::ip::tcp::v4());
* socket.bind(boost::asio::ip::tcp::endpoint(
* boost::asio::ip::tcp::v4(), 12345));
void bind(const endpoint_type& endpoint)
{
boost::system::error_code ec;
- this->get_service().bind(this->get_implementation(), endpoint, ec);
+ impl_.get_service().bind(impl_.get_implementation(), endpoint, ec);
boost::asio::detail::throw_error(ec, "bind");
}
*
* @par Example
* @code
- * boost::asio::ip::tcp::socket socket(io_context);
+ * boost::asio::ip::tcp::socket socket(my_context);
* socket.open(boost::asio::ip::tcp::v4());
* boost::system::error_code ec;
* socket.bind(boost::asio::ip::tcp::endpoint(
BOOST_ASIO_SYNC_OP_VOID bind(const endpoint_type& endpoint,
boost::system::error_code& ec)
{
- this->get_service().bind(this->get_implementation(), endpoint, ec);
+ impl_.get_service().bind(impl_.get_implementation(), endpoint, ec);
BOOST_ASIO_SYNC_OP_VOID_RETURN(ec);
}
*
* @par Example
* @code
- * boost::asio::ip::tcp::socket socket(io_context);
+ * boost::asio::ip::tcp::socket socket(my_context);
* boost::asio::ip::tcp::endpoint endpoint(
* boost::asio::ip::address::from_string("1.2.3.4"), 12345);
* socket.connect(endpoint);
boost::system::error_code ec;
if (!is_open())
{
- this->get_service().open(this->get_implementation(),
+ impl_.get_service().open(impl_.get_implementation(),
peer_endpoint.protocol(), ec);
boost::asio::detail::throw_error(ec, "connect");
}
- this->get_service().connect(this->get_implementation(), peer_endpoint, ec);
+ impl_.get_service().connect(impl_.get_implementation(), peer_endpoint, ec);
boost::asio::detail::throw_error(ec, "connect");
}
*
* @par Example
* @code
- * boost::asio::ip::tcp::socket socket(io_context);
+ * boost::asio::ip::tcp::socket socket(my_context);
* boost::asio::ip::tcp::endpoint endpoint(
* boost::asio::ip::address::from_string("1.2.3.4"), 12345);
* boost::system::error_code ec;
{
if (!is_open())
{
- this->get_service().open(this->get_implementation(),
+ impl_.get_service().open(impl_.get_implementation(),
peer_endpoint.protocol(), ec);
if (ec)
{
}
}
- this->get_service().connect(this->get_implementation(), peer_endpoint, ec);
+ impl_.get_service().connect(impl_.get_implementation(), peer_endpoint, ec);
BOOST_ASIO_SYNC_OP_VOID_RETURN(ec);
}
* const boost::system::error_code& error // Result of operation
* ); @endcode
* Regardless of whether the asynchronous operation completes immediately or
- * not, the handler will not be invoked from within this function. Invocation
- * of the handler will be performed in a manner equivalent to using
- * boost::asio::io_context::post().
+ * not, the handler will not be invoked from within this function. On
+ * immediate completion, invocation of the handler will be performed in a
+ * manner equivalent to using boost::asio::post().
*
* @par Example
* @code
*
* ...
*
- * boost::asio::ip::tcp::socket socket(io_context);
+ * boost::asio::ip::tcp::socket socket(my_context);
* boost::asio::ip::tcp::endpoint endpoint(
* boost::asio::ip::address::from_string("1.2.3.4"), 12345);
* socket.async_connect(endpoint, connect_handler);
* @endcode
*/
- template <typename ConnectHandler>
- BOOST_ASIO_INITFN_RESULT_TYPE(ConnectHandler,
+ template <
+ BOOST_ASIO_COMPLETION_TOKEN_FOR(void (boost::system::error_code))
+ ConnectHandler BOOST_ASIO_DEFAULT_COMPLETION_TOKEN_TYPE(executor_type)>
+ BOOST_ASIO_INITFN_AUTO_RESULT_TYPE(ConnectHandler,
void (boost::system::error_code))
async_connect(const endpoint_type& peer_endpoint,
- BOOST_ASIO_MOVE_ARG(ConnectHandler) handler)
+ BOOST_ASIO_MOVE_ARG(ConnectHandler) handler
+ BOOST_ASIO_DEFAULT_COMPLETION_TOKEN(executor_type))
{
- // If you get an error on the following line it means that your handler does
- // not meet the documented type requirements for a ConnectHandler.
- BOOST_ASIO_CONNECT_HANDLER_CHECK(ConnectHandler, handler) type_check;
-
+ boost::system::error_code open_ec;
if (!is_open())
{
- boost::system::error_code ec;
const protocol_type protocol = peer_endpoint.protocol();
- this->get_service().open(this->get_implementation(), protocol, ec);
- if (ec)
- {
- async_completion<ConnectHandler,
- void (boost::system::error_code)> init(handler);
-
- boost::asio::post(this->get_executor(),
- boost::asio::detail::bind_handler(
- BOOST_ASIO_MOVE_CAST(BOOST_ASIO_HANDLER_TYPE(
- ConnectHandler, void (boost::system::error_code)))(
- init.completion_handler), ec));
-
- return init.result.get();
- }
+ impl_.get_service().open(impl_.get_implementation(), protocol, open_ec);
}
-#if defined(BOOST_ASIO_ENABLE_OLD_SERVICES)
- return this->get_service().async_connect(this->get_implementation(),
- peer_endpoint, BOOST_ASIO_MOVE_CAST(ConnectHandler)(handler));
-#else // defined(BOOST_ASIO_ENABLE_OLD_SERVICES)
- async_completion<ConnectHandler,
- void (boost::system::error_code)> init(handler);
-
- this->get_service().async_connect(
- this->get_implementation(), peer_endpoint, init.completion_handler);
-
- return init.result.get();
-#endif // defined(BOOST_ASIO_ENABLE_OLD_SERVICES)
+ return async_initiate<ConnectHandler, void (boost::system::error_code)>(
+ initiate_async_connect(this), handler, peer_endpoint, open_ec);
}
/// Set an option on the socket.
* @par Example
* Setting the IPPROTO_TCP/TCP_NODELAY option:
* @code
- * boost::asio::ip::tcp::socket socket(io_context);
+ * boost::asio::ip::tcp::socket socket(my_context);
* ...
* boost::asio::ip::tcp::no_delay option(true);
* socket.set_option(option);
void set_option(const SettableSocketOption& option)
{
boost::system::error_code ec;
- this->get_service().set_option(this->get_implementation(), option, ec);
+ impl_.get_service().set_option(impl_.get_implementation(), option, ec);
boost::asio::detail::throw_error(ec, "set_option");
}
* @par Example
* Setting the IPPROTO_TCP/TCP_NODELAY option:
* @code
- * boost::asio::ip::tcp::socket socket(io_context);
+ * boost::asio::ip::tcp::socket socket(my_context);
* ...
* boost::asio::ip::tcp::no_delay option(true);
* boost::system::error_code ec;
BOOST_ASIO_SYNC_OP_VOID set_option(const SettableSocketOption& option,
boost::system::error_code& ec)
{
- this->get_service().set_option(this->get_implementation(), option, ec);
+ impl_.get_service().set_option(impl_.get_implementation(), option, ec);
BOOST_ASIO_SYNC_OP_VOID_RETURN(ec);
}
* @par Example
* Getting the value of the SOL_SOCKET/SO_KEEPALIVE option:
* @code
- * boost::asio::ip::tcp::socket socket(io_context);
+ * boost::asio::ip::tcp::socket socket(my_context);
* ...
* boost::asio::ip::tcp::socket::keep_alive option;
* socket.get_option(option);
void get_option(GettableSocketOption& option) const
{
boost::system::error_code ec;
- this->get_service().get_option(this->get_implementation(), option, ec);
+ impl_.get_service().get_option(impl_.get_implementation(), option, ec);
boost::asio::detail::throw_error(ec, "get_option");
}
* @par Example
* Getting the value of the SOL_SOCKET/SO_KEEPALIVE option:
* @code
- * boost::asio::ip::tcp::socket socket(io_context);
+ * boost::asio::ip::tcp::socket socket(my_context);
* ...
* boost::asio::ip::tcp::socket::keep_alive option;
* boost::system::error_code ec;
BOOST_ASIO_SYNC_OP_VOID get_option(GettableSocketOption& option,
boost::system::error_code& ec) const
{
- this->get_service().get_option(this->get_implementation(), option, ec);
+ impl_.get_service().get_option(impl_.get_implementation(), option, ec);
BOOST_ASIO_SYNC_OP_VOID_RETURN(ec);
}
* @par Example
* Getting the number of bytes ready to read:
* @code
- * boost::asio::ip::tcp::socket socket(io_context);
+ * boost::asio::ip::tcp::socket socket(my_context);
* ...
* boost::asio::ip::tcp::socket::bytes_readable command;
* socket.io_control(command);
void io_control(IoControlCommand& command)
{
boost::system::error_code ec;
- this->get_service().io_control(this->get_implementation(), command, ec);
+ impl_.get_service().io_control(impl_.get_implementation(), command, ec);
boost::asio::detail::throw_error(ec, "io_control");
}
* @par Example
* Getting the number of bytes ready to read:
* @code
- * boost::asio::ip::tcp::socket socket(io_context);
+ * boost::asio::ip::tcp::socket socket(my_context);
* ...
* boost::asio::ip::tcp::socket::bytes_readable command;
* boost::system::error_code ec;
BOOST_ASIO_SYNC_OP_VOID io_control(IoControlCommand& command,
boost::system::error_code& ec)
{
- this->get_service().io_control(this->get_implementation(), command, ec);
+ impl_.get_service().io_control(impl_.get_implementation(), command, ec);
BOOST_ASIO_SYNC_OP_VOID_RETURN(ec);
}
*/
bool non_blocking() const
{
- return this->get_service().non_blocking(this->get_implementation());
+ return impl_.get_service().non_blocking(impl_.get_implementation());
}
/// Sets the non-blocking mode of the socket.
void non_blocking(bool mode)
{
boost::system::error_code ec;
- this->get_service().non_blocking(this->get_implementation(), mode, ec);
+ impl_.get_service().non_blocking(impl_.get_implementation(), mode, ec);
boost::asio::detail::throw_error(ec, "non_blocking");
}
BOOST_ASIO_SYNC_OP_VOID non_blocking(
bool mode, boost::system::error_code& ec)
{
- this->get_service().non_blocking(this->get_implementation(), mode, ec);
+ impl_.get_service().non_blocking(impl_.get_implementation(), mode, ec);
BOOST_ASIO_SYNC_OP_VOID_RETURN(ec);
}
*/
bool native_non_blocking() const
{
- return this->get_service().native_non_blocking(this->get_implementation());
+ return impl_.get_service().native_non_blocking(impl_.get_implementation());
}
/// Sets the non-blocking mode of the native socket implementation.
void native_non_blocking(bool mode)
{
boost::system::error_code ec;
- this->get_service().native_non_blocking(
- this->get_implementation(), mode, ec);
+ impl_.get_service().native_non_blocking(
+ impl_.get_implementation(), mode, ec);
boost::asio::detail::throw_error(ec, "native_non_blocking");
}
BOOST_ASIO_SYNC_OP_VOID native_non_blocking(
bool mode, boost::system::error_code& ec)
{
- this->get_service().native_non_blocking(
- this->get_implementation(), mode, ec);
+ impl_.get_service().native_non_blocking(
+ impl_.get_implementation(), mode, ec);
BOOST_ASIO_SYNC_OP_VOID_RETURN(ec);
}
*
* @par Example
* @code
- * boost::asio::ip::tcp::socket socket(io_context);
+ * boost::asio::ip::tcp::socket socket(my_context);
* ...
* boost::asio::ip::tcp::endpoint endpoint = socket.local_endpoint();
* @endcode
endpoint_type local_endpoint() const
{
boost::system::error_code ec;
- endpoint_type ep = this->get_service().local_endpoint(
- this->get_implementation(), ec);
+ endpoint_type ep = impl_.get_service().local_endpoint(
+ impl_.get_implementation(), ec);
boost::asio::detail::throw_error(ec, "local_endpoint");
return ep;
}
*
* @par Example
* @code
- * boost::asio::ip::tcp::socket socket(io_context);
+ * boost::asio::ip::tcp::socket socket(my_context);
* ...
* boost::system::error_code ec;
* boost::asio::ip::tcp::endpoint endpoint = socket.local_endpoint(ec);
*/
endpoint_type local_endpoint(boost::system::error_code& ec) const
{
- return this->get_service().local_endpoint(this->get_implementation(), ec);
+ return impl_.get_service().local_endpoint(impl_.get_implementation(), ec);
}
/// Get the remote endpoint of the socket.
*
* @par Example
* @code
- * boost::asio::ip::tcp::socket socket(io_context);
+ * boost::asio::ip::tcp::socket socket(my_context);
* ...
* boost::asio::ip::tcp::endpoint endpoint = socket.remote_endpoint();
* @endcode
endpoint_type remote_endpoint() const
{
boost::system::error_code ec;
- endpoint_type ep = this->get_service().remote_endpoint(
- this->get_implementation(), ec);
+ endpoint_type ep = impl_.get_service().remote_endpoint(
+ impl_.get_implementation(), ec);
boost::asio::detail::throw_error(ec, "remote_endpoint");
return ep;
}
*
* @par Example
* @code
- * boost::asio::ip::tcp::socket socket(io_context);
+ * boost::asio::ip::tcp::socket socket(my_context);
* ...
* boost::system::error_code ec;
* boost::asio::ip::tcp::endpoint endpoint = socket.remote_endpoint(ec);
*/
endpoint_type remote_endpoint(boost::system::error_code& ec) const
{
- return this->get_service().remote_endpoint(this->get_implementation(), ec);
+ return impl_.get_service().remote_endpoint(impl_.get_implementation(), ec);
}
/// Disable sends or receives on the socket.
* @par Example
* Shutting down the send side of the socket:
* @code
- * boost::asio::ip::tcp::socket socket(io_context);
+ * boost::asio::ip::tcp::socket socket(my_context);
* ...
* socket.shutdown(boost::asio::ip::tcp::socket::shutdown_send);
* @endcode
void shutdown(shutdown_type what)
{
boost::system::error_code ec;
- this->get_service().shutdown(this->get_implementation(), what, ec);
+ impl_.get_service().shutdown(impl_.get_implementation(), what, ec);
boost::asio::detail::throw_error(ec, "shutdown");
}
* @par Example
* Shutting down the send side of the socket:
* @code
- * boost::asio::ip::tcp::socket socket(io_context);
+ * boost::asio::ip::tcp::socket socket(my_context);
* ...
* boost::system::error_code ec;
* socket.shutdown(boost::asio::ip::tcp::socket::shutdown_send, ec);
BOOST_ASIO_SYNC_OP_VOID shutdown(shutdown_type what,
boost::system::error_code& ec)
{
- this->get_service().shutdown(this->get_implementation(), what, ec);
+ impl_.get_service().shutdown(impl_.get_implementation(), what, ec);
BOOST_ASIO_SYNC_OP_VOID_RETURN(ec);
}
* @par Example
* Waiting for a socket to become readable.
* @code
- * boost::asio::ip::tcp::socket socket(io_context);
+ * boost::asio::ip::tcp::socket socket(my_context);
* ...
* socket.wait(boost::asio::ip::tcp::socket::wait_read);
* @endcode
void wait(wait_type w)
{
boost::system::error_code ec;
- this->get_service().wait(this->get_implementation(), w, ec);
+ impl_.get_service().wait(impl_.get_implementation(), w, ec);
boost::asio::detail::throw_error(ec, "wait");
}
* @par Example
* Waiting for a socket to become readable.
* @code
- * boost::asio::ip::tcp::socket socket(io_context);
+ * boost::asio::ip::tcp::socket socket(my_context);
* ...
* boost::system::error_code ec;
* socket.wait(boost::asio::ip::tcp::socket::wait_read, ec);
*/
BOOST_ASIO_SYNC_OP_VOID wait(wait_type w, boost::system::error_code& ec)
{
- this->get_service().wait(this->get_implementation(), w, ec);
+ impl_.get_service().wait(impl_.get_implementation(), w, ec);
BOOST_ASIO_SYNC_OP_VOID_RETURN(ec);
}
* const boost::system::error_code& error // Result of operation
* ); @endcode
* Regardless of whether the asynchronous operation completes immediately or
- * not, the handler will not be invoked from within this function. Invocation
- * of the handler will be performed in a manner equivalent to using
- * boost::asio::io_context::post().
+ * not, the handler will not be invoked from within this function. On
+ * immediate completion, invocation of the handler will be performed in a
+ * manner equivalent to using boost::asio::post().
*
* @par Example
* @code
*
* ...
*
- * boost::asio::ip::tcp::socket socket(io_context);
+ * boost::asio::ip::tcp::socket socket(my_context);
* ...
* socket.async_wait(boost::asio::ip::tcp::socket::wait_read, wait_handler);
* @endcode
*/
- template <typename WaitHandler>
- BOOST_ASIO_INITFN_RESULT_TYPE(WaitHandler,
+ template <
+ BOOST_ASIO_COMPLETION_TOKEN_FOR(void (boost::system::error_code))
+ WaitHandler BOOST_ASIO_DEFAULT_COMPLETION_TOKEN_TYPE(executor_type)>
+ BOOST_ASIO_INITFN_AUTO_RESULT_TYPE(WaitHandler,
void (boost::system::error_code))
- async_wait(wait_type w, BOOST_ASIO_MOVE_ARG(WaitHandler) handler)
+ async_wait(wait_type w,
+ BOOST_ASIO_MOVE_ARG(WaitHandler) handler
+ BOOST_ASIO_DEFAULT_COMPLETION_TOKEN(executor_type))
{
- // If you get an error on the following line it means that your handler does
- // not meet the documented type requirements for a WaitHandler.
- BOOST_ASIO_WAIT_HANDLER_CHECK(WaitHandler, handler) type_check;
-
-#if defined(BOOST_ASIO_ENABLE_OLD_SERVICES)
- return this->get_service().async_wait(this->get_implementation(),
- w, BOOST_ASIO_MOVE_CAST(WaitHandler)(handler));
-#else // defined(BOOST_ASIO_ENABLE_OLD_SERVICES)
- async_completion<WaitHandler,
- void (boost::system::error_code)> init(handler);
-
- this->get_service().async_wait(this->get_implementation(),
- w, init.completion_handler);
-
- return init.result.get();
-#endif // defined(BOOST_ASIO_ENABLE_OLD_SERVICES)
+ return async_initiate<WaitHandler, void (boost::system::error_code)>(
+ initiate_async_wait(this), handler, w);
}
protected:
{
}
+#if defined(BOOST_ASIO_WINDOWS_RUNTIME)
+ detail::io_object_impl<
+ detail::null_socket_service<Protocol>, Executor> impl_;
+#elif defined(BOOST_ASIO_HAS_IOCP)
+ detail::io_object_impl<
+ detail::win_iocp_socket_service<Protocol>, Executor> impl_;
+#else
+ detail::io_object_impl<
+ detail::reactive_socket_service<Protocol>, Executor> impl_;
+#endif
+
private:
// Disallow copying and assignment.
basic_socket(const basic_socket&) BOOST_ASIO_DELETED;
basic_socket& operator=(const basic_socket&) BOOST_ASIO_DELETED;
+
+ class initiate_async_connect
+ {
+ public:
+ typedef Executor executor_type;
+
+ explicit initiate_async_connect(basic_socket* self)
+ : self_(self)
+ {
+ }
+
+ executor_type get_executor() const BOOST_ASIO_NOEXCEPT
+ {
+ return self_->get_executor();
+ }
+
+ template <typename ConnectHandler>
+ void operator()(BOOST_ASIO_MOVE_ARG(ConnectHandler) handler,
+ const endpoint_type& peer_endpoint,
+ const boost::system::error_code& open_ec) const
+ {
+ // If you get an error on the following line it means that your handler
+ // does not meet the documented type requirements for a ConnectHandler.
+ BOOST_ASIO_CONNECT_HANDLER_CHECK(ConnectHandler, handler) type_check;
+
+ if (open_ec)
+ {
+ boost::asio::post(self_->impl_.get_executor(),
+ boost::asio::detail::bind_handler(
+ BOOST_ASIO_MOVE_CAST(ConnectHandler)(handler), open_ec));
+ }
+ else
+ {
+ detail::non_const_lvalue<ConnectHandler> handler2(handler);
+ self_->impl_.get_service().async_connect(
+ self_->impl_.get_implementation(), peer_endpoint,
+ handler2.value, self_->impl_.get_implementation_executor());
+ }
+ }
+
+ private:
+ basic_socket* self_;
+ };
+
+ class initiate_async_wait
+ {
+ public:
+ typedef Executor executor_type;
+
+ explicit initiate_async_wait(basic_socket* self)
+ : self_(self)
+ {
+ }
+
+ executor_type get_executor() const BOOST_ASIO_NOEXCEPT
+ {
+ return self_->get_executor();
+ }
+
+ template <typename WaitHandler>
+ void operator()(BOOST_ASIO_MOVE_ARG(WaitHandler) handler, wait_type w) const
+ {
+ // If you get an error on the following line it means that your handler
+ // does not meet the documented type requirements for a WaitHandler.
+ BOOST_ASIO_WAIT_HANDLER_CHECK(WaitHandler, handler) type_check;
+
+ detail::non_const_lvalue<WaitHandler> handler2(handler);
+ self_->impl_.get_service().async_wait(
+ self_->impl_.get_implementation(), w, handler2.value,
+ self_->impl_.get_implementation_executor());
+ }
+
+ private:
+ basic_socket* self_;
+ };
};
} // namespace asio
#include <boost/asio/detail/pop_options.hpp>
-#if !defined(BOOST_ASIO_ENABLE_OLD_SERVICES)
-# undef BOOST_ASIO_SVC_T
-#endif // !defined(BOOST_ASIO_ENABLE_OLD_SERVICES)
-
#endif // BOOST_ASIO_BASIC_SOCKET_HPP
projects / ceph.git / blobdiff