The socket_base class is used as a base for the basic_stream_socket and basic_datagram_socket class templates so that we have a common place to define the shutdown_type and enum. More...

#include <socket_base.hpp>

Inheritance diagram for asio::socket_base:

[legend]

Public Types
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
	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
	~socket_base ()
	Protected destructor to prevent deletion through this type.

Detailed Description

The socket_base class is used as a base for the basic_stream_socket and basic_datagram_socket class templates so that we have a common place to define the shutdown_type and enum.

Member Typedef Documentation

◆ broadcast

typedef asio::detail::socket_option::boolean< ASIO_OS_DEF(SOL_SOCKET), ASIO_OS_DEF(SO_BROADCAST)> asio::socket_base::broadcast

Socket option to permit sending of broadcast messages.

Implements the SOL_SOCKET/SO_BROADCAST socket option.

Examples: Setting the option:
asio::ip::udp::socket socket(my_context);
...
asio::socket_base::broadcast option(true);
socket.set_option(option);

: Getting the current option value:
asio::ip::udp::socket socket(my_context);
...
asio::socket_base::broadcast option;
socket.get_option(option);
bool is_set = option.value();

Concepts:: Socket_Option, Boolean_Socket_Option.

◆ bytes_readable

typedef asio::detail::io_control::bytes_readable asio::socket_base::bytes_readable

IO control command to get the amount of data that can be read without blocking.

Implements the FIONREAD IO control command.

Example: asio::ip::tcp::socket socket(my_context);
...
asio::socket_base::bytes_readable command(true);
socket.io_control(command);
std::size_t bytes_readable = command.get();

Concepts:: IO_Control_Command, Size_IO_Control_Command.

◆ debug

typedef asio::detail::socket_option::boolean< ASIO_OS_DEF(SOL_SOCKET), ASIO_OS_DEF(SO_DEBUG)> asio::socket_base::debug

Socket option to enable socket-level debugging.

Implements the SOL_SOCKET/SO_DEBUG socket option.

Examples: Setting the option:
asio::ip::tcp::socket socket(my_context);
...
asio::socket_base::debug option(true);
socket.set_option(option);

: Getting the current option value:
asio::ip::tcp::socket socket(my_context);
...
asio::socket_base::debug option;
socket.get_option(option);
bool is_set = option.value();

Concepts:: Socket_Option, Boolean_Socket_Option.

◆ do_not_route

typedef asio::detail::socket_option::boolean< ASIO_OS_DEF(SOL_SOCKET), ASIO_OS_DEF(SO_DONTROUTE)> asio::socket_base::do_not_route

Socket option to prevent routing, use local interfaces only.

Implements the SOL_SOCKET/SO_DONTROUTE socket option.

Examples: Setting the option:
asio::ip::udp::socket socket(my_context);
...
asio::socket_base::do_not_route option(true);
socket.set_option(option);

: Getting the current option value:
asio::ip::udp::socket socket(my_context);
...
asio::socket_base::do_not_route option;
socket.get_option(option);
bool is_set = option.value();

Concepts:: Socket_Option, Boolean_Socket_Option.

◆ enable_connection_aborted

typedef asio::detail::socket_option::boolean< asio::detail::custom_socket_option_level, asio::detail::enable_connection_aborted_option> asio::socket_base::enable_connection_aborted

Socket option to report aborted connections on accept.

Implements a custom socket option that determines whether or not an accept operation is permitted to fail with asio::error::connection_aborted. By default the option is false.

Examples: Setting the option:
asio::ip::tcp::acceptor acceptor(my_context);
...
asio::socket_base::enable_connection_aborted option(true);
acceptor.set_option(option);

: Getting the current option value:
asio::ip::tcp::acceptor acceptor(my_context);
...
asio::socket_base::enable_connection_aborted option;
acceptor.get_option(option);
bool is_set = option.value();

Concepts:: Socket_Option, Boolean_Socket_Option.

◆ keep_alive

typedef asio::detail::socket_option::boolean< ASIO_OS_DEF(SOL_SOCKET), ASIO_OS_DEF(SO_KEEPALIVE)> asio::socket_base::keep_alive

Socket option to send keep-alives.

Implements the SOL_SOCKET/SO_KEEPALIVE socket option.

Examples: Setting the option:
asio::ip::tcp::socket socket(my_context);
...
asio::socket_base::keep_alive option(true);
socket.set_option(option);

: Getting the current option value:
asio::ip::tcp::socket socket(my_context);
...
asio::socket_base::keep_alive option;
socket.get_option(option);
bool is_set = option.value();

Concepts:: Socket_Option, Boolean_Socket_Option.

◆ linger

typedef asio::detail::socket_option::linger< ASIO_OS_DEF(SOL_SOCKET), ASIO_OS_DEF(SO_LINGER)> asio::socket_base::linger

Socket option to specify whether the socket lingers on close if unsent data is present.

Implements the SOL_SOCKET/SO_LINGER socket option.

Examples: Setting the option:
asio::ip::tcp::socket socket(my_context);
...
asio::socket_base::linger option(true, 30);
socket.set_option(option);

: Getting the current option value:
asio::ip::tcp::socket socket(my_context);
...
asio::socket_base::linger option;
socket.get_option(option);
bool is_set = option.enabled();
unsigned short timeout = option.timeout();

Concepts:: Socket_Option, Linger_Socket_Option.

◆ out_of_band_inline

typedef asio::detail::socket_option::boolean< ASIO_OS_DEF(SOL_SOCKET), ASIO_OS_DEF(SO_OOBINLINE)> asio::socket_base::out_of_band_inline

Socket option for putting received out-of-band data inline.

Implements the SOL_SOCKET/SO_OOBINLINE socket option.

Examples: Setting the option:
asio::ip::tcp::socket socket(my_context);
...
asio::socket_base::out_of_band_inline option(true);
socket.set_option(option);

: Getting the current option value:
asio::ip::tcp::socket socket(my_context);
...
asio::socket_base::out_of_band_inline option;
socket.get_option(option);
bool value = option.value();

Concepts:: Socket_Option, Boolean_Socket_Option.

◆ receive_buffer_size

typedef asio::detail::socket_option::integer< ASIO_OS_DEF(SOL_SOCKET), ASIO_OS_DEF(SO_RCVBUF)> asio::socket_base::receive_buffer_size

Socket option for the receive buffer size of a socket.

Implements the SOL_SOCKET/SO_RCVBUF socket option.

Examples: Setting the option:
asio::ip::tcp::socket socket(my_context);
...
asio::socket_base::receive_buffer_size option(8192);
socket.set_option(option);

: Getting the current option value:
asio::ip::tcp::socket socket(my_context);
...
asio::socket_base::receive_buffer_size option;
socket.get_option(option);
int size = option.value();

Concepts:: Socket_Option, Integer_Socket_Option.

◆ receive_low_watermark

typedef asio::detail::socket_option::integer< ASIO_OS_DEF(SOL_SOCKET), ASIO_OS_DEF(SO_RCVLOWAT)> asio::socket_base::receive_low_watermark

Socket option for the receive low watermark.

Implements the SOL_SOCKET/SO_RCVLOWAT socket option.

Examples: Setting the option:
asio::ip::tcp::socket socket(my_context);
...
asio::socket_base::receive_low_watermark option(1024);
socket.set_option(option);

: Getting the current option value:
asio::ip::tcp::socket socket(my_context);
...
asio::socket_base::receive_low_watermark option;
socket.get_option(option);
int size = option.value();

Concepts:: Socket_Option, Integer_Socket_Option.

◆ reuse_address

typedef asio::detail::socket_option::boolean< ASIO_OS_DEF(SOL_SOCKET), ASIO_OS_DEF(SO_REUSEADDR)> asio::socket_base::reuse_address

Socket option to allow the socket to be bound to an address that is already in use.

Implements the SOL_SOCKET/SO_REUSEADDR socket option.

Examples: Setting the option:
asio::ip::tcp::acceptor acceptor(my_context);
...
asio::socket_base::reuse_address option(true);
acceptor.set_option(option);

: Getting the current option value:
asio::ip::tcp::acceptor acceptor(my_context);
...
asio::socket_base::reuse_address option;
acceptor.get_option(option);
bool is_set = option.value();

Concepts:: Socket_Option, Boolean_Socket_Option.

◆ send_buffer_size

typedef asio::detail::socket_option::integer< ASIO_OS_DEF(SOL_SOCKET), ASIO_OS_DEF(SO_SNDBUF)> asio::socket_base::send_buffer_size

Socket option for the send buffer size of a socket.

Implements the SOL_SOCKET/SO_SNDBUF socket option.

Examples: Setting the option:
asio::ip::tcp::socket socket(my_context);
...
asio::socket_base::send_buffer_size option(8192);
socket.set_option(option);

: Getting the current option value:
asio::ip::tcp::socket socket(my_context);
...
asio::socket_base::send_buffer_size option;
socket.get_option(option);
int size = option.value();

Concepts:: Socket_Option, Integer_Socket_Option.

◆ send_low_watermark

typedef asio::detail::socket_option::integer< ASIO_OS_DEF(SOL_SOCKET), ASIO_OS_DEF(SO_SNDLOWAT)> asio::socket_base::send_low_watermark

Socket option for the send low watermark.

Implements the SOL_SOCKET/SO_SNDLOWAT socket option.

Examples: Setting the option:
asio::ip::tcp::socket socket(my_context);
...
asio::socket_base::send_low_watermark option(1024);
socket.set_option(option);

: Getting the current option value:
asio::ip::tcp::socket socket(my_context);
...
asio::socket_base::send_low_watermark option;
socket.get_option(option);
int size = option.value();

Concepts:: Socket_Option, Integer_Socket_Option.

Member Enumeration Documentation

◆ wait_type

enum asio::socket_base::wait_type

Wait types.

For use with basic_socket::wait() and basic_socket::async_wait().

Enumerator
wait_read	Wait for a socket to become ready to read.
wait_write	Wait for a socket to become ready to write.
wait_error	Wait for a socket to have error conditions pending.

Member Function Documentation

◆ ASIO_STATIC_CONSTANT()

asio::socket_base::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.

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

Thirdparty/asio/include/asio/socket_base.hpp

Public Types

Public Member Functions

Protected Member Functions