Provides socket functionality. More...

#include <basic_socket.hpp>

Inheritance diagram for asio::basic_socket< Protocol, Executor >:

Collaboration diagram for asio::basic_socket< Protocol, Executor >:

Classes
struct	rebind_executor
	Rebinds the socket type to another executor. More...

Public Types
typedef Executor	executor_type
	The type of the executor associated with the object.

typedef detail::reactive_socket_service< Protocol >::native_handle_type	native_handle_type
	The native representation of a socket.

typedef Protocol	protocol_type
	The protocol type.

typedef Protocol::endpoint	endpoint_type
	The endpoint type.

typedef basic_socket< Protocol, Executor >	lowest_layer_type
	A basic_socket is always the lowest layer.

Public Types inherited from asio::socket_base
enum	shutdown_type { shutdown_receive = ASIO_OS_DEF(SHUT_RD), shutdown_send = ASIO_OS_DEF(SHUT_WR), shutdown_both = ASIO_OS_DEF(SHUT_RDWR) }
	Different ways a socket may be shutdown.

enum	wait_type { wait_read, wait_write, wait_error }
	Wait types. More...

typedef int	message_flags
	Bitmask type for flags that can be passed to send and receive operations.

typedef asio::detail::socket_option::boolean< ASIO_OS_DEF(SOL_SOCKET), ASIO_OS_DEF(SO_BROADCAST)>	broadcast
	Socket option to permit sending of broadcast messages. More...

typedef asio::detail::socket_option::boolean< ASIO_OS_DEF(SOL_SOCKET), ASIO_OS_DEF(SO_DEBUG)>	debug
	Socket option to enable socket-level debugging. More...

typedef asio::detail::socket_option::boolean< ASIO_OS_DEF(SOL_SOCKET), ASIO_OS_DEF(SO_DONTROUTE)>	do_not_route
	Socket option to prevent routing, use local interfaces only. More...

typedef asio::detail::socket_option::boolean< ASIO_OS_DEF(SOL_SOCKET), ASIO_OS_DEF(SO_KEEPALIVE)>	keep_alive
	Socket option to send keep-alives. More...

typedef asio::detail::socket_option::integer< ASIO_OS_DEF(SOL_SOCKET), ASIO_OS_DEF(SO_SNDBUF)>	send_buffer_size
	Socket option for the send buffer size of a socket. More...

typedef asio::detail::socket_option::integer< ASIO_OS_DEF(SOL_SOCKET), ASIO_OS_DEF(SO_SNDLOWAT)>	send_low_watermark
	Socket option for the send low watermark. More...

typedef asio::detail::socket_option::integer< ASIO_OS_DEF(SOL_SOCKET), ASIO_OS_DEF(SO_RCVBUF)>	receive_buffer_size
	Socket option for the receive buffer size of a socket. More...

typedef asio::detail::socket_option::integer< ASIO_OS_DEF(SOL_SOCKET), ASIO_OS_DEF(SO_RCVLOWAT)>	receive_low_watermark
	Socket option for the receive low watermark. More...

typedef asio::detail::socket_option::boolean< ASIO_OS_DEF(SOL_SOCKET), ASIO_OS_DEF(SO_REUSEADDR)>	reuse_address
	Socket option to allow the socket to be bound to an address that is already in use. More...

typedef asio::detail::socket_option::linger< ASIO_OS_DEF(SOL_SOCKET), ASIO_OS_DEF(SO_LINGER)>	linger
	Socket option to specify whether the socket lingers on close if unsent data is present. More...

typedef asio::detail::socket_option::boolean< ASIO_OS_DEF(SOL_SOCKET), ASIO_OS_DEF(SO_OOBINLINE)>	out_of_band_inline
	Socket option for putting received out-of-band data inline. More...

typedef asio::detail::socket_option::boolean< asio::detail::custom_socket_option_level, asio::detail::enable_connection_aborted_option >	enable_connection_aborted
	Socket option to report aborted connections on accept. More...

typedef asio::detail::io_control::bytes_readable	bytes_readable
	IO control command to get the amount of data that can be read without blocking. More...

Public Member Functions
	basic_socket (const executor_type &ex)
	Construct a basic_socket without opening it. More...

template<typename ExecutionContext >
	basic_socket (ExecutionContext &context, typename enable_if< is_convertible< ExecutionContext &, execution_context &>::value >::type *=0)
	Construct a basic_socket without opening it. More...

	basic_socket (const executor_type &ex, const protocol_type &protocol)
	Construct and open a basic_socket. More...

template<typename ExecutionContext >
	basic_socket (ExecutionContext &context, const protocol_type &protocol, typename enable_if< is_convertible< ExecutionContext &, execution_context &>::value >::type *=0)
	Construct and open a basic_socket. More...

	basic_socket (const executor_type &ex, const endpoint_type &endpoint)
	Construct a basic_socket, opening it and binding it to the given local endpoint. More...

template<typename ExecutionContext >
	basic_socket (ExecutionContext &context, const endpoint_type &endpoint, typename enable_if< is_convertible< ExecutionContext &, execution_context &>::value >::type *=0)
	Construct a basic_socket, opening it and binding it to the given local endpoint. More...

	basic_socket (const executor_type &ex, const protocol_type &protocol, const native_handle_type &native_socket)
	Construct a basic_socket on an existing native socket. More...

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)
	Construct a basic_socket on an existing native socket. More...

executor_type	get_executor () ASIO_NOEXCEPT
	Get the executor associated with the object.

lowest_layer_type &	lowest_layer ()
	Get a reference to the lowest layer. More...

const lowest_layer_type &	lowest_layer () const
	Get a const reference to the lowest layer. More...

void	open (const protocol_type &protocol=protocol_type())
	Open the socket using the specified protocol. More...

ASIO_SYNC_OP_VOID	open (const protocol_type &protocol, asio::error_code &ec)
	Open the socket using the specified protocol. More...

void	assign (const protocol_type &protocol, const native_handle_type &native_socket)
	Assign an existing native socket to the socket.

ASIO_SYNC_OP_VOID	assign (const protocol_type &protocol, const native_handle_type &native_socket, asio::error_code &ec)
	Assign an existing native socket to the socket.

bool	is_open () const
	Determine whether the socket is open.

void	close ()
	Close the socket. More...

ASIO_SYNC_OP_VOID	close (asio::error_code &ec)
	Close the socket. More...

native_handle_type	release ()
	Release ownership of the underlying native socket. More...

native_handle_type	release (asio::error_code &ec)
	Release ownership of the underlying native socket. More...

native_handle_type	native_handle ()
	Get the native socket representation. More...

void	cancel ()
	Cancel all asynchronous operations associated with the socket. More...

ASIO_SYNC_OP_VOID	cancel (asio::error_code &ec)
	Cancel all asynchronous operations associated with the socket. More...

bool	at_mark () const
	Determine whether the socket is at the out-of-band data mark. More...

bool	at_mark (asio::error_code &ec) const
	Determine whether the socket is at the out-of-band data mark. More...

std::size_t	available () const
	Determine the number of bytes available for reading. More...

std::size_t	available (asio::error_code &ec) const
	Determine the number of bytes available for reading. More...

void	bind (const endpoint_type &endpoint)
	Bind the socket to the given local endpoint. More...

ASIO_SYNC_OP_VOID	bind (const endpoint_type &endpoint, asio::error_code &ec)
	Bind the socket to the given local endpoint. More...

void	connect (const endpoint_type &peer_endpoint)
	Connect the socket to the specified endpoint. More...

ASIO_SYNC_OP_VOID	connect (const endpoint_type &peer_endpoint, asio::error_code &ec)
	Connect the socket to the specified endpoint. More...

template<ConnectHandler ASIO_DEFAULT_COMPLETION_TOKEN_TYPE>
	ASIO_INITFN_AUTO_RESULT_TYPE (ConnectHandler, void(asio::error_code)) async_connect(const endpoint_type &peer_endpoint
	Start an asynchronous connect. More...

	ASIO_MOVE_ARG (ConnectHandler) handler ASIO_DEFAULT_COMPLETION_TOKEN(executor_type))

template<typename SettableSocketOption >
void	set_option (const SettableSocketOption &option)
	Set an option on the socket. More...

template<typename SettableSocketOption >
ASIO_SYNC_OP_VOID	set_option (const SettableSocketOption &option, asio::error_code &ec)
	Set an option on the socket. More...

template<typename GettableSocketOption >
void	get_option (GettableSocketOption &option) const
	Get an option from the socket. More...

template<typename GettableSocketOption >
ASIO_SYNC_OP_VOID	get_option (GettableSocketOption &option, asio::error_code &ec) const
	Get an option from the socket. More...

template<typename IoControlCommand >
void	io_control (IoControlCommand &command)
	Perform an IO control command on the socket. More...

template<typename IoControlCommand >
ASIO_SYNC_OP_VOID	io_control (IoControlCommand &command, asio::error_code &ec)
	Perform an IO control command on the socket. More...

bool	non_blocking () const
	Gets the non-blocking mode of the socket. More...

void	non_blocking (bool mode)
	Sets the non-blocking mode of the socket. More...

ASIO_SYNC_OP_VOID	non_blocking (bool mode, asio::error_code &ec)
	Sets the non-blocking mode of the socket. More...

bool	native_non_blocking () const
	Gets the non-blocking mode of the native socket implementation. More...

void	native_non_blocking (bool mode)
	Sets the non-blocking mode of the native socket implementation. More...

ASIO_SYNC_OP_VOID	native_non_blocking (bool mode, asio::error_code &ec)
	Sets the non-blocking mode of the native socket implementation. More...

endpoint_type	local_endpoint () const
	Get the local endpoint of the socket. More...

endpoint_type	local_endpoint (asio::error_code &ec) const
	Get the local endpoint of the socket. More...

endpoint_type	remote_endpoint () const
	Get the remote endpoint of the socket. More...

endpoint_type	remote_endpoint (asio::error_code &ec) const
	Get the remote endpoint of the socket. More...

void	shutdown (shutdown_type what)
	Disable sends or receives on the socket. More...

ASIO_SYNC_OP_VOID	shutdown (shutdown_type what, asio::error_code &ec)
	Disable sends or receives on the socket. More...

void	wait (wait_type w)
	Wait for the socket to become ready to read, ready to write, or to have pending error conditions. More...

ASIO_SYNC_OP_VOID	wait (wait_type w, asio::error_code &ec)
	Wait for the socket to become ready to read, ready to write, or to have pending error conditions. More...

template<WaitHandler ASIO_DEFAULT_COMPLETION_TOKEN_TYPE>
	ASIO_INITFN_AUTO_RESULT_TYPE (WaitHandler, void(asio::error_code)) async_wait(wait_type w
	Asynchronously wait for the socket to become ready to read, ready to write, or to have pending error conditions. More...

	ASIO_MOVE_ARG (WaitHandler) handler ASIO_DEFAULT_COMPLETION_TOKEN(executor_type))

Public Member Functions inherited from asio::socket_base
	ASIO_STATIC_CONSTANT (int, message_peek=ASIO_OS_DEF(MSG_PEEK))

	ASIO_STATIC_CONSTANT (int, message_out_of_band=ASIO_OS_DEF(MSG_OOB))

	ASIO_STATIC_CONSTANT (int, message_do_not_route=ASIO_OS_DEF(MSG_DONTROUTE))

	ASIO_STATIC_CONSTANT (int, message_end_of_record=ASIO_OS_DEF(MSG_EOR))

	ASIO_STATIC_CONSTANT (int, max_listen_connections=ASIO_OS_DEF(SOMAXCONN))
	The maximum length of the queue of pending incoming connections.

	ASIO_STATIC_CONSTANT (int, max_connections=ASIO_OS_DEF(SOMAXCONN))
	(Deprecated: Use max_listen_connections.) The maximum length of the queue of pending incoming connections. More...

Protected Member Functions
	~basic_socket ()
	Protected destructor to prevent deletion through this type. More...

Protected Member Functions inherited from asio::socket_base
	~socket_base ()
	Protected destructor to prevent deletion through this type.

Protected Attributes
detail::io_object_impl< detail::reactive_socket_service< Protocol >, Executor >	impl_

Detailed Description

template<typename Protocol, typename Executor>
class asio::basic_socket< Protocol, Executor >

Provides socket functionality.

The basic_socket class template provides functionality that is common to both stream-oriented and datagram-oriented sockets.

Thread Safety: Distinct objects: Safe.
Shared objects: Unsafe.

Constructor & Destructor Documentation

◆ basic_socket() [1/8]

template<typename Protocol, typename Executor>

asio::basic_socket< Protocol, Executor >::basic_socket ( const executor_type & ex )

inlineexplicit

Construct a basic_socket without opening it.

This constructor creates a socket without opening it.

Parameters

ex	The I/O executor that the socket will use, by default, to dispatch handlers for any asynchronous operations performed on the socket.

◆ basic_socket() [2/8]

template<typename Protocol, typename Executor>

template<typename ExecutionContext >

asio::basic_socket< Protocol, Executor >::basic_socket	(	ExecutionContext &	context,
		typename enable_if< is_convertible< ExecutionContext &, execution_context &>::value >::type *	= `0`
	)

inlineexplicit

Construct a basic_socket without opening it.

This constructor creates a socket without opening it.

Parameters

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.

◆ basic_socket() [3/8]

template<typename Protocol, typename Executor>

asio::basic_socket< Protocol, Executor >::basic_socket	(	const executor_type &	ex,
		const protocol_type &	protocol
	)

inline

Construct and open a basic_socket.

This constructor creates and opens a socket.

Parameters

ex	The I/O executor that the socket will use, by default, to dispatch handlers for any asynchronous operations performed on the socket.
protocol	An object specifying protocol parameters to be used.

Exceptions

asio::system_error Thrown on failure.

◆ basic_socket() [4/8]

template<typename Protocol, typename Executor>

template<typename ExecutionContext >

asio::basic_socket< Protocol, Executor >::basic_socket	(	ExecutionContext &	context,
		const protocol_type &	protocol,
		typename enable_if< is_convertible< ExecutionContext &, execution_context &>::value >::type *	= `0`
	)

inline

Construct and open a basic_socket.

This constructor creates and opens a socket.

Parameters

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.
protocol	An object specifying protocol parameters to be used.

Exceptions

asio::system_error Thrown on failure.

◆ basic_socket() [5/8]

template<typename Protocol, typename Executor>

asio::basic_socket< Protocol, Executor >::basic_socket	(	const executor_type &	ex,
		const endpoint_type &	endpoint
	)

inline

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.

Parameters

ex	The I/O executor that the socket will use, by default, to dispatch handlers for any asynchronous operations performed on the socket.
endpoint	An endpoint on the local machine to which the socket will be bound.

Exceptions

asio::system_error Thrown on failure.

◆ basic_socket() [6/8]

template<typename Protocol, typename Executor>

template<typename ExecutionContext >

asio::basic_socket< Protocol, Executor >::basic_socket	(	ExecutionContext &	context,
		const endpoint_type &	endpoint,
		typename enable_if< is_convertible< ExecutionContext &, execution_context &>::value >::type *	= `0`
	)

inline

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.

Parameters

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.
endpoint	An endpoint on the local machine to which the socket will be bound.

Exceptions

asio::system_error Thrown on failure.

◆ basic_socket() [7/8]

template<typename Protocol, typename Executor>

asio::basic_socket< Protocol, Executor >::basic_socket	(	const executor_type &	ex,
		const protocol_type &	protocol,
		const native_handle_type &	native_socket
	)

inline

Construct a basic_socket on an existing native socket.

This constructor creates a socket object to hold an existing native socket.

Parameters

ex	The I/O executor that the socket will use, by default, to dispatch handlers for any asynchronous operations performed on the socket.
protocol	An object specifying protocol parameters to be used.
native_socket	A native socket.

Exceptions

asio::system_error Thrown on failure.

◆ basic_socket() [8/8]

template<typename Protocol, typename Executor>

template<typename ExecutionContext >

asio::basic_socket< Protocol, Executor >::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`
	)

inline

Construct a basic_socket on an existing native socket.

This constructor creates a socket object to hold an existing native socket.

Parameters

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.
protocol	An object specifying protocol parameters to be used.
native_socket	A native socket.

Exceptions

asio::system_error Thrown on failure.

◆ ~basic_socket()

template<typename Protocol, typename Executor>

asio::basic_socket< Protocol, Executor >::~basic_socket ( )

inlineprotected

Protected destructor to prevent deletion through this type.

This function destroys the socket, cancelling any outstanding asynchronous operations associated with the socket as if by calling cancel.

Member Function Documentation

◆ ASIO_INITFN_AUTO_RESULT_TYPE() [1/2]

template<typename Protocol, typename Executor>

template<ConnectHandler ASIO_DEFAULT_COMPLETION_TOKEN_TYPE>

asio::basic_socket< Protocol, Executor >::ASIO_INITFN_AUTO_RESULT_TYPE	(	ConnectHandler	,
		void(asio::error_code)
	)		const &

Start an asynchronous connect.

This function is used to asynchronously connect a socket to the specified remote endpoint. The function call always returns immediately.

The socket is automatically opened if it is not already open. If the connect fails, and the socket was automatically opened, the socket is not returned to the closed state.

Parameters

peer_endpoint The remote endpoint to which the socket will be connected. Copies will be made of the endpoint object as required.

handler

The handler to be called when the connection operation completes. Copies will be made of the handler as required. The function signature of the handler must be:

 void handler(
  const asio::error_code& error // Result of operation
); 

Regardless of whether the asynchronous operation completes immediately or 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 asio::post().

Example: void connect_handler(const asio::error_code& error)
{
if (!error)
{
// Connect succeeded.
}
}
...
asio::ip::tcp::socket socket(my_context);
asio::ip::tcp::endpoint endpoint(
asio::ip::address::from_string("1.2.3.4"), 12345);
socket.async_connect(endpoint, connect_handler);

◆ ASIO_INITFN_AUTO_RESULT_TYPE() [2/2]

template<typename Protocol, typename Executor>

template<WaitHandler ASIO_DEFAULT_COMPLETION_TOKEN_TYPE>

asio::basic_socket< Protocol, Executor >::ASIO_INITFN_AUTO_RESULT_TYPE	(	WaitHandler	,
		void(asio::error_code)
	)

Asynchronously wait for the socket to become ready to read, ready to write, or to have pending error conditions.

This function is used to perform an asynchronous wait for a socket to enter a ready to read, write or error condition state.

Parameters

w Specifies the desired socket state.

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:

 void handler(
  const asio::error_code& error // Result of operation
); 

Regardless of whether the asynchronous operation completes immediately or 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 asio::post().

Example: void wait_handler(const asio::error_code& error)
{
if (!error)
{
// Wait succeeded.
}
}
...
asio::ip::tcp::socket socket(my_context);
...
socket.async_wait(asio::ip::tcp::socket::wait_read, wait_handler);

◆ at_mark() [1/2]

template<typename Protocol, typename Executor>

bool asio::basic_socket< Protocol, Executor >::at_mark ( ) const

inline

Determine whether the socket is at the out-of-band data mark.

This function is used to check whether the socket input is currently positioned at the out-of-band data mark.

Returns: A bool indicating whether the socket is at the out-of-band data mark.

Exceptions

asio::system_error Thrown on failure.

◆ at_mark() [2/2]

template<typename Protocol, typename Executor>

bool asio::basic_socket< Protocol, Executor >::at_mark ( asio::error_code & ec ) const

inline

Determine whether the socket is at the out-of-band data mark.

This function is used to check whether the socket input is currently positioned at the out-of-band data mark.

Parameters

ec	Set to indicate what error occurred, if any.

Returns: A bool indicating whether the socket is at the out-of-band data mark.

◆ available() [1/2]

template<typename Protocol, typename Executor>

std::size_t asio::basic_socket< Protocol, Executor >::available ( ) const

inline

Determine the number of bytes available for reading.

This function is used to determine the number of bytes that may be read without blocking.

Returns: The number of bytes that may be read without blocking, or 0 if an error occurs.

Exceptions

asio::system_error Thrown on failure.

◆ available() [2/2]

template<typename Protocol, typename Executor>

std::size_t asio::basic_socket< Protocol, Executor >::available ( asio::error_code & ec ) const

inline

Determine the number of bytes available for reading.

This function is used to determine the number of bytes that may be read without blocking.

Parameters

ec	Set to indicate what error occurred, if any.

Returns: The number of bytes that may be read without blocking, or 0 if an error occurs.

◆ bind() [1/2]

template<typename Protocol, typename Executor>

void asio::basic_socket< Protocol, Executor >::bind ( const endpoint_type & endpoint )

inline

Bind the socket to the given local endpoint.

This function binds the socket to the specified endpoint on the local machine.

Parameters

endpoint An endpoint on the local machine to which the socket will be bound.

Exceptions

asio::system_error Thrown on failure.

Example: asio::ip::tcp::socket socket(my_context);
socket.open(asio::ip::tcp::v4());
socket.bind(asio::ip::tcp::endpoint(
asio::ip::tcp::v4(), 12345));

◆ bind() [2/2]

template<typename Protocol, typename Executor>

ASIO_SYNC_OP_VOID asio::basic_socket< Protocol, Executor >::bind	(	const endpoint_type &	endpoint,
		asio::error_code &	ec
	)

inline

Bind the socket to the given local endpoint.

This function binds the socket to the specified endpoint on the local machine.

Parameters

endpoint	An endpoint on the local machine to which the socket will be bound.
ec	Set to indicate what error occurred, if any.

Example: asio::ip::tcp::socket socket(my_context);
socket.open(asio::ip::tcp::v4());
asio::error_code ec;
socket.bind(asio::ip::tcp::endpoint(
asio::ip::tcp::v4(), 12345), ec);
if (ec)
{
// An error occurred.
}

◆ cancel() [1/2]

template<typename Protocol, typename Executor>

void asio::basic_socket< Protocol, Executor >::cancel ( )

inline

Cancel all asynchronous operations associated with the socket.

This function causes all outstanding asynchronous connect, send and receive operations to finish immediately, and the handlers for cancelled operations will be passed the asio::error::operation_aborted error.

Exceptions

asio::system_error Thrown on failure.

Note: Calls to cancel() will always fail with asio::error::operation_not_supported when run on Windows XP, Windows Server 2003, and earlier versions of Windows, unless ASIO_ENABLE_CANCELIO is defined. However, the CancelIo function has two issues that should be considered before enabling its use:

It will only cancel asynchronous operations that were initiated in the current thread.

It can appear to complete without error, but the request to cancel the unfinished operations may be silently ignored by the operating system. Whether it works or not seems to depend on the drivers that are installed.

For portable cancellation, consider using one of the following alternatives:

Disable asio's I/O completion port backend by defining ASIO_DISABLE_IOCP.

Use the close() function to simultaneously cancel the outstanding operations and close the socket.

When running on Windows Vista, Windows Server 2008, and later, the CancelIoEx function is always used. This function does not have the problems described above.

◆ cancel() [2/2]

template<typename Protocol, typename Executor>

ASIO_SYNC_OP_VOID asio::basic_socket< Protocol, Executor >::cancel ( asio::error_code & ec )

inline

Cancel all asynchronous operations associated with the socket.

This function causes all outstanding asynchronous connect, send and receive operations to finish immediately, and the handlers for cancelled operations will be passed the asio::error::operation_aborted error.

Parameters

ec	Set to indicate what error occurred, if any.

Note: Calls to cancel() will always fail with asio::error::operation_not_supported when run on Windows XP, Windows Server 2003, and earlier versions of Windows, unless ASIO_ENABLE_CANCELIO is defined. However, the CancelIo function has two issues that should be considered before enabling its use:

It will only cancel asynchronous operations that were initiated in the current thread.

It can appear to complete without error, but the request to cancel the unfinished operations may be silently ignored by the operating system. Whether it works or not seems to depend on the drivers that are installed.

For portable cancellation, consider using one of the following alternatives:

Disable asio's I/O completion port backend by defining ASIO_DISABLE_IOCP.

Use the close() function to simultaneously cancel the outstanding operations and close the socket.

When running on Windows Vista, Windows Server 2008, and later, the CancelIoEx function is always used. This function does not have the problems described above.

◆ close() [1/2]

template<typename Protocol, typename Executor>

void asio::basic_socket< Protocol, Executor >::close ( )

inline

Close the socket.

This function is used to close the socket. Any asynchronous send, receive or connect operations will be cancelled immediately, and will complete with the asio::error::operation_aborted error.

Exceptions

asio::system_error Thrown on failure. Note that, even if the function indicates an error, the underlying descriptor is closed.

Note: For portable behaviour with respect to graceful closure of a connected socket, call shutdown() before closing the socket.

◆ close() [2/2]

template<typename Protocol, typename Executor>

ASIO_SYNC_OP_VOID asio::basic_socket< Protocol, Executor >::close ( asio::error_code & ec )

inline

Close the socket.

This function is used to close the socket. Any asynchronous send, receive or connect operations will be cancelled immediately, and will complete with the asio::error::operation_aborted error.

Parameters

ec	Set to indicate what error occurred, if any. Note that, even if the function indicates an error, the underlying descriptor is closed.

Example: asio::ip::tcp::socket socket(my_context);
...
asio::error_code ec;
socket.close(ec);
if (ec)
{
// An error occurred.
}

Note: For portable behaviour with respect to graceful closure of a connected socket, call shutdown() before closing the socket.

◆ connect() [1/2]

template<typename Protocol, typename Executor>

void asio::basic_socket< Protocol, Executor >::connect ( const endpoint_type & peer_endpoint )

inline

Connect the socket to the specified endpoint.

This function is used to connect a socket to the specified remote endpoint. The function call will block until the connection is successfully made or an error occurs.

The socket is automatically opened if it is not already open. If the connect fails, and the socket was automatically opened, the socket is not returned to the closed state.

Parameters

peer_endpoint The remote endpoint to which the socket will be connected.

Exceptions

asio::system_error Thrown on failure.

Example: asio::ip::tcp::socket socket(my_context);
asio::ip::tcp::endpoint endpoint(
asio::ip::address::from_string("1.2.3.4"), 12345);
socket.connect(endpoint);

◆ connect() [2/2]

template<typename Protocol, typename Executor>

ASIO_SYNC_OP_VOID asio::basic_socket< Protocol, Executor >::connect	(	const endpoint_type &	peer_endpoint,
		asio::error_code &	ec
	)

inline

Connect the socket to the specified endpoint.

This function is used to connect a socket to the specified remote endpoint. The function call will block until the connection is successfully made or an error occurs.

The socket is automatically opened if it is not already open. If the connect fails, and the socket was automatically opened, the socket is not returned to the closed state.

Parameters

peer_endpoint	The remote endpoint to which the socket will be connected.
ec	Set to indicate what error occurred, if any.

Example: asio::ip::tcp::socket socket(my_context);
asio::ip::tcp::endpoint endpoint(
asio::ip::address::from_string("1.2.3.4"), 12345);
asio::error_code ec;
socket.connect(endpoint, ec);
if (ec)
{
// An error occurred.
}

◆ get_option() [1/2]

template<typename Protocol, typename Executor>

template<typename GettableSocketOption >

void asio::basic_socket< Protocol, Executor >::get_option ( GettableSocketOption & option ) const

inline

Get an option from the socket.

This function is used to get the current value of an option on the socket.

Parameters

option The option value to be obtained from the socket.

Exceptions

asio::system_error Thrown on failure.

See also: GettableSocketOption
asio::socket_base::broadcast
asio::socket_base::do_not_route
asio::socket_base::keep_alive
asio::socket_base::linger
asio::socket_base::receive_buffer_size
asio::socket_base::receive_low_watermark
asio::socket_base::reuse_address
asio::socket_base::send_buffer_size
asio::socket_base::send_low_watermark
asio::ip::multicast::join_group
asio::ip::multicast::leave_group
asio::ip::multicast::enable_loopback
asio::ip::multicast::outbound_interface
asio::ip::multicast::hops
asio::ip::tcp::no_delay

Example: Getting the value of the SOL_SOCKET/SO_KEEPALIVE option:
asio::ip::tcp::socket socket(my_context);
...
asio::ip::tcp::socket::keep_alive option;
socket.get_option(option);
bool is_set = option.value();

◆ get_option() [2/2]

template<typename Protocol, typename Executor>

template<typename GettableSocketOption >

ASIO_SYNC_OP_VOID asio::basic_socket< Protocol, Executor >::get_option	(	GettableSocketOption &	option,
		asio::error_code &	ec
	)		const

inline

Get an option from the socket.

This function is used to get the current value of an option on the socket.

Parameters

option	The option value to be obtained from the socket.
ec	Set to indicate what error occurred, if any.

See also: GettableSocketOption
asio::socket_base::broadcast
asio::socket_base::do_not_route
asio::socket_base::keep_alive
asio::socket_base::linger
asio::socket_base::receive_buffer_size
asio::socket_base::receive_low_watermark
asio::socket_base::reuse_address
asio::socket_base::send_buffer_size
asio::socket_base::send_low_watermark
asio::ip::multicast::join_group
asio::ip::multicast::leave_group
asio::ip::multicast::enable_loopback
asio::ip::multicast::outbound_interface
asio::ip::multicast::hops
asio::ip::tcp::no_delay

Example: Getting the value of the SOL_SOCKET/SO_KEEPALIVE option:
asio::ip::tcp::socket socket(my_context);
...
asio::ip::tcp::socket::keep_alive option;
asio::error_code ec;
socket.get_option(option, ec);
if (ec)
{
// An error occurred.
}
bool is_set = option.value();

◆ io_control() [1/2]

template<typename Protocol, typename Executor>

template<typename IoControlCommand >

void asio::basic_socket< Protocol, Executor >::io_control ( IoControlCommand & command )

inline

Perform an IO control command on the socket.

This function is used to execute an IO control command on the socket.

Parameters

command The IO control command to be performed on the socket.

Exceptions

asio::system_error Thrown on failure.

See also: IoControlCommand
asio::socket_base::bytes_readable
asio::socket_base::non_blocking_io

Example: Getting the number of bytes ready to read:
asio::ip::tcp::socket socket(my_context);
...
asio::ip::tcp::socket::bytes_readable command;
socket.io_control(command);
std::size_t bytes_readable = command.get();

◆ io_control() [2/2]

template<typename Protocol, typename Executor>

template<typename IoControlCommand >

ASIO_SYNC_OP_VOID asio::basic_socket< Protocol, Executor >::io_control	(	IoControlCommand &	command,
		asio::error_code &	ec
	)

inline

Perform an IO control command on the socket.

This function is used to execute an IO control command on the socket.

Parameters

command	The IO control command to be performed on the socket.
ec	Set to indicate what error occurred, if any.

See also: IoControlCommand
asio::socket_base::bytes_readable
asio::socket_base::non_blocking_io

Example: Getting the number of bytes ready to read:
asio::ip::tcp::socket socket(my_context);
...
asio::ip::tcp::socket::bytes_readable command;
asio::error_code ec;
socket.io_control(command, ec);
if (ec)
{
// An error occurred.
}
std::size_t bytes_readable = command.get();

◆ local_endpoint() [1/2]

template<typename Protocol, typename Executor>

endpoint_type asio::basic_socket< Protocol, Executor >::local_endpoint ( ) const

inline

Get the local endpoint of the socket.

This function is used to obtain the locally bound endpoint of the socket.

Returns: An object that represents the local endpoint of the socket.

Exceptions

asio::system_error Thrown on failure.

Example: asio::ip::tcp::socket socket(my_context);
...
asio::ip::tcp::endpoint endpoint = socket.local_endpoint();

◆ local_endpoint() [2/2]

template<typename Protocol, typename Executor>

endpoint_type asio::basic_socket< Protocol, Executor >::local_endpoint ( asio::error_code & ec ) const

inline

Get the local endpoint of the socket.

This function is used to obtain the locally bound endpoint of the socket.

Parameters

ec	Set to indicate what error occurred, if any.

Returns: An object that represents the local endpoint of the socket. Returns a default-constructed endpoint object if an error occurred.

Example: asio::ip::tcp::socket socket(my_context);
...
asio::error_code ec;
asio::ip::tcp::endpoint endpoint = socket.local_endpoint(ec);
if (ec)
{
// An error occurred.
}

◆ lowest_layer() [1/2]

template<typename Protocol, typename Executor>

lowest_layer_type& asio::basic_socket< Protocol, Executor >::lowest_layer ( )

inline

Get a reference to the lowest layer.

This function returns a reference to the lowest layer in a stack of layers. Since a basic_socket cannot contain any further layers, it simply returns a reference to itself.

Returns: A reference to the lowest layer in the stack of layers. Ownership is not transferred to the caller.

◆ lowest_layer() [2/2]

template<typename Protocol, typename Executor>

const lowest_layer_type& asio::basic_socket< Protocol, Executor >::lowest_layer ( ) const

inline

Get a const reference to the lowest layer.

This function returns a const reference to the lowest layer in a stack of layers. Since a basic_socket cannot contain any further layers, it simply returns a reference to itself.

Returns: A const reference to the lowest layer in the stack of layers. Ownership is not transferred to the caller.

◆ native_handle()

template<typename Protocol, typename Executor>

native_handle_type asio::basic_socket< Protocol, Executor >::native_handle ( )

inline

Get the native socket representation.

This function may be used to obtain the underlying representation of the socket. This is intended to allow access to native socket functionality that is not otherwise provided.

◆ native_non_blocking() [1/3]

template<typename Protocol, typename Executor>

bool asio::basic_socket< Protocol, Executor >::native_non_blocking ( ) const

inline

Gets the non-blocking mode of the native socket implementation.

This function is used to retrieve the non-blocking mode of the underlying native socket. This mode has no effect on the behaviour of the socket object's synchronous operations.

Returns: true if the underlying socket is in non-blocking mode and direct system calls may fail with asio::error::would_block (or the equivalent system error).

Note: The current non-blocking mode is cached by the socket object. Consequently, the return value may be incorrect if the non-blocking mode was set directly on the native socket.

Example: This function is intended to allow the encapsulation of arbitrary non-blocking system calls as asynchronous operations, in a way that is transparent to the user of the socket object. The following example illustrates how Linux's sendfile system call might be encapsulated:
template <typename Handler>
struct sendfile_op
{
tcp::socket& sock_;
int fd_;
Handler handler_;
off_t offset_;
std::size_t total_bytes_transferred_;
// Function call operator meeting WriteHandler requirements.
// Used as the handler for the async_write_some operation.
void operator()(asio::error_code ec, std::size_t)
{
// Put the underlying socket into non-blocking mode.
if (!ec)
if (!sock_.native_non_blocking())
sock_.native_non_blocking(true, ec);
if (!ec)
{
for (;;)
{
// Try the system call.
errno = 0;
int n = ::sendfile(sock_.native_handle(), fd_, &offset_, 65536);
ec = asio::error_code(n < 0 ? errno : 0,
asio::error::get_system_category());
total_bytes_transferred_ += ec ? 0 : n;
// Retry operation immediately if interrupted by signal.
if (ec == asio::error::interrupted)
continue;
// Check if we need to run the operation again.
if (ec == asio::error::would_block
|| ec == asio::error::try_again)
{
// We have to wait for the socket to become ready again.
sock_.async_wait(tcp::socket::wait_write, *this);
return;
}
if (ec || n == 0)
{
// An error occurred, or we have reached the end of the file.
// Either way we must exit the loop so we can call the handler.
break;
}
// Loop around to try calling sendfile again.
}
}
// Pass result back to user's handler.
handler_(ec, total_bytes_transferred_);
}
};
template <typename Handler>
void async_sendfile(tcp::socket& sock, int fd, Handler h)
{
sendfile_op<Handler> op = { sock, fd, h, 0, 0 };
sock.async_wait(tcp::socket::wait_write, op);
}

◆ native_non_blocking() [2/3]

template<typename Protocol, typename Executor>

void asio::basic_socket< Protocol, Executor >::native_non_blocking ( bool mode )

inline

Sets the non-blocking mode of the native socket implementation.

This function is used to modify the non-blocking mode of the underlying native socket. It has no effect on the behaviour of the socket object's synchronous operations.

Parameters

mode	If `true`, the underlying socket is put into non-blocking mode and direct system calls may fail with asio::error::would_block (or the equivalent system error).

Exceptions

asio::system_error Thrown on failure. If the mode is false, but the current value of non_blocking() is true, this function fails with asio::error::invalid_argument, as the combination does not make sense.

Example: This function is intended to allow the encapsulation of arbitrary non-blocking system calls as asynchronous operations, in a way that is transparent to the user of the socket object. The following example illustrates how Linux's sendfile system call might be encapsulated:
template <typename Handler>
struct sendfile_op
{
tcp::socket& sock_;
int fd_;
Handler handler_;
off_t offset_;
std::size_t total_bytes_transferred_;
// Function call operator meeting WriteHandler requirements.
// Used as the handler for the async_write_some operation.
void operator()(asio::error_code ec, std::size_t)
{
// Put the underlying socket into non-blocking mode.
if (!ec)
if (!sock_.native_non_blocking())
sock_.native_non_blocking(true, ec);
if (!ec)
{
for (;;)
{
// Try the system call.
errno = 0;
int n = ::sendfile(sock_.native_handle(), fd_, &offset_, 65536);
ec = asio::error_code(n < 0 ? errno : 0,
asio::error::get_system_category());
total_bytes_transferred_ += ec ? 0 : n;
// Retry operation immediately if interrupted by signal.
if (ec == asio::error::interrupted)
continue;
// Check if we need to run the operation again.
if (ec == asio::error::would_block
|| ec == asio::error::try_again)
{
// We have to wait for the socket to become ready again.
sock_.async_wait(tcp::socket::wait_write, *this);
return;
}
if (ec || n == 0)
{
// An error occurred, or we have reached the end of the file.
// Either way we must exit the loop so we can call the handler.
break;
}
// Loop around to try calling sendfile again.
}
}
// Pass result back to user's handler.
handler_(ec, total_bytes_transferred_);
}
};
template <typename Handler>
void async_sendfile(tcp::socket& sock, int fd, Handler h)
{
sendfile_op<Handler> op = { sock, fd, h, 0, 0 };
sock.async_wait(tcp::socket::wait_write, op);
}

◆ native_non_blocking() [3/3]

template<typename Protocol, typename Executor>

ASIO_SYNC_OP_VOID asio::basic_socket< Protocol, Executor >::native_non_blocking	(	bool	mode,
		asio::error_code &	ec
	)

inline

Sets the non-blocking mode of the native socket implementation.

This function is used to modify the non-blocking mode of the underlying native socket. It has no effect on the behaviour of the socket object's synchronous operations.

Parameters

mode	If `true`, the underlying socket is put into non-blocking mode and direct system calls may fail with asio::error::would_block (or the equivalent system error).
ec	Set to indicate what error occurred, if any. If the `mode` is `false`, but the current value of `non_blocking()` is `true`, this function fails with asio::error::invalid_argument, as the combination does not make sense.

Example: This function is intended to allow the encapsulation of arbitrary non-blocking system calls as asynchronous operations, in a way that is transparent to the user of the socket object. The following example illustrates how Linux's sendfile system call might be encapsulated:
template <typename Handler>
struct sendfile_op
{
tcp::socket& sock_;
int fd_;
Handler handler_;
off_t offset_;
std::size_t total_bytes_transferred_;
// Function call operator meeting WriteHandler requirements.
// Used as the handler for the async_write_some operation.
void operator()(asio::error_code ec, std::size_t)
{
// Put the underlying socket into non-blocking mode.
if (!ec)
if (!sock_.native_non_blocking())
sock_.native_non_blocking(true, ec);
if (!ec)
{
for (;;)
{
// Try the system call.
errno = 0;
int n = ::sendfile(sock_.native_handle(), fd_, &offset_, 65536);
ec = asio::error_code(n < 0 ? errno : 0,
asio::error::get_system_category());
total_bytes_transferred_ += ec ? 0 : n;
// Retry operation immediately if interrupted by signal.
if (ec == asio::error::interrupted)
continue;
// Check if we need to run the operation again.
if (ec == asio::error::would_block
|| ec == asio::error::try_again)
{
// We have to wait for the socket to become ready again.
sock_.async_wait(tcp::socket::wait_write, *this);
return;
}
if (ec || n == 0)
{
// An error occurred, or we have reached the end of the file.
// Either way we must exit the loop so we can call the handler.
break;
}
// Loop around to try calling sendfile again.
}
}
// Pass result back to user's handler.
handler_(ec, total_bytes_transferred_);
}
};
template <typename Handler>
void async_sendfile(tcp::socket& sock, int fd, Handler h)
{
sendfile_op<Handler> op = { sock, fd, h, 0, 0 };
sock.async_wait(tcp::socket::wait_write, op);
}

◆ non_blocking() [1/3]

template<typename Protocol, typename Executor>

bool asio::basic_socket< Protocol, Executor >::non_blocking ( ) const

inline

Gets the non-blocking mode of the socket.

Returns: true if the socket's synchronous operations will fail with asio::error::would_block if they are unable to perform the requested operation immediately. If 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 asio::error::would_block.

◆ non_blocking() [2/3]

template<typename Protocol, typename Executor>

void asio::basic_socket< Protocol, Executor >::non_blocking ( bool mode )

inline

Sets the non-blocking mode of the socket.

Parameters

mode	If `true`, the socket's synchronous operations will fail with asio::error::would_block if they are unable to perform the requested operation immediately. If `false`, synchronous operations will block until complete.

Exceptions

asio::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 asio::error::would_block.

◆ non_blocking() [3/3]

template<typename Protocol, typename Executor>

ASIO_SYNC_OP_VOID asio::basic_socket< Protocol, Executor >::non_blocking	(	bool	mode,
		asio::error_code &	ec
	)

inline

Sets the non-blocking mode of the socket.

Parameters

mode	If `true`, the socket's synchronous operations will fail with asio::error::would_block if they are unable to perform the requested operation immediately. If `false`, synchronous operations will block until complete.
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 asio::error::would_block.

◆ open() [1/2]

template<typename Protocol, typename Executor>

void asio::basic_socket< Protocol, Executor >::open ( const protocol_type & protocol = protocol_type() )

inline

Open the socket using the specified protocol.

This function opens the socket so that it will use the specified protocol.

Parameters

protocol An object specifying protocol parameters to be used.

Exceptions

asio::system_error Thrown on failure.

Example: asio::ip::tcp::socket socket(my_context);
socket.open(asio::ip::tcp::v4());

◆ open() [2/2]

template<typename Protocol, typename Executor>

ASIO_SYNC_OP_VOID asio::basic_socket< Protocol, Executor >::open	(	const protocol_type &	protocol,
		asio::error_code &	ec
	)

inline

Open the socket using the specified protocol.

This function opens the socket so that it will use the specified protocol.

Parameters

protocol	An object specifying which protocol is to be used.
ec	Set to indicate what error occurred, if any.

Example: asio::ip::tcp::socket socket(my_context);
asio::error_code ec;
socket.open(asio::ip::tcp::v4(), ec);
if (ec)
{
// An error occurred.
}

◆ release() [1/2]

template<typename Protocol, typename Executor>

native_handle_type asio::basic_socket< Protocol, Executor >::release ( )

inline

Release ownership of the underlying native socket.

This function causes all outstanding asynchronous connect, send and receive operations to finish immediately, and the handlers for cancelled operations will be passed the asio::error::operation_aborted error. Ownership of the native socket is then transferred to the caller.

Exceptions

asio::system_error Thrown on failure.

Note: This function is unsupported on Windows versions prior to Windows 8.1, and will fail with asio::error::operation_not_supported on these platforms.

◆ release() [2/2]

template<typename Protocol, typename Executor>

native_handle_type asio::basic_socket< Protocol, Executor >::release ( asio::error_code & ec )

inline

Release ownership of the underlying native socket.

This function causes all outstanding asynchronous connect, send and receive operations to finish immediately, and the handlers for cancelled operations will be passed the asio::error::operation_aborted error. Ownership of the native socket is then transferred to the caller.

Parameters

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 asio::error::operation_not_supported on these platforms.

◆ remote_endpoint() [1/2]

template<typename Protocol, typename Executor>

endpoint_type asio::basic_socket< Protocol, Executor >::remote_endpoint ( ) const

inline

Get the remote endpoint of the socket.

This function is used to obtain the remote endpoint of the socket.

Returns: An object that represents the remote endpoint of the socket.

Exceptions

asio::system_error Thrown on failure.

Example: asio::ip::tcp::socket socket(my_context);
...
asio::ip::tcp::endpoint endpoint = socket.remote_endpoint();

◆ remote_endpoint() [2/2]

template<typename Protocol, typename Executor>

endpoint_type asio::basic_socket< Protocol, Executor >::remote_endpoint ( asio::error_code & ec ) const

inline

Get the remote endpoint of the socket.

This function is used to obtain the remote endpoint of the socket.

Parameters

ec	Set to indicate what error occurred, if any.

Returns: An object that represents the remote endpoint of the socket. Returns a default-constructed endpoint object if an error occurred.

Example: asio::ip::tcp::socket socket(my_context);
...
asio::error_code ec;
asio::ip::tcp::endpoint endpoint = socket.remote_endpoint(ec);
if (ec)
{
// An error occurred.
}

◆ set_option() [1/2]

template<typename Protocol, typename Executor>

template<typename SettableSocketOption >

void asio::basic_socket< Protocol, Executor >::set_option ( const SettableSocketOption & option )

inline

Set an option on the socket.

This function is used to set an option on the socket.

Parameters

option The new option value to be set on the socket.

Exceptions

asio::system_error Thrown on failure.

See also: SettableSocketOption
asio::socket_base::broadcast
asio::socket_base::do_not_route
asio::socket_base::keep_alive
asio::socket_base::linger
asio::socket_base::receive_buffer_size
asio::socket_base::receive_low_watermark
asio::socket_base::reuse_address
asio::socket_base::send_buffer_size
asio::socket_base::send_low_watermark
asio::ip::multicast::join_group
asio::ip::multicast::leave_group
asio::ip::multicast::enable_loopback
asio::ip::multicast::outbound_interface
asio::ip::multicast::hops
asio::ip::tcp::no_delay

Example: Setting the IPPROTO_TCP/TCP_NODELAY option:
asio::ip::tcp::socket socket(my_context);
...
asio::ip::tcp::no_delay option(true);
socket.set_option(option);

◆ set_option() [2/2]

template<typename Protocol, typename Executor>

template<typename SettableSocketOption >

ASIO_SYNC_OP_VOID asio::basic_socket< Protocol, Executor >::set_option	(	const SettableSocketOption &	option,
		asio::error_code &	ec
	)

inline

Set an option on the socket.

This function is used to set an option on the socket.

Parameters

option	The new option value to be set on the socket.
ec	Set to indicate what error occurred, if any.

See also: SettableSocketOption
asio::socket_base::broadcast
asio::socket_base::do_not_route
asio::socket_base::keep_alive
asio::socket_base::linger
asio::socket_base::receive_buffer_size
asio::socket_base::receive_low_watermark
asio::socket_base::reuse_address
asio::socket_base::send_buffer_size
asio::socket_base::send_low_watermark
asio::ip::multicast::join_group
asio::ip::multicast::leave_group
asio::ip::multicast::enable_loopback
asio::ip::multicast::outbound_interface
asio::ip::multicast::hops
asio::ip::tcp::no_delay

Example: Setting the IPPROTO_TCP/TCP_NODELAY option:
asio::ip::tcp::socket socket(my_context);
...
asio::ip::tcp::no_delay option(true);
asio::error_code ec;
socket.set_option(option, ec);
if (ec)
{
// An error occurred.
}

◆ shutdown() [1/2]

template<typename Protocol, typename Executor>

void asio::basic_socket< Protocol, Executor >::shutdown ( shutdown_type what )

inline

Disable sends or receives on the socket.

This function is used to disable send operations, receive operations, or both.

Parameters

what	Determines what types of operation will no longer be allowed.

Exceptions

asio::system_error Thrown on failure.

Example: Shutting down the send side of the socket:
asio::ip::tcp::socket socket(my_context);
...
socket.shutdown(asio::ip::tcp::socket::shutdown_send);

◆ shutdown() [2/2]

template<typename Protocol, typename Executor>

ASIO_SYNC_OP_VOID asio::basic_socket< Protocol, Executor >::shutdown	(	shutdown_type	what,
		asio::error_code &	ec
	)

inline

Disable sends or receives on the socket.

This function is used to disable send operations, receive operations, or both.

Parameters

what	Determines what types of operation will no longer be allowed.
ec	Set to indicate what error occurred, if any.

Example: Shutting down the send side of the socket:
asio::ip::tcp::socket socket(my_context);
...
asio::error_code ec;
socket.shutdown(asio::ip::tcp::socket::shutdown_send, ec);
if (ec)
{
// An error occurred.
}

◆ wait() [1/2]

template<typename Protocol, typename Executor>

void asio::basic_socket< Protocol, Executor >::wait ( wait_type w )

inline

Wait for the socket to become ready to read, ready to write, or to have pending error conditions.

This function is used to perform a blocking wait for a socket to enter a ready to read, write or error condition state.

Parameters

w	Specifies the desired socket state.

Example: Waiting for a socket to become readable.
asio::ip::tcp::socket socket(my_context);
...
socket.wait(asio::ip::tcp::socket::wait_read);

◆ wait() [2/2]

template<typename Protocol, typename Executor>

ASIO_SYNC_OP_VOID asio::basic_socket< Protocol, Executor >::wait	(	wait_type	w,
		asio::error_code &	ec
	)

inline

Wait for the socket to become ready to read, ready to write, or to have pending error conditions.

This function is used to perform a blocking wait for a socket to enter a ready to read, write or error condition state.

Parameters

w	Specifies the desired socket state.
ec	Set to indicate what error occurred, if any.

Example: Waiting for a socket to become readable.
asio::ip::tcp::socket socket(my_context);
...
asio::error_code ec;
socket.wait(asio::ip::tcp::socket::wait_read, ec);

The documentation for this class was generated from the following file:

Thirdparty/asio/include/asio/basic_socket.hpp

Classes

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

template<typename Protocol, typename Executor> class asio::basic_socket< Protocol, Executor >

Constructor & Destructor Documentation

◆ basic_socket() [1/8]

◆ basic_socket() [2/8]

◆ basic_socket() [3/8]

◆ basic_socket() [4/8]

◆ basic_socket() [5/8]

◆ basic_socket() [6/8]

◆ basic_socket() [7/8]

◆ basic_socket() [8/8]

◆ ~basic_socket()

Member Function Documentation

◆ ASIO_INITFN_AUTO_RESULT_TYPE() [1/2]

◆ ASIO_INITFN_AUTO_RESULT_TYPE() [2/2]

◆ at_mark() [1/2]

◆ at_mark() [2/2]

◆ available() [1/2]

◆ available() [2/2]

◆ bind() [1/2]

◆ bind() [2/2]

◆ cancel() [1/2]

◆ cancel() [2/2]

◆ close() [1/2]

◆ close() [2/2]

◆ connect() [1/2]

◆ connect() [2/2]

◆ get_option() [1/2]

◆ get_option() [2/2]

◆ io_control() [1/2]

◆ io_control() [2/2]

◆ local_endpoint() [1/2]

◆ local_endpoint() [2/2]

◆ lowest_layer() [1/2]

◆ lowest_layer() [2/2]

◆ native_handle()

◆ native_non_blocking() [1/3]

◆ native_non_blocking() [2/3]

◆ native_non_blocking() [3/3]

◆ non_blocking() [1/3]

◆ non_blocking() [2/3]

◆ non_blocking() [3/3]

◆ open() [1/2]

◆ open() [2/2]

◆ release() [1/2]

◆ release() [2/2]

◆ remote_endpoint() [1/2]

◆ remote_endpoint() [2/2]

◆ set_option() [1/2]

◆ set_option() [2/2]

◆ shutdown() [1/2]

◆ shutdown() [2/2]

◆ wait() [1/2]

◆ wait() [2/2]

template<typename Protocol, typename Executor>
class asio::basic_socket< Protocol, Executor >