Realistic 3D camera system
3D camera system components
Public Types | Public Member Functions | Protected Member Functions | List of all members
asio::socket_base Class Reference

#include <socket_base.hpp>

Inheritance diagram for asio::socket_base:
asio::basic_socket< Protocol, SocketService > asio::basic_socket_acceptor< Protocol, SocketAcceptorService > asio::basic_socket< Protocol, DatagramSocketService > asio::basic_socket< Protocol, RawSocketService > asio::basic_socket< Protocol, SeqPacketSocketService > asio::basic_socket< Protocol, StreamSocketService > asio::basic_socket< Protocol1, SocketService > asio::basic_datagram_socket< Protocol, DatagramSocketService > asio::basic_raw_socket< Protocol, RawSocketService > asio::basic_seq_packet_socket< Protocol, SeqPacketSocketService > asio::basic_socket_streambuf< Protocol, StreamSocketService, Time, TimeTraits, TimerService > asio::basic_stream_socket< Protocol, StreamSocketService >

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. More...
 
typedef int message_flags
 Bitmask type for flags that can be passed to send and receive operations. More...
 
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
 
typedef asio::detail::socket_option::linger< ASIO_OS_DEF(SOL_SOCKET), ASIO_OS_DEF(SO_LINGER)> linger
 
typedef asio::detail::socket_option::boolean< asio::detail::custom_socket_option_level, asio::detail::enable_connection_aborted_optionenable_connection_aborted
 Socket option to report aborted connections on accept. More...
 
typedef asio::detail::io_control::non_blocking_io non_blocking_io
 
typedef asio::detail::io_control::bytes_readable bytes_readable
 

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_connections=ASIO_OS_DEF(SOMAXCONN))
 The maximum length of the queue of pending incoming connections. More...
 

Protected Member Functions

 ~socket_base ()
 Protected destructor to prevent deletion through this type. More...
 

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.

Definition at line 30 of file socket_base.hpp.

Member Typedef Documentation

Socket option to permit sending of broadcast messages.

Implements the SOL_SOCKET/SO_BROADCAST socket option.

Examples
Setting the option:
...
asio::socket_base::broadcast option(true);
socket.set_option(option);
Getting the current option value:
...
asio::socket_base::broadcast option;
socket.get_option(option);
bool is_set = option.value();
Concepts:
Socket_Option, Boolean_Socket_Option.

Definition at line 109 of file socket_base.hpp.

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

Example
...
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.

Definition at line 498 of file socket_base.hpp.

Socket option to enable socket-level debugging.

Implements the SOL_SOCKET/SO_DEBUG socket option.

Examples
Setting the option:
...
asio::socket_base::debug option(true);
socket.set_option(option);
Getting the current option value:
...
asio::socket_base::debug option;
socket.get_option(option);
bool is_set = option.value();
Concepts:
Socket_Option, Boolean_Socket_Option.

Definition at line 142 of file socket_base.hpp.

Socket option to prevent routing, use local interfaces only.

Implements the SOL_SOCKET/SO_DONTROUTE socket option.

Examples
Setting the option:
...
asio::socket_base::do_not_route option(true);
socket.set_option(option);
Getting the current option value:
...
asio::socket_base::do_not_route option;
socket.get_option(option);
bool is_set = option.value();
Concepts:
Socket_Option, Boolean_Socket_Option.

Definition at line 176 of file socket_base.hpp.

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(io_service);
...
asio::socket_base::enable_connection_aborted option(true);
acceptor.set_option(option);
Getting the current option value:
asio::ip::tcp::acceptor acceptor(io_service);
...
asio::socket_base::enable_connection_aborted option;
acceptor.get_option(option);
bool is_set = option.value();
Concepts:
Socket_Option, Boolean_Socket_Option.

Definition at line 453 of file socket_base.hpp.

Socket option to send keep-alives.

Implements the SOL_SOCKET/SO_KEEPALIVE socket option.

Examples
Setting the option:
...
asio::socket_base::keep_alive option(true);
socket.set_option(option);
Getting the current option value:
...
asio::socket_base::keep_alive option;
socket.get_option(option);
bool is_set = option.value();
Concepts:
Socket_Option, Boolean_Socket_Option.

Definition at line 209 of file socket_base.hpp.

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::socket_base::linger option(true, 30);
socket.set_option(option);
Getting the current option value:
...
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.

Definition at line 416 of file socket_base.hpp.

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

Definition at line 53 of file socket_base.hpp.

(Deprecated: Use non_blocking().) IO control command to set the blocking mode of the socket. Implements the FIONBIO IO control command.

Example
...
asio::socket_base::non_blocking_io command(true);
socket.io_control(command);
Concepts:
IO_Control_Command, Boolean_IO_Control_Command.

Definition at line 475 of file socket_base.hpp.

Socket option for the receive buffer size of a socket.

Implements the SOL_SOCKET/SO_RCVBUF socket option.

Examples
Setting the option:
...
asio::socket_base::receive_buffer_size option(8192);
socket.set_option(option);
Getting the current option value:
...
asio::socket_base::receive_buffer_size option;
socket.get_option(option);
int size = option.value();
Concepts:
Socket_Option, Integer_Socket_Option.

Definition at line 311 of file socket_base.hpp.

Socket option for the receive low watermark.

Implements the SOL_SOCKET/SO_RCVLOWAT socket option.

Examples
Setting the option:
...
asio::socket_base::receive_low_watermark option(1024);
socket.set_option(option);
Getting the current option value:
...
asio::socket_base::receive_low_watermark option;
socket.get_option(option);
int size = option.value();
Concepts:
Socket_Option, Integer_Socket_Option.

Definition at line 345 of file socket_base.hpp.

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(io_service);
...
asio::socket_base::reuse_address option(true);
acceptor.set_option(option);
Getting the current option value:
asio::ip::tcp::acceptor acceptor(io_service);
...
asio::socket_base::reuse_address option;
acceptor.get_option(option);
bool is_set = option.value();
Concepts:
Socket_Option, Boolean_Socket_Option.

Definition at line 380 of file socket_base.hpp.

Socket option for the send buffer size of a socket.

Implements the SOL_SOCKET/SO_SNDBUF socket option.

Examples
Setting the option:
...
asio::socket_base::send_buffer_size option(8192);
socket.set_option(option);
Getting the current option value:
...
asio::socket_base::send_buffer_size option;
socket.get_option(option);
int size = option.value();
Concepts:
Socket_Option, Integer_Socket_Option.

Definition at line 243 of file socket_base.hpp.

Socket option for the send low watermark.

Implements the SOL_SOCKET/SO_SNDLOWAT socket option.

Examples
Setting the option:
...
asio::socket_base::send_low_watermark option(1024);
socket.set_option(option);
Getting the current option value:
...
asio::socket_base::send_low_watermark option;
socket.get_option(option);
int size = option.value();
Concepts:
Socket_Option, Integer_Socket_Option.

Definition at line 277 of file socket_base.hpp.

Member Enumeration Documentation

Different ways a socket may be shutdown.

Enumerator
shutdown_receive 
shutdown_send 
shutdown_both 

Definition at line 34 of file socket_base.hpp.

Constructor & Destructor Documentation

asio::socket_base::~socket_base ( )
inlineprotected

Protected destructor to prevent deletion through this type.

Definition at line 511 of file socket_base.hpp.

Member Function Documentation

asio::socket_base::ASIO_STATIC_CONSTANT ( int  ,
message_peek  = ASIO_OS_DEF(MSG_PEEK) 
)
asio::socket_base::ASIO_STATIC_CONSTANT ( int  ,
message_out_of_band  = ASIO_OS_DEF(MSG_OOB) 
)
asio::socket_base::ASIO_STATIC_CONSTANT ( int  ,
message_do_not_route  = ASIO_OS_DEF(MSG_DONTROUTE) 
)
asio::socket_base::ASIO_STATIC_CONSTANT ( int  ,
message_end_of_record  = ASIO_OS_DEF(MSG_EOR) 
)
asio::socket_base::ASIO_STATIC_CONSTANT ( int  ,
max_connections  = ASIO_OS_DEF(SOMAXCONN) 
)

The maximum length of the queue of pending incoming connections.


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