boost/asio/basic_socket_acceptor.hpp
//
// basic_socket_acceptor.hpp
// ~~~~~~~~~~~~~~~~~~~~~~~~~
//
// Copyright (c) 2003-2018 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)
//
#ifndef BOOST_ASIO_BASIC_SOCKET_ACCEPTOR_HPP
#define BOOST_ASIO_BASIC_SOCKET_ACCEPTOR_HPP
#if defined(_MSC_VER) && (_MSC_VER >= 1200)
# pragma once
#endif // defined(_MSC_VER) && (_MSC_VER >= 1200)
#include <boost/asio/detail/config.hpp>
#include <boost/asio/basic_io_object.hpp>
#include <boost/asio/basic_socket.hpp>
#include <boost/asio/detail/handler_type_requirements.hpp>
#include <boost/asio/detail/throw_error.hpp>
#include <boost/asio/detail/type_traits.hpp>
#include <boost/asio/error.hpp>
#include <boost/asio/socket_base.hpp>
#if defined(BOOST_ASIO_HAS_MOVE)
# include <utility>
#endif // defined(BOOST_ASIO_HAS_MOVE)
#if defined(BOOST_ASIO_ENABLE_OLD_SERVICES)
# include <boost/asio/socket_acceptor_service.hpp>
#else // defined(BOOST_ASIO_ENABLE_OLD_SERVICES)
# if defined(BOOST_ASIO_WINDOWS_RUNTIME)
# include <boost/asio/detail/null_socket_service.hpp>
# define BOOST_ASIO_SVC_T detail::null_socket_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 {
/// Provides the ability to accept new connections.
/**
* The basic_socket_acceptor class template is used for accepting new socket
* connections.
*
* @par Thread Safety
* @e Distinct @e objects: Safe.@n
* @e Shared @e objects: Unsafe.
*
* @par Example
* Opening a socket acceptor with the SO_REUSEADDR option enabled:
* @code
* boost::asio::ip::tcp::acceptor acceptor(io_context);
* boost::asio::ip::tcp::endpoint endpoint(boost::asio::ip::tcp::v4(), port);
* acceptor.open(endpoint.protocol());
* acceptor.set_option(boost::asio::ip::tcp::acceptor::reuse_address(true));
* acceptor.bind(endpoint);
* acceptor.listen();
* @endcode
*/
template <typename Protocol
BOOST_ASIO_SVC_TPARAM_DEF1(= socket_acceptor_service<Protocol>)>
class basic_socket_acceptor
: BOOST_ASIO_SVC_ACCESS basic_io_object<BOOST_ASIO_SVC_T>,
public socket_base
{
public:
/// The type of the executor associated with the object.
typedef io_context::executor_type executor_type;
/// The native representation of an acceptor.
#if defined(GENERATING_DOCUMENTATION)
typedef implementation_defined native_handle_type;
#else
typedef typename BOOST_ASIO_SVC_T::native_handle_type native_handle_type;
#endif
/// The protocol type.
typedef Protocol protocol_type;
/// The endpoint type.
typedef typename Protocol::endpoint endpoint_type;
/// Construct an acceptor without opening it.
/**
* This constructor creates an acceptor without opening it to listen for new
* connections. The open() function must be called before the acceptor can
* accept new socket connections.
*
* @param io_context The io_context object that the acceptor will use to
* dispatch handlers for any asynchronous operations performed on the
* acceptor.
*/
explicit basic_socket_acceptor(boost::asio::io_context& io_context)
: basic_io_object<BOOST_ASIO_SVC_T>(io_context)
{
}
/// Construct an open acceptor.
/**
* This constructor creates an acceptor and automatically opens it.
*
* @param io_context The io_context object that the acceptor will use to
* dispatch handlers for any asynchronous operations performed on the
* acceptor.
*
* @param protocol An object specifying protocol parameters to be used.
*
* @throws boost::system::system_error Thrown on failure.
*/
basic_socket_acceptor(boost::asio::io_context& io_context,
const protocol_type& protocol)
: basic_io_object<BOOST_ASIO_SVC_T>(io_context)
{
boost::system::error_code ec;
this->get_service().open(this->get_implementation(), protocol, ec);
boost::asio::detail::throw_error(ec, "open");
}
/// Construct an acceptor opened on the given endpoint.
/**
* This constructor creates an acceptor and automatically opens it to listen
* for new connections on the specified endpoint.
*
* @param io_context The io_context object that the acceptor will use to
* dispatch handlers for any asynchronous operations performed on the
* acceptor.
*
* @param endpoint An endpoint on the local machine on which the acceptor
* will listen for new connections.
*
* @param reuse_addr Whether the constructor should set the socket option
* socket_base::reuse_address.
*
* @throws boost::system::system_error Thrown on failure.
*
* @note This constructor is equivalent to the following code:
* @code
* basic_socket_acceptor<Protocol> acceptor(io_context);
* acceptor.open(endpoint.protocol());
* if (reuse_addr)
* acceptor.set_option(socket_base::reuse_address(true));
* acceptor.bind(endpoint);
* acceptor.listen(listen_backlog);
* @endcode
*/
basic_socket_acceptor(boost::asio::io_context& io_context,
const endpoint_type& endpoint, bool reuse_addr = true)
: basic_io_object<BOOST_ASIO_SVC_T>(io_context)
{
boost::system::error_code ec;
const protocol_type protocol = endpoint.protocol();
this->get_service().open(this->get_implementation(), protocol, ec);
boost::asio::detail::throw_error(ec, "open");
if (reuse_addr)
{
this->get_service().set_option(this->get_implementation(),
socket_base::reuse_address(true), ec);
boost::asio::detail::throw_error(ec, "set_option");
}
this->get_service().bind(this->get_implementation(), endpoint, ec);
boost::asio::detail::throw_error(ec, "bind");
this->get_service().listen(this->get_implementation(),
socket_base::max_listen_connections, ec);
boost::asio::detail::throw_error(ec, "listen");
}
/// Construct a basic_socket_acceptor on an existing native acceptor.
/**
* This constructor creates an acceptor object to hold an existing native
* acceptor.
*
* @param io_context The io_context object that the acceptor will use to
* dispatch handlers for any asynchronous operations performed on the
* acceptor.
*
* @param protocol An object specifying protocol parameters to be used.
*
* @param native_acceptor A native acceptor.
*
* @throws boost::system::system_error Thrown on failure.
*/
basic_socket_acceptor(boost::asio::io_context& io_context,
const protocol_type& protocol, const native_handle_type& native_acceptor)
: basic_io_object<BOOST_ASIO_SVC_T>(io_context)
{
boost::system::error_code ec;
this->get_service().assign(this->get_implementation(),
protocol, native_acceptor, ec);
boost::asio::detail::throw_error(ec, "assign");
}
#if defined(BOOST_ASIO_HAS_MOVE) || defined(GENERATING_DOCUMENTATION)
/// Move-construct a basic_socket_acceptor from another.
/**
* This constructor moves an acceptor from one object to another.
*
* @param other The other basic_socket_acceptor object from which the move
* will occur.
*
* @note Following the move, the moved-from object is in the same state as if
* constructed using the @c basic_socket_acceptor(io_context&) constructor.
*/
basic_socket_acceptor(basic_socket_acceptor&& other)
: basic_io_object<BOOST_ASIO_SVC_T>(std::move(other))
{
}
/// Move-assign a basic_socket_acceptor from another.
/**
* This assignment operator moves an acceptor from one object to another.
*
* @param other The other basic_socket_acceptor object from which the move
* will occur.
*
* @note Following the move, the moved-from object is in the same state as if
* constructed using the @c basic_socket_acceptor(io_context&) constructor.
*/
basic_socket_acceptor& operator=(basic_socket_acceptor&& other)
{
basic_io_object<BOOST_ASIO_SVC_T>::operator=(std::move(other));
return *this;
}
// All socket acceptors have access to each other's implementations.
template <typename Protocol1 BOOST_ASIO_SVC_TPARAM1>
friend class basic_socket_acceptor;
/// Move-construct a basic_socket_acceptor from an acceptor of another
/// protocol type.
/**
* This constructor moves an acceptor from one object to another.
*
* @param other The other basic_socket_acceptor object from which the move
* will 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.
*/
template <typename Protocol1 BOOST_ASIO_SVC_TPARAM1>
basic_socket_acceptor(
basic_socket_acceptor<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())
{
}
/// Move-assign a basic_socket_acceptor from an acceptor of another protocol
/// type.
/**
* This assignment operator moves an acceptor from one object to another.
*
* @param other The other basic_socket_acceptor object from which the move
* will 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.
*/
template <typename Protocol1 BOOST_ASIO_SVC_TPARAM1>
typename enable_if<is_convertible<Protocol1, Protocol>::value,
basic_socket_acceptor>::type& operator=(
basic_socket_acceptor<Protocol1 BOOST_ASIO_SVC_TARG1>&& other)
{
basic_socket_acceptor tmp(std::move(other));
basic_io_object<BOOST_ASIO_SVC_T>::operator=(std::move(tmp));
return *this;
}
#endif // defined(BOOST_ASIO_HAS_MOVE) || defined(GENERATING_DOCUMENTATION)
/// Destroys the acceptor.
/**
* This function destroys the acceptor, cancelling any outstanding
* asynchronous operations associated with the acceptor as if by calling
* @c cancel.
*/
~basic_socket_acceptor()
{
}
#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();
}
#endif // defined(BOOST_ASIO_ENABLE_OLD_SERVICES)
/// Open the acceptor using the specified protocol.
/**
* This function opens the socket acceptor so that it will use the specified
* protocol.
*
* @param protocol An object specifying which protocol is to be used.
*
* @throws boost::system::system_error Thrown on failure.
*
* @par Example
* @code
* boost::asio::ip::tcp::acceptor acceptor(io_context);
* acceptor.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);
boost::asio::detail::throw_error(ec, "open");
}
/// Open the acceptor using the specified protocol.
/**
* This function opens the socket acceptor so that it will use the specified
* protocol.
*
* @param protocol An object specifying which protocol is to be used.
*
* @param ec Set to indicate what error occurred, if any.
*
* @par Example
* @code
* boost::asio::ip::tcp::acceptor acceptor(io_context);
* boost::system::error_code ec;
* acceptor.open(boost::asio::ip::tcp::v4(), ec);
* if (ec)
* {
* // An error occurred.
* }
* @endcode
*/
BOOST_ASIO_SYNC_OP_VOID open(const protocol_type& protocol,
boost::system::error_code& ec)
{
this->get_service().open(this->get_implementation(), protocol, ec);
BOOST_ASIO_SYNC_OP_VOID_RETURN(ec);
}
/// Assigns an existing native acceptor to the acceptor.
/*
* This function opens the acceptor to hold an existing native acceptor.
*
* @param protocol An object specifying which protocol is to be used.
*
* @param native_acceptor A native acceptor.
*
* @throws boost::system::system_error Thrown on failure.
*/
void assign(const protocol_type& protocol,
const native_handle_type& native_acceptor)
{
boost::system::error_code ec;
this->get_service().assign(this->get_implementation(),
protocol, native_acceptor, ec);
boost::asio::detail::throw_error(ec, "assign");
}
/// Assigns an existing native acceptor to the acceptor.
/*
* This function opens the acceptor to hold an existing native acceptor.
*
* @param protocol An object specifying which protocol is to be used.
*
* @param native_acceptor A native acceptor.
*
* @param ec Set to indicate what error occurred, if any.
*/
BOOST_ASIO_SYNC_OP_VOID assign(const protocol_type& protocol,
const native_handle_type& native_acceptor, boost::system::error_code& ec)
{
this->get_service().assign(this->get_implementation(),
protocol, native_acceptor, ec);
BOOST_ASIO_SYNC_OP_VOID_RETURN(ec);
}
/// Determine whether the acceptor is open.
bool is_open() const
{
return this->get_service().is_open(this->get_implementation());
}
/// Bind the acceptor to the given local endpoint.
/**
* This function binds the socket acceptor to the specified endpoint on the
* local machine.
*
* @param endpoint An endpoint on the local machine to which the socket
* acceptor will be bound.
*
* @throws boost::system::system_error Thrown on failure.
*
* @par Example
* @code
* boost::asio::ip::tcp::acceptor acceptor(io_context);
* boost::asio::ip::tcp::endpoint endpoint(boost::asio::ip::tcp::v4(), 12345);
* acceptor.open(endpoint.protocol());
* acceptor.bind(endpoint);
* @endcode
*/
void bind(const endpoint_type& endpoint)
{
boost::system::error_code ec;
this->get_service().bind(this->get_implementation(), endpoint, ec);
boost::asio::detail::throw_error(ec, "bind");
}
/// Bind the acceptor to the given local endpoint.
/**
* This function binds the socket acceptor to the specified endpoint on the
* local machine.
*
* @param endpoint An endpoint on the local machine to which the socket
* acceptor will be bound.
*
* @param ec Set to indicate what error occurred, if any.
*
* @par Example
* @code
* boost::asio::ip::tcp::acceptor acceptor(io_context);
* boost::asio::ip::tcp::endpoint endpoint(boost::asio::ip::tcp::v4(), 12345);
* acceptor.open(endpoint.protocol());
* boost::system::error_code ec;
* acceptor.bind(endpoint, ec);
* if (ec)
* {
* // An error occurred.
* }
* @endcode
*/
BOOST_ASIO_SYNC_OP_VOID bind(const endpoint_type& endpoint,
boost::system::error_code& ec)
{
this->get_service().bind(this->get_implementation(), endpoint, ec);
BOOST_ASIO_SYNC_OP_VOID_RETURN(ec);
}
/// Place the acceptor into the state where it will listen for new
/// connections.
/**
* This function puts the socket acceptor into the state where it may accept
* new connections.
*
* @param backlog The maximum length of the queue of pending connections.
*
* @throws boost::system::system_error Thrown on failure.
*/
void listen(int backlog = socket_base::max_listen_connections)
{
boost::system::error_code ec;
this->get_service().listen(this->get_implementation(), backlog, ec);
boost::asio::detail::throw_error(ec, "listen");
}
/// Place the acceptor into the state where it will listen for new
/// connections.
/**
* This function puts the socket acceptor into the state where it may accept
* new connections.
*
* @param backlog The maximum length of the queue of pending connections.
*
* @param ec Set to indicate what error occurred, if any.
*
* @par Example
* @code
* boost::asio::ip::tcp::acceptor acceptor(io_context);
* ...
* boost::system::error_code ec;
* acceptor.listen(boost::asio::socket_base::max_listen_connections, ec);
* if (ec)
* {
* // An error occurred.
* }
* @endcode
*/
BOOST_ASIO_SYNC_OP_VOID listen(int backlog, boost::system::error_code& ec)
{
this->get_service().listen(this->get_implementation(), backlog, ec);
BOOST_ASIO_SYNC_OP_VOID_RETURN(ec);
}
/// Close the acceptor.
/**
* This function is used to close the acceptor. Any asynchronous accept
* operations will be cancelled immediately.
*
* A subsequent call to open() is required before the acceptor can again be
* used to again perform socket accept operations.
*
* @throws boost::system::system_error Thrown on failure.
*/
void close()
{
boost::system::error_code ec;
this->get_service().close(this->get_implementation(), ec);
boost::asio::detail::throw_error(ec, "close");
}
/// Close the acceptor.
/**
* This function is used to close the acceptor. Any asynchronous accept
* operations will be cancelled immediately.
*
* A subsequent call to open() is required before the acceptor can again be
* used to again perform socket accept operations.
*
* @param ec Set to indicate what error occurred, if any.
*
* @par Example
* @code
* boost::asio::ip::tcp::acceptor acceptor(io_context);
* ...
* boost::system::error_code ec;
* acceptor.close(ec);
* if (ec)
* {
* // An error occurred.
* }
* @endcode
*/
BOOST_ASIO_SYNC_OP_VOID close(boost::system::error_code& ec)
{
this->get_service().close(this->get_implementation(), ec);
BOOST_ASIO_SYNC_OP_VOID_RETURN(ec);
}
/// Release ownership of the underlying native acceptor.
/**
* This function causes all outstanding asynchronous accept operations to
* finish immediately, and the handlers for cancelled operations will be
* passed the boost::asio::error::operation_aborted error. Ownership of the
* native acceptor is then transferred to the caller.
*
* @throws boost::system::system_error Thrown on failure.
*
* @note This function is unsupported on Windows versions prior to Windows
* 8.1, and will fail with boost::asio::error::operation_not_supported on
* these platforms.
*/
#if defined(BOOST_ASIO_MSVC) && (BOOST_ASIO_MSVC >= 1400) \
&& (!defined(_WIN32_WINNT) || _WIN32_WINNT < 0x0603)
__declspec(deprecated("This function always fails with "
"operation_not_supported when used on Windows versions "
"prior to Windows 8.1."))
#endif
native_handle_type release()
{
boost::system::error_code ec;
native_handle_type s = this->get_service().release(
this->get_implementation(), ec);
boost::asio::detail::throw_error(ec, "release");
return s;
}
/// Release ownership of the underlying native acceptor.
/**
* This function causes all outstanding asynchronous accept operations to
* finish immediately, and the handlers for cancelled operations will be
* passed the boost::asio::error::operation_aborted error. Ownership of the
* native acceptor is then transferred to the caller.
*
* @param ec Set to indicate what error occurred, if any.
*
* @note This function is unsupported on Windows versions prior to Windows
* 8.1, and will fail with boost::asio::error::operation_not_supported on
* these platforms.
*/
#if defined(BOOST_ASIO_MSVC) && (BOOST_ASIO_MSVC >= 1400) \
&& (!defined(_WIN32_WINNT) || _WIN32_WINNT < 0x0603)
__declspec(deprecated("This function always fails with "
"operation_not_supported when used on Windows versions "
"prior to Windows 8.1."))
#endif
native_handle_type release(boost::system::error_code& ec)
{
return this->get_service().release(this->get_implementation(), ec);
}
/// Get the native acceptor representation.
/**
* This function may be used to obtain the underlying representation of the
* acceptor. This is intended to allow access to native acceptor functionality
* that is not otherwise provided.
*/
native_handle_type native_handle()
{
return this->get_service().native_handle(this->get_implementation());
}
/// Cancel all asynchronous operations associated with the acceptor.
/**
* This function causes all outstanding asynchronous connect, send and receive
* operations to finish immediately, and the handlers for cancelled operations
* will be passed the boost::asio::error::operation_aborted error.
*
* @throws boost::system::system_error Thrown on failure.
*/
void cancel()
{
boost::system::error_code ec;
this->get_service().cancel(this->get_implementation(), ec);
boost::asio::detail::throw_error(ec, "cancel");
}
/// Cancel all asynchronous operations associated with the acceptor.
/**
* This function causes all outstanding asynchronous connect, send and receive
* operations to finish immediately, and the handlers for cancelled operations
* will be passed the boost::asio::error::operation_aborted error.
*
* @param ec Set to indicate what error occurred, if any.
*/
BOOST_ASIO_SYNC_OP_VOID cancel(boost::system::error_code& ec)
{
this->get_service().cancel(this->get_implementation(), ec);
BOOST_ASIO_SYNC_OP_VOID_RETURN(ec);
}
/// Set an option on the acceptor.
/**
* This function is used to set an option on the acceptor.
*
* @param option The new option value to be set on the acceptor.
*
* @throws boost::system::system_error Thrown on failure.
*
* @sa SettableSocketOption @n
* boost::asio::socket_base::reuse_address
* boost::asio::socket_base::enable_connection_aborted
*
* @par Example
* Setting the SOL_SOCKET/SO_REUSEADDR option:
* @code
* boost::asio::ip::tcp::acceptor acceptor(io_context);
* ...
* boost::asio::ip::tcp::acceptor::reuse_address option(true);
* acceptor.set_option(option);
* @endcode
*/
template <typename SettableSocketOption>
void set_option(const SettableSocketOption& option)
{
boost::system::error_code ec;
this->get_service().set_option(this->get_implementation(), option, ec);
boost::asio::detail::throw_error(ec, "set_option");
}
/// Set an option on the acceptor.
/**
* This function is used to set an option on the acceptor.
*
* @param option The new option value to be set on the acceptor.
*
* @param ec Set to indicate what error occurred, if any.
*
* @sa SettableSocketOption @n
* boost::asio::socket_base::reuse_address
* boost::asio::socket_base::enable_connection_aborted
*
* @par Example
* Setting the SOL_SOCKET/SO_REUSEADDR option:
* @code
* boost::asio::ip::tcp::acceptor acceptor(io_context);
* ...
* boost::asio::ip::tcp::acceptor::reuse_address option(true);
* boost::system::error_code ec;
* acceptor.set_option(option, ec);
* if (ec)
* {
* // An error occurred.
* }
* @endcode
*/
template <typename SettableSocketOption>
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);
BOOST_ASIO_SYNC_OP_VOID_RETURN(ec);
}
/// Get an option from the acceptor.
/**
* This function is used to get the current value of an option on the
* acceptor.
*
* @param option The option value to be obtained from the acceptor.
*
* @throws boost::system::system_error Thrown on failure.
*
* @sa GettableSocketOption @n
* boost::asio::socket_base::reuse_address
*
* @par Example
* Getting the value of the SOL_SOCKET/SO_REUSEADDR option:
* @code
* boost::asio::ip::tcp::acceptor acceptor(io_context);
* ...
* boost::asio::ip::tcp::acceptor::reuse_address option;
* acceptor.get_option(option);
* bool is_set = option.get();
* @endcode
*/
template <typename GettableSocketOption>
void get_option(GettableSocketOption& option) const
{
boost::system::error_code ec;
this->get_service().get_option(this->get_implementation(), option, ec);
boost::asio::detail::throw_error(ec, "get_option");
}
/// Get an option from the acceptor.
/**
* This function is used to get the current value of an option on the
* acceptor.
*
* @param option The option value to be obtained from the acceptor.
*
* @param ec Set to indicate what error occurred, if any.
*
* @sa GettableSocketOption @n
* boost::asio::socket_base::reuse_address
*
* @par Example
* Getting the value of the SOL_SOCKET/SO_REUSEADDR option:
* @code
* boost::asio::ip::tcp::acceptor acceptor(io_context);
* ...
* boost::asio::ip::tcp::acceptor::reuse_address option;
* boost::system::error_code ec;
* acceptor.get_option(option, ec);
* if (ec)
* {
* // An error occurred.
* }
* bool is_set = option.get();
* @endcode
*/
template <typename GettableSocketOption>
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);
BOOST_ASIO_SYNC_OP_VOID_RETURN(ec);
}
/// Perform an IO control command on the acceptor.
/**
* This function is used to execute an IO control command on the acceptor.
*
* @param command The IO control command to be performed on the acceptor.
*
* @throws boost::system::system_error Thrown on failure.
*
* @sa IoControlCommand @n
* boost::asio::socket_base::non_blocking_io
*
* @par Example
* Getting the number of bytes ready to read:
* @code
* boost::asio::ip::tcp::acceptor acceptor(io_context);
* ...
* boost::asio::ip::tcp::acceptor::non_blocking_io command(true);
* socket.io_control(command);
* @endcode
*/
template <typename IoControlCommand>
void io_control(IoControlCommand& command)
{
boost::system::error_code ec;
this->get_service().io_control(this->get_implementation(), command, ec);
boost::asio::detail::throw_error(ec, "io_control");
}
/// Perform an IO control command on the acceptor.
/**
* This function is used to execute an IO control command on the acceptor.
*
* @param command The IO control command to be performed on the acceptor.
*
* @param ec Set to indicate what error occurred, if any.
*
* @sa IoControlCommand @n
* boost::asio::socket_base::non_blocking_io
*
* @par Example
* Getting the number of bytes ready to read:
* @code
* boost::asio::ip::tcp::acceptor acceptor(io_context);
* ...
* boost::asio::ip::tcp::acceptor::non_blocking_io command(true);
* boost::system::error_code ec;
* socket.io_control(command, ec);
* if (ec)
* {
* // An error occurred.
* }
* @endcode
*/
template <typename IoControlCommand>
BOOST_ASIO_SYNC_OP_VOID io_control(IoControlCommand& command,
boost::system::error_code& ec)
{
this->get_service().io_control(this->get_implementation(), command, ec);
BOOST_ASIO_SYNC_OP_VOID_RETURN(ec);
}
/// Gets the non-blocking mode of the acceptor.
/**
* @returns @c true if the acceptor's synchronous operations will fail with
* boost::asio::error::would_block if they are unable to perform the requested
* operation immediately. If @c false, synchronous operations will block
* until complete.
*
* @note The non-blocking mode has no effect on the behaviour of asynchronous
* operations. Asynchronous operations will never fail with the error
* boost::asio::error::would_block.
*/
bool non_blocking() const
{
return this->get_service().non_blocking(this->get_implementation());
}
/// Sets the non-blocking mode of the acceptor.
/**
* @param mode If @c true, the acceptor's synchronous operations will fail
* with boost::asio::error::would_block if they are unable to perform the
* requested operation immediately. If @c false, synchronous operations will
* block until complete.
*
* @throws boost::system::system_error Thrown on failure.
*
* @note The non-blocking mode has no effect on the behaviour of asynchronous
* operations. Asynchronous operations will never fail with the error
* boost::asio::error::would_block.
*/
void non_blocking(bool mode)
{
boost::system::error_code ec;
this->get_service().non_blocking(this->get_implementation(), mode, ec);
boost::asio::detail::throw_error(ec, "non_blocking");
}
/// Sets the non-blocking mode of the acceptor.
/**
* @param mode If @c true, the acceptor's synchronous operations will fail
* with boost::asio::error::would_block if they are unable to perform the
* requested operation immediately. If @c false, synchronous operations will
* block until complete.
*
* @param ec Set to indicate what error occurred, if any.
*
* @note The non-blocking mode has no effect on the behaviour of asynchronous
* operations. Asynchronous operations will never fail with the error
* boost::asio::error::would_block.
*/
BOOST_ASIO_SYNC_OP_VOID non_blocking(
bool mode, boost::system::error_code& ec)
{
this->get_service().non_blocking(this->get_implementation(), mode, ec);
BOOST_ASIO_SYNC_OP_VOID_RETURN(ec);
}
/// Gets the non-blocking mode of the native acceptor implementation.
/**
* This function is used to retrieve the non-blocking mode of the underlying
* native acceptor. This mode has no effect on the behaviour of the acceptor
* object's synchronous operations.
*
* @returns @c true if the underlying acceptor is in non-blocking mode and
* direct system calls may fail with boost::asio::error::would_block (or the
* equivalent system error).
*
* @note The current non-blocking mode is cached by the acceptor object.
* Consequently, the return value may be incorrect if the non-blocking mode
* was set directly on the native acceptor.
*/
bool native_non_blocking() const
{
return this->get_service().native_non_blocking(this->get_implementation());
}
/// Sets the non-blocking mode of the native acceptor implementation.
/**
* This function is used to modify the non-blocking mode of the underlying
* native acceptor. It has no effect on the behaviour of the acceptor object's
* synchronous operations.
*
* @param mode If @c true, the underlying acceptor is put into non-blocking
* mode and direct system calls may fail with boost::asio::error::would_block
* (or the equivalent system error).
*
* @throws boost::system::system_error Thrown on failure. If the @c mode is
* @c false, but the current value of @c non_blocking() is @c true, this
* function fails with boost::asio::error::invalid_argument, as the
* combination does not make sense.
*/
void native_non_blocking(bool mode)
{
boost::system::error_code ec;
this->get_service().native_non_blocking(
this->get_implementation(), mode, ec);
boost::asio::detail::throw_error(ec, "native_non_blocking");
}
/// Sets the non-blocking mode of the native acceptor implementation.
/**
* This function is used to modify the non-blocking mode of the underlying
* native acceptor. It has no effect on the behaviour of the acceptor object's
* synchronous operations.
*
* @param mode If @c true, the underlying acceptor is put into non-blocking
* mode and direct system calls may fail with boost::asio::error::would_block
* (or the equivalent system error).
*
* @param ec Set to indicate what error occurred, if any. If the @c mode is
* @c false, but the current value of @c non_blocking() is @c true, this
* function fails with boost::asio::error::invalid_argument, as the
* combination does not make sense.
*/
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);
BOOST_ASIO_SYNC_OP_VOID_RETURN(ec);
}
/// Get the local endpoint of the acceptor.
/**
* This function is used to obtain the locally bound endpoint of the acceptor.
*
* @returns An object that represents the local endpoint of the acceptor.
*
* @throws boost::system::system_error Thrown on failure.
*
* @par Example
* @code
* boost::asio::ip::tcp::acceptor acceptor(io_context);
* ...
* boost::asio::ip::tcp::endpoint endpoint = acceptor.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);
boost::asio::detail::throw_error(ec, "local_endpoint");
return ep;
}
/// Get the local endpoint of the acceptor.
/**
* This function is used to obtain the locally bound endpoint of the acceptor.
*
* @param ec Set to indicate what error occurred, if any.
*
* @returns An object that represents the local endpoint of the acceptor.
* Returns a default-constructed endpoint object if an error occurred and the
* error handler did not throw an exception.
*
* @par Example
* @code
* boost::asio::ip::tcp::acceptor acceptor(io_context);
* ...
* boost::system::error_code ec;
* boost::asio::ip::tcp::endpoint endpoint = acceptor.local_endpoint(ec);
* if (ec)
* {
* // An error occurred.
* }
* @endcode
*/
endpoint_type local_endpoint(boost::system::error_code& ec) const
{
return this->get_service().local_endpoint(this->get_implementation(), ec);
}
/// Wait for the acceptor to become ready to read, ready to write, or to have
/// pending error conditions.
/**
* This function is used to perform a blocking wait for an acceptor to enter
* a ready to read, write or error condition state.
*
* @param w Specifies the desired acceptor state.
*
* @par Example
* Waiting for an acceptor to become readable.
* @code
* boost::asio::ip::tcp::acceptor acceptor(io_context);
* ...
* acceptor.wait(boost::asio::ip::tcp::acceptor::wait_read);
* @endcode
*/
void wait(wait_type w)
{
boost::system::error_code ec;
this->get_service().wait(this->get_implementation(), w, ec);
boost::asio::detail::throw_error(ec, "wait");
}
/// Wait for the acceptor to become ready to read, ready to write, or to have
/// pending error conditions.
/**
* This function is used to perform a blocking wait for an acceptor to enter
* a ready to read, write or error condition state.
*
* @param w Specifies the desired acceptor state.
*
* @param ec Set to indicate what error occurred, if any.
*
* @par Example
* Waiting for an acceptor to become readable.
* @code
* boost::asio::ip::tcp::acceptor acceptor(io_context);
* ...
* boost::system::error_code ec;
* acceptor.wait(boost::asio::ip::tcp::acceptor::wait_read, ec);
* @endcode
*/
BOOST_ASIO_SYNC_OP_VOID wait(wait_type w, boost::system::error_code& ec)
{
this->get_service().wait(this->get_implementation(), w, ec);
BOOST_ASIO_SYNC_OP_VOID_RETURN(ec);
}
/// Asynchronously wait for the acceptor to become ready to read, ready to
/// write, or to have pending error conditions.
/**
* This function is used to perform an asynchronous wait for an acceptor to
* enter a ready to read, write or error condition state.
*
* @param w Specifies the desired acceptor state.
*
* @param handler The handler to be called when the wait operation completes.
* Copies will be made of the handler as required. The function signature of
* the handler must be:
* @code void handler(
* 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().
*
* @par Example
* @code
* void wait_handler(const boost::system::error_code& error)
* {
* if (!error)
* {
* // Wait succeeded.
* }
* }
*
* ...
*
* boost::asio::ip::tcp::acceptor acceptor(io_context);
* ...
* acceptor.async_wait(
* boost::asio::ip::tcp::acceptor::wait_read,
* wait_handler);
* @endcode
*/
template <typename WaitHandler>
BOOST_ASIO_INITFN_RESULT_TYPE(WaitHandler,
void (boost::system::error_code))
async_wait(wait_type w, BOOST_ASIO_MOVE_ARG(WaitHandler) handler)
{
// 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)
}
#if !defined(BOOST_ASIO_NO_EXTENSIONS)
/// Accept a new connection.
/**
* This function is used to accept a new connection from a peer into the
* given socket. The function call will block until a new connection has been
* accepted successfully or an error occurs.
*
* @param peer The socket into which the new connection will be accepted.
*
* @throws boost::system::system_error Thrown on failure.
*
* @par Example
* @code
* boost::asio::ip::tcp::acceptor acceptor(io_context);
* ...
* boost::asio::ip::tcp::socket socket(io_context);
* acceptor.accept(socket);
* @endcode
*/
#if defined(BOOST_ASIO_ENABLE_OLD_SERVICES)
template <typename Protocol1, typename SocketService>
void accept(basic_socket<Protocol1, SocketService>& peer,
typename enable_if<is_convertible<Protocol, Protocol1>::value>::type* = 0)
#else // defined(BOOST_ASIO_ENABLE_OLD_SERVICES)
template <typename Protocol1>
void accept(basic_socket<Protocol1>& peer,
typename enable_if<is_convertible<Protocol, Protocol1>::value>::type* = 0)
#endif // defined(BOOST_ASIO_ENABLE_OLD_SERVICES)
{
boost::system::error_code ec;
this->get_service().accept(this->get_implementation(),
peer, static_cast<endpoint_type*>(0), ec);
boost::asio::detail::throw_error(ec, "accept");
}
/// Accept a new connection.
/**
* This function is used to accept a new connection from a peer into the
* given socket. The function call will block until a new connection has been
* accepted successfully or an error occurs.
*
* @param peer The socket into which the new connection will be accepted.
*
* @param ec Set to indicate what error occurred, if any.
*
* @par Example
* @code
* boost::asio::ip::tcp::acceptor acceptor(io_context);
* ...
* boost::asio::ip::tcp::socket socket(io_context);
* boost::system::error_code ec;
* acceptor.accept(socket, ec);
* if (ec)
* {
* // An error occurred.
* }
* @endcode
*/
#if defined(BOOST_ASIO_ENABLE_OLD_SERVICES)
template <typename Protocol1, typename SocketService>
BOOST_ASIO_SYNC_OP_VOID accept(
basic_socket<Protocol1, SocketService>& peer,
boost::system::error_code& ec,
typename enable_if<is_convertible<Protocol, Protocol1>::value>::type* = 0)
#else // defined(BOOST_ASIO_ENABLE_OLD_SERVICES)
template <typename Protocol1>
BOOST_ASIO_SYNC_OP_VOID accept(
basic_socket<Protocol1>& peer, boost::system::error_code& ec,
typename enable_if<is_convertible<Protocol, Protocol1>::value>::type* = 0)
#endif // defined(BOOST_ASIO_ENABLE_OLD_SERVICES)
{
this->get_service().accept(this->get_implementation(),
peer, static_cast<endpoint_type*>(0), ec);
BOOST_ASIO_SYNC_OP_VOID_RETURN(ec);
}
/// Start an asynchronous accept.
/**
* This function is used to asynchronously accept a new connection into a
* socket. The function call always returns immediately.
*
* @param peer The socket into which the new connection will be accepted.
* Ownership of the peer object is retained by the caller, which must
* guarantee that it is valid until the handler is called.
*
* @param handler The handler to be called when the accept operation
* completes. Copies will be made of the handler as required. The function
* signature of the handler must be:
* @code void handler(
* 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().
*
* @par Example
* @code
* void accept_handler(const boost::system::error_code& error)
* {
* if (!error)
* {
* // Accept succeeded.
* }
* }
*
* ...
*
* boost::asio::ip::tcp::acceptor acceptor(io_context);
* ...
* boost::asio::ip::tcp::socket socket(io_context);
* acceptor.async_accept(socket, accept_handler);
* @endcode
*/
#if defined(BOOST_ASIO_ENABLE_OLD_SERVICES)
template <typename Protocol1, typename SocketService, typename AcceptHandler>
BOOST_ASIO_INITFN_RESULT_TYPE(AcceptHandler,
void (boost::system::error_code))
async_accept(basic_socket<Protocol1, SocketService>& peer,
BOOST_ASIO_MOVE_ARG(AcceptHandler) handler,
typename enable_if<is_convertible<Protocol, Protocol1>::value>::type* = 0)
#else // defined(BOOST_ASIO_ENABLE_OLD_SERVICES)
template <typename Protocol1, typename AcceptHandler>
BOOST_ASIO_INITFN_RESULT_TYPE(AcceptHandler,
void (boost::system::error_code))
async_accept(basic_socket<Protocol1>& peer,
BOOST_ASIO_MOVE_ARG(AcceptHandler) handler,
typename enable_if<is_convertible<Protocol, Protocol1>::value>::type* = 0)
#endif // defined(BOOST_ASIO_ENABLE_OLD_SERVICES)
{
// If you get an error on the following line it means that your handler does
// not meet the documented type requirements for a AcceptHandler.
BOOST_ASIO_ACCEPT_HANDLER_CHECK(AcceptHandler, handler) type_check;
#if defined(BOOST_ASIO_ENABLE_OLD_SERVICES)
return this->get_service().async_accept(this->get_implementation(),
peer, static_cast<endpoint_type*>(0),
BOOST_ASIO_MOVE_CAST(AcceptHandler)(handler));
#else // defined(BOOST_ASIO_ENABLE_OLD_SERVICES)
async_completion<AcceptHandler,
void (boost::system::error_code)> init(handler);
this->get_service().async_accept(this->get_implementation(),
peer, static_cast<endpoint_type*>(0), init.completion_handler);
return init.result.get();
#endif // defined(BOOST_ASIO_ENABLE_OLD_SERVICES)
}
/// Accept a new connection and obtain the endpoint of the peer
/**
* This function is used to accept a new connection from a peer into the
* given socket, and additionally provide the endpoint of the remote peer.
* The function call will block until a new connection has been accepted
* successfully or an error occurs.
*
* @param peer The socket into which the new connection will be accepted.
*
* @param peer_endpoint An endpoint object which will receive the endpoint of
* the remote peer.
*
* @throws boost::system::system_error Thrown on failure.
*
* @par Example
* @code
* boost::asio::ip::tcp::acceptor acceptor(io_context);
* ...
* boost::asio::ip::tcp::socket socket(io_context);
* boost::asio::ip::tcp::endpoint endpoint;
* acceptor.accept(socket, endpoint);
* @endcode
*/
#if defined(BOOST_ASIO_ENABLE_OLD_SERVICES)
template <typename SocketService>
void accept(basic_socket<protocol_type, SocketService>& peer,
endpoint_type& peer_endpoint)
#else // defined(BOOST_ASIO_ENABLE_OLD_SERVICES)
void accept(basic_socket<protocol_type>& peer, endpoint_type& peer_endpoint)
#endif // defined(BOOST_ASIO_ENABLE_OLD_SERVICES)
{
boost::system::error_code ec;
this->get_service().accept(this->get_implementation(),
peer, &peer_endpoint, ec);
boost::asio::detail::throw_error(ec, "accept");
}
/// Accept a new connection and obtain the endpoint of the peer
/**
* This function is used to accept a new connection from a peer into the
* given socket, and additionally provide the endpoint of the remote peer.
* The function call will block until a new connection has been accepted
* successfully or an error occurs.
*
* @param peer The socket into which the new connection will be accepted.
*
* @param peer_endpoint An endpoint object which will receive the endpoint of
* the remote peer.
*
* @param ec Set to indicate what error occurred, if any.
*
* @par Example
* @code
* boost::asio::ip::tcp::acceptor acceptor(io_context);
* ...
* boost::asio::ip::tcp::socket socket(io_context);
* boost::asio::ip::tcp::endpoint endpoint;
* boost::system::error_code ec;
* acceptor.accept(socket, endpoint, ec);
* if (ec)
* {
* // An error occurred.
* }
* @endcode
*/
#if defined(BOOST_ASIO_ENABLE_OLD_SERVICES)
template <typename SocketService>
BOOST_ASIO_SYNC_OP_VOID accept(
basic_socket<protocol_type, SocketService>& peer,
endpoint_type& peer_endpoint, boost::system::error_code& ec)
#else // defined(BOOST_ASIO_ENABLE_OLD_SERVICES)
BOOST_ASIO_SYNC_OP_VOID accept(basic_socket<protocol_type>& peer,
endpoint_type& peer_endpoint, boost::system::error_code& ec)
#endif // defined(BOOST_ASIO_ENABLE_OLD_SERVICES)
{
this->get_service().accept(
this->get_implementation(), peer, &peer_endpoint, ec);
BOOST_ASIO_SYNC_OP_VOID_RETURN(ec);
}
/// Start an asynchronous accept.
/**
* This function is used to asynchronously accept a new connection into a
* socket, and additionally obtain the endpoint of the remote peer. The
* function call always returns immediately.
*
* @param peer The socket into which the new connection will be accepted.
* Ownership of the peer object is retained by the caller, which must
* guarantee that it is valid until the handler is called.
*
* @param peer_endpoint An endpoint object into which the endpoint of the
* remote peer will be written. Ownership of the peer_endpoint object is
* retained by the caller, which must guarantee that it is valid until the
* handler is called.
*
* @param handler The handler to be called when the accept operation
* completes. Copies will be made of the handler as required. The function
* signature of the handler must be:
* @code void handler(
* 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().
*/
#if defined(BOOST_ASIO_ENABLE_OLD_SERVICES)
template <typename SocketService, typename AcceptHandler>
BOOST_ASIO_INITFN_RESULT_TYPE(AcceptHandler,
void (boost::system::error_code))
async_accept(basic_socket<protocol_type, SocketService>& peer,
endpoint_type& peer_endpoint, BOOST_ASIO_MOVE_ARG(AcceptHandler) handler)
#else // defined(BOOST_ASIO_ENABLE_OLD_SERVICES)
template <typename AcceptHandler>
BOOST_ASIO_INITFN_RESULT_TYPE(AcceptHandler,
void (boost::system::error_code))
async_accept(basic_socket<protocol_type>& peer,
endpoint_type& peer_endpoint, BOOST_ASIO_MOVE_ARG(AcceptHandler) handler)
#endif // defined(BOOST_ASIO_ENABLE_OLD_SERVICES)
{
// If you get an error on the following line it means that your handler does
// not meet the documented type requirements for a AcceptHandler.
BOOST_ASIO_ACCEPT_HANDLER_CHECK(AcceptHandler, handler) type_check;
#if defined(BOOST_ASIO_ENABLE_OLD_SERVICES)
return this->get_service().async_accept(this->get_implementation(), peer,
&peer_endpoint, BOOST_ASIO_MOVE_CAST(AcceptHandler)(handler));
#else // defined(BOOST_ASIO_ENABLE_OLD_SERVICES)
async_completion<AcceptHandler,
void (boost::system::error_code)> init(handler);
this->get_service().async_accept(this->get_implementation(),
peer, &peer_endpoint, init.completion_handler);
return init.result.get();
#endif // defined(BOOST_ASIO_ENABLE_OLD_SERVICES)
}
#endif // !defined(BOOST_ASIO_NO_EXTENSIONS)
#if defined(BOOST_ASIO_HAS_MOVE) || defined(GENERATING_DOCUMENTATION)
/// Accept a new connection.
/**
* This function is used to accept a new connection from a peer. The function
* call will block until a new connection has been accepted successfully or
* an error occurs.
*
* This overload requires that the Protocol template parameter satisfy the
* AcceptableProtocol type requirements.
*
* @returns A socket object representing the newly accepted connection.
*
* @throws boost::system::system_error Thrown on failure.
*
* @par Example
* @code
* boost::asio::ip::tcp::acceptor acceptor(io_context);
* ...
* boost::asio::ip::tcp::socket socket(acceptor.accept());
* @endcode
*/
typename Protocol::socket accept()
{
boost::system::error_code ec;
typename Protocol::socket peer(
this->get_service().accept(
this->get_implementation(), 0, 0, ec));
boost::asio::detail::throw_error(ec, "accept");
return peer;
}
/// Accept a new connection.
/**
* This function is used to accept a new connection from a peer. The function
* call will block until a new connection has been accepted successfully or
* an error occurs.
*
* This overload requires that the Protocol template parameter satisfy the
* AcceptableProtocol type requirements.
*
* @param ec Set to indicate what error occurred, if any.
*
* @returns On success, a socket object representing the newly accepted
* connection. On error, a socket object where is_open() is false.
*
* @par Example
* @code
* boost::asio::ip::tcp::acceptor acceptor(io_context);
* ...
* boost::asio::ip::tcp::socket socket(acceptor.accept(ec));
* if (ec)
* {
* // An error occurred.
* }
* @endcode
*/
typename Protocol::socket accept(boost::system::error_code& ec)
{
return this->get_service().accept(this->get_implementation(), 0, 0, ec);
}
/// Start an asynchronous accept.
/**
* This function is used to asynchronously accept a new connection. The
* function call always returns immediately.
*
* This overload requires that the Protocol template parameter satisfy the
* AcceptableProtocol type requirements.
*
* @param handler The handler to be called when the accept operation
* completes. Copies will be made of the handler as required. The function
* signature of the handler must be:
* @code void handler(
* const boost::system::error_code& error, // Result of operation.
* typename Protocol::socket peer // On success, the newly accepted socket.
* ); @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().
*
* @par Example
* @code
* void accept_handler(const boost::system::error_code& error,
* boost::asio::ip::tcp::socket peer)
* {
* if (!error)
* {
* // Accept succeeded.
* }
* }
*
* ...
*
* boost::asio::ip::tcp::acceptor acceptor(io_context);
* ...
* acceptor.async_accept(accept_handler);
* @endcode
*/
template <typename MoveAcceptHandler>
BOOST_ASIO_INITFN_RESULT_TYPE(MoveAcceptHandler,
void (boost::system::error_code, typename Protocol::socket))
async_accept(BOOST_ASIO_MOVE_ARG(MoveAcceptHandler) handler)
{
// If you get an error on the following line it means that your handler does
// not meet the documented type requirements for a MoveAcceptHandler.
BOOST_ASIO_MOVE_ACCEPT_HANDLER_CHECK(MoveAcceptHandler,
handler, typename Protocol::socket) type_check;
#if defined(BOOST_ASIO_ENABLE_OLD_SERVICES)
return this->get_service().async_accept(
this->get_implementation(), static_cast<boost::asio::io_context*>(0),
static_cast<endpoint_type*>(0),
BOOST_ASIO_MOVE_CAST(MoveAcceptHandler)(handler));
#else // defined(BOOST_ASIO_ENABLE_OLD_SERVICES)
async_completion<MoveAcceptHandler,
void (boost::system::error_code,
typename Protocol::socket)> init(handler);
this->get_service().async_accept(
this->get_implementation(), static_cast<boost::asio::io_context*>(0),
static_cast<endpoint_type*>(0), init.completion_handler);
return init.result.get();
#endif // defined(BOOST_ASIO_ENABLE_OLD_SERVICES)
}
/// Accept a new connection.
/**
* This function is used to accept a new connection from a peer. The function
* call will block until a new connection has been accepted successfully or
* an error occurs.
*
* This overload requires that the Protocol template parameter satisfy the
* AcceptableProtocol type requirements.
*
* @param io_context The io_context object to be used for the newly accepted
* socket.
*
* @returns A socket object representing the newly accepted connection.
*
* @throws boost::system::system_error Thrown on failure.
*
* @par Example
* @code
* boost::asio::ip::tcp::acceptor acceptor(io_context);
* ...
* boost::asio::ip::tcp::socket socket(acceptor.accept());
* @endcode
*/
typename Protocol::socket accept(boost::asio::io_context& io_context)
{
boost::system::error_code ec;
typename Protocol::socket peer(
this->get_service().accept(this->get_implementation(),
&io_context, static_cast<endpoint_type*>(0), ec));
boost::asio::detail::throw_error(ec, "accept");
return peer;
}
/// Accept a new connection.
/**
* This function is used to accept a new connection from a peer. The function
* call will block until a new connection has been accepted successfully or
* an error occurs.
*
* This overload requires that the Protocol template parameter satisfy the
* AcceptableProtocol type requirements.
*
* @param io_context The io_context object to be used for the newly accepted
* socket.
*
* @param ec Set to indicate what error occurred, if any.
*
* @returns On success, a socket object representing the newly accepted
* connection. On error, a socket object where is_open() is false.
*
* @par Example
* @code
* boost::asio::ip::tcp::acceptor acceptor(io_context);
* ...
* boost::asio::ip::tcp::socket socket(acceptor.accept(io_context2, ec));
* if (ec)
* {
* // An error occurred.
* }
* @endcode
*/
typename Protocol::socket accept(
boost::asio::io_context& io_context, boost::system::error_code& ec)
{
return this->get_service().accept(this->get_implementation(),
&io_context, static_cast<endpoint_type*>(0), ec);
}
/// Start an asynchronous accept.
/**
* This function is used to asynchronously accept a new connection. The
* function call always returns immediately.
*
* This overload requires that the Protocol template parameter satisfy the
* AcceptableProtocol type requirements.
*
* @param io_context The io_context object to be used for the newly accepted
* socket.
*
* @param handler The handler to be called when the accept operation
* completes. Copies will be made of the handler as required. The function
* signature of the handler must be:
* @code void handler(
* const boost::system::error_code& error, // Result of operation.
* typename Protocol::socket peer // On success, the newly accepted socket.
* ); @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().
*
* @par Example
* @code
* void accept_handler(const boost::system::error_code& error,
* boost::asio::ip::tcp::socket peer)
* {
* if (!error)
* {
* // Accept succeeded.
* }
* }
*
* ...
*
* boost::asio::ip::tcp::acceptor acceptor(io_context);
* ...
* acceptor.async_accept(io_context2, accept_handler);
* @endcode
*/
template <typename MoveAcceptHandler>
BOOST_ASIO_INITFN_RESULT_TYPE(MoveAcceptHandler,
void (boost::system::error_code, typename Protocol::socket))
async_accept(boost::asio::io_context& io_context,
BOOST_ASIO_MOVE_ARG(MoveAcceptHandler) handler)
{
// If you get an error on the following line it means that your handler does
// not meet the documented type requirements for a MoveAcceptHandler.
BOOST_ASIO_MOVE_ACCEPT_HANDLER_CHECK(MoveAcceptHandler,
handler, typename Protocol::socket) type_check;
#if defined(BOOST_ASIO_ENABLE_OLD_SERVICES)
return this->get_service().async_accept(this->get_implementation(),
&io_context, static_cast<endpoint_type*>(0),
BOOST_ASIO_MOVE_CAST(MoveAcceptHandler)(handler));
#else // defined(BOOST_ASIO_ENABLE_OLD_SERVICES)
async_completion<MoveAcceptHandler,
void (boost::system::error_code,
typename Protocol::socket)> init(handler);
this->get_service().async_accept(this->get_implementation(),
&io_context, static_cast<endpoint_type*>(0), init.completion_handler);
return init.result.get();
#endif // defined(BOOST_ASIO_ENABLE_OLD_SERVICES)
}
/// Accept a new connection.
/**
* This function is used to accept a new connection from a peer. The function
* call will block until a new connection has been accepted successfully or
* an error occurs.
*
* This overload requires that the Protocol template parameter satisfy the
* AcceptableProtocol type requirements.
*
* @param peer_endpoint An endpoint object into which the endpoint of the
* remote peer will be written.
*
* @returns A socket object representing the newly accepted connection.
*
* @throws boost::system::system_error Thrown on failure.
*
* @par Example
* @code
* boost::asio::ip::tcp::acceptor acceptor(io_context);
* ...
* boost::asio::ip::tcp::endpoint endpoint;
* boost::asio::ip::tcp::socket socket(acceptor.accept(endpoint));
* @endcode
*/
typename Protocol::socket accept(endpoint_type& peer_endpoint)
{
boost::system::error_code ec;
typename Protocol::socket peer(
this->get_service().accept(this->get_implementation(),
static_cast<boost::asio::io_context*>(0), &peer_endpoint, ec));
boost::asio::detail::throw_error(ec, "accept");
return peer;
}
/// Accept a new connection.
/**
* This function is used to accept a new connection from a peer. The function
* call will block until a new connection has been accepted successfully or
* an error occurs.
*
* This overload requires that the Protocol template parameter satisfy the
* AcceptableProtocol type requirements.
*
* @param peer_endpoint An endpoint object into which the endpoint of the
* remote peer will be written.
*
* @param ec Set to indicate what error occurred, if any.
*
* @returns On success, a socket object representing the newly accepted
* connection. On error, a socket object where is_open() is false.
*
* @par Example
* @code
* boost::asio::ip::tcp::acceptor acceptor(io_context);
* ...
* boost::asio::ip::tcp::endpoint endpoint;
* boost::asio::ip::tcp::socket socket(acceptor.accept(endpoint, ec));
* if (ec)
* {
* // An error occurred.
* }
* @endcode
*/
typename Protocol::socket accept(
endpoint_type& peer_endpoint, boost::system::error_code& ec)
{
return this->get_service().accept(this->get_implementation(),
static_cast<boost::asio::io_context*>(0), &peer_endpoint, ec);
}
/// Start an asynchronous accept.
/**
* This function is used to asynchronously accept a new connection. The
* function call always returns immediately.
*
* This overload requires that the Protocol template parameter satisfy the
* AcceptableProtocol type requirements.
*
* @param peer_endpoint An endpoint object into which the endpoint of the
* remote peer will be written. Ownership of the peer_endpoint object is
* retained by the caller, which must guarantee that it is valid until the
* handler is called.
*
* @param handler The handler to be called when the accept operation
* completes. Copies will be made of the handler as required. The function
* signature of the handler must be:
* @code void handler(
* const boost::system::error_code& error, // Result of operation.
* typename Protocol::socket peer // On success, the newly accepted socket.
* ); @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().
*
* @par Example
* @code
* void accept_handler(const boost::system::error_code& error,
* boost::asio::ip::tcp::socket peer)
* {
* if (!error)
* {
* // Accept succeeded.
* }
* }
*
* ...
*
* boost::asio::ip::tcp::acceptor acceptor(io_context);
* ...
* boost::asio::ip::tcp::endpoint endpoint;
* acceptor.async_accept(endpoint, accept_handler);
* @endcode
*/
template <typename MoveAcceptHandler>
BOOST_ASIO_INITFN_RESULT_TYPE(MoveAcceptHandler,
void (boost::system::error_code, typename Protocol::socket))
async_accept(endpoint_type& peer_endpoint,
BOOST_ASIO_MOVE_ARG(MoveAcceptHandler) handler)
{
// If you get an error on the following line it means that your handler does
// not meet the documented type requirements for a MoveAcceptHandler.
BOOST_ASIO_MOVE_ACCEPT_HANDLER_CHECK(MoveAcceptHandler,
handler, typename Protocol::socket) type_check;
#if defined(BOOST_ASIO_ENABLE_OLD_SERVICES)
return this->get_service().async_accept(this->get_implementation(),
static_cast<boost::asio::io_context*>(0), &peer_endpoint,
BOOST_ASIO_MOVE_CAST(MoveAcceptHandler)(handler));
#else // defined(BOOST_ASIO_ENABLE_OLD_SERVICES)
async_completion<MoveAcceptHandler,
void (boost::system::error_code,
typename Protocol::socket)> init(handler);
this->get_service().async_accept(this->get_implementation(),
static_cast<boost::asio::io_context*>(0), &peer_endpoint,
init.completion_handler);
return init.result.get();
#endif // defined(BOOST_ASIO_ENABLE_OLD_SERVICES)
}
/// Accept a new connection.
/**
* This function is used to accept a new connection from a peer. The function
* call will block until a new connection has been accepted successfully or
* an error occurs.
*
* This overload requires that the Protocol template parameter satisfy the
* AcceptableProtocol type requirements.
*
* @param io_context The io_context object to be used for the newly accepted
* socket.
*
* @param peer_endpoint An endpoint object into which the endpoint of the
* remote peer will be written.
*
* @returns A socket object representing the newly accepted connection.
*
* @throws boost::system::system_error Thrown on failure.
*
* @par Example
* @code
* boost::asio::ip::tcp::acceptor acceptor(io_context);
* ...
* boost::asio::ip::tcp::endpoint endpoint;
* boost::asio::ip::tcp::socket socket(
* acceptor.accept(io_context2, endpoint));
* @endcode
*/
typename Protocol::socket accept(
boost::asio::io_context& io_context, endpoint_type& peer_endpoint)
{
boost::system::error_code ec;
typename Protocol::socket peer(
this->get_service().accept(this->get_implementation(),
&io_context, &peer_endpoint, ec));
boost::asio::detail::throw_error(ec, "accept");
return peer;
}
/// Accept a new connection.
/**
* This function is used to accept a new connection from a peer. The function
* call will block until a new connection has been accepted successfully or
* an error occurs.
*
* This overload requires that the Protocol template parameter satisfy the
* AcceptableProtocol type requirements.
*
* @param io_context The io_context object to be used for the newly accepted
* socket.
*
* @param peer_endpoint An endpoint object into which the endpoint of the
* remote peer will be written.
*
* @param ec Set to indicate what error occurred, if any.
*
* @returns On success, a socket object representing the newly accepted
* connection. On error, a socket object where is_open() is false.
*
* @par Example
* @code
* boost::asio::ip::tcp::acceptor acceptor(io_context);
* ...
* boost::asio::ip::tcp::endpoint endpoint;
* boost::asio::ip::tcp::socket socket(
* acceptor.accept(io_context2, endpoint, ec));
* if (ec)
* {
* // An error occurred.
* }
* @endcode
*/
typename Protocol::socket accept(boost::asio::io_context& io_context,
endpoint_type& peer_endpoint, boost::system::error_code& ec)
{
return this->get_service().accept(this->get_implementation(),
&io_context, &peer_endpoint, ec);
}
/// Start an asynchronous accept.
/**
* This function is used to asynchronously accept a new connection. The
* function call always returns immediately.
*
* This overload requires that the Protocol template parameter satisfy the
* AcceptableProtocol type requirements.
*
* @param io_context The io_context object to be used for the newly accepted
* socket.
*
* @param peer_endpoint An endpoint object into which the endpoint of the
* remote peer will be written. Ownership of the peer_endpoint object is
* retained by the caller, which must guarantee that it is valid until the
* handler is called.
*
* @param handler The handler to be called when the accept operation
* completes. Copies will be made of the handler as required. The function
* signature of the handler must be:
* @code void handler(
* const boost::system::error_code& error, // Result of operation.
* typename Protocol::socket peer // On success, the newly accepted socket.
* ); @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().
*
* @par Example
* @code
* void accept_handler(const boost::system::error_code& error,
* boost::asio::ip::tcp::socket peer)
* {
* if (!error)
* {
* // Accept succeeded.
* }
* }
*
* ...
*
* boost::asio::ip::tcp::acceptor acceptor(io_context);
* ...
* boost::asio::ip::tcp::endpoint endpoint;
* acceptor.async_accept(io_context2, endpoint, accept_handler);
* @endcode
*/
template <typename MoveAcceptHandler>
BOOST_ASIO_INITFN_RESULT_TYPE(MoveAcceptHandler,
void (boost::system::error_code, typename Protocol::socket))
async_accept(boost::asio::io_context& io_context,
endpoint_type& peer_endpoint,
BOOST_ASIO_MOVE_ARG(MoveAcceptHandler) handler)
{
// If you get an error on the following line it means that your handler does
// not meet the documented type requirements for a MoveAcceptHandler.
BOOST_ASIO_MOVE_ACCEPT_HANDLER_CHECK(MoveAcceptHandler,
handler, typename Protocol::socket) type_check;
#if defined(BOOST_ASIO_ENABLE_OLD_SERVICES)
return this->get_service().async_accept(
this->get_implementation(), &io_context, &peer_endpoint,
BOOST_ASIO_MOVE_CAST(MoveAcceptHandler)(handler));
#else // defined(BOOST_ASIO_ENABLE_OLD_SERVICES)
async_completion<MoveAcceptHandler,
void (boost::system::error_code,
typename Protocol::socket)> init(handler);
this->get_service().async_accept(this->get_implementation(),
&io_context, &peer_endpoint, init.completion_handler);
return init.result.get();
#endif // defined(BOOST_ASIO_ENABLE_OLD_SERVICES)
}
#endif // defined(BOOST_ASIO_HAS_MOVE) || defined(GENERATING_DOCUMENTATION)
};
} // namespace asio
} // namespace boost
#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_ACCEPTOR_HPP