asio 0.3.8rc3 Home | Reference | Tutorial | Examples | Design
Reference Class Hierarchy | Class Index | Member Index

asio::basic_socket< Protocol, SocketService > Class Template Reference

Inherits asio::basic_io_object< SocketService >, and asio::socket_base.

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

Inheritance graph
List of all members.

Detailed Description

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

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.


Public Types

typedef SocketService::native_type native_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,
SocketService > 
lowest_layer_type
 A basic_socket is always the lowest layer.
typedef SocketService service_type
 The type of the service that will be used to provide I/O operations.
typedef service_type::implementation_type implementation_type
 The underlying implementation type of I/O object.
enum  shutdown_type {
  shutdown_receive = implementation_defined,
  shutdown_send = implementation_defined,
  shutdown_both = implementation_defined
}
 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.
typedef implementation_defined broadcast
 Socket option to permit sending of broadcast messages.
typedef implementation_defined debug
 Socket option to enable socket-level debugging.
typedef implementation_defined do_not_route
 Socket option to prevent routing, use local interfaces only.
typedef implementation_defined keep_alive
 Socket option to send keep-alives.
typedef implementation_defined send_buffer_size
 Socket option for the send buffer size of a socket.
typedef implementation_defined send_low_watermark
 Socket option for the send low watermark.
typedef implementation_defined receive_buffer_size
 Socket option for the receive buffer size of a socket.
typedef implementation_defined receive_low_watermark
 Socket option for the receive low watermark.
typedef implementation_defined reuse_address
 Socket option to allow the socket to be bound to an address that is already in use.
typedef implementation_defined linger
 Socket option to specify whether the socket lingers on close if unsent data is present.
typedef implementation_defined enable_connection_aborted
 Socket option to report aborted connections on accept.
typedef implementation_defined non_blocking_io
 IO control command to set the blocking mode of the socket.
typedef implementation_defined bytes_readable
 IO control command to get the amount of data that can be read without blocking.

Public Member Functions

 basic_socket (asio::io_service &io_service)
 Construct a basic_socket without opening it.
 basic_socket (asio::io_service &io_service, const protocol_type &protocol)
 Construct and open a basic_socket.
 basic_socket (asio::io_service &io_service, const endpoint_type &endpoint)
 Construct a basic_socket, opening it and binding it to the given local endpoint.
 basic_socket (asio::io_service &io_service, const protocol_type &protocol, const native_type &native_socket)
 Construct a basic_socket on an existing native socket.
lowest_layer_typelowest_layer ()
 Get a reference to the lowest layer.
void open (const protocol_type &protocol=protocol_type())
 Open the socket using the specified protocol.
asio::error_code open (const protocol_type &protocol, asio::error_code &ec)
 Open the socket using the specified protocol.
void assign (const protocol_type &protocol, const native_type &native_socket)
 Assign an existing native socket to the socket.
asio::error_code assign (const protocol_type &protocol, const native_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.
asio::error_code close (asio::error_code &ec)
 Close the socket.
native_type native ()
 Get the native socket representation.
void cancel ()
 Cancel all asynchronous operations associated with the socket.
asio::error_code cancel (asio::error_code &ec)
 Cancel all asynchronous operations associated with the socket.
bool at_mark () const
 Determine whether the socket is at the out-of-band data mark.
bool at_mark (asio::error_code &ec) const
 Determine whether the socket is at the out-of-band data mark.
std::size_t available () const
 Determine the number of bytes available for reading.
std::size_t available (asio::error_code &ec) const
 Determine the number of bytes available for reading.
void bind (const endpoint_type &endpoint)
 Bind the socket to the given local endpoint.
asio::error_code bind (const endpoint_type &endpoint, asio::error_code &ec)
 Bind the socket to the given local endpoint.
void connect (const endpoint_type &peer_endpoint)
 Connect the socket to the specified endpoint.
asio::error_code connect (const endpoint_type &peer_endpoint, asio::error_code &ec)
 Connect the socket to the specified endpoint.
template<typename ConnectHandler>
void async_connect (const endpoint_type &peer_endpoint, ConnectHandler handler)
 Start an asynchronous connect.
template<typename SettableSocketOption>
void set_option (const SettableSocketOption &option)
 Set an option on the socket.
template<typename SettableSocketOption>
asio::error_code set_option (const SettableSocketOption &option, asio::error_code &ec)
 Set an option on the socket.
template<typename GettableSocketOption>
void get_option (GettableSocketOption &option) const
 Get an option from the socket.
template<typename GettableSocketOption>
asio::error_code get_option (GettableSocketOption &option, asio::error_code &ec) const
 Get an option from the socket.
template<typename IoControlCommand>
void io_control (IoControlCommand &command)
 Perform an IO control command on the socket.
template<typename IoControlCommand>
asio::error_code io_control (IoControlCommand &command, asio::error_code &ec)
 Perform an IO control command on the socket.
endpoint_type local_endpoint () const
 Get the local endpoint of the socket.
endpoint_type local_endpoint (asio::error_code &ec) const
 Get the local endpoint of the socket.
endpoint_type remote_endpoint () const
 Get the remote endpoint of the socket.
endpoint_type remote_endpoint (asio::error_code &ec) const
 Get the remote endpoint of the socket.
void shutdown (shutdown_type what)
 Disable sends or receives on the socket.
asio::error_code shutdown (shutdown_type what, asio::error_code &ec)
 Disable sends or receives on the socket.
asio::io_serviceio_service ()
 Get the io_service associated with the object.

Static Public Attributes

static const int message_peek = implementation_defined
 Peek at incoming data without removing it from the input queue.
static const int message_out_of_band = implementation_defined
 Process out-of-band data.
static const int message_do_not_route = implementation_defined
 Specify that the data should not be subject to routing.
static const int max_connections = implementation_defined
 The maximum length of the queue of pending incoming connections.

Protected Member Functions

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


Member Typedef Documentation

template<typename Protocol, typename SocketService>
typedef SocketService::native_type asio::basic_socket< Protocol, SocketService >::native_type

The native representation of a socket.

Reimplemented in asio::basic_datagram_socket< Protocol, DatagramSocketService >, and asio::basic_stream_socket< Protocol, StreamSocketService >.

template<typename Protocol, typename SocketService>
typedef Protocol asio::basic_socket< Protocol, SocketService >::protocol_type

The protocol type.

Reimplemented in asio::basic_datagram_socket< Protocol, DatagramSocketService >, and asio::basic_stream_socket< Protocol, StreamSocketService >.

template<typename Protocol, typename SocketService>
typedef Protocol::endpoint asio::basic_socket< Protocol, SocketService >::endpoint_type

The endpoint type.

Reimplemented in asio::basic_datagram_socket< Protocol, DatagramSocketService >, asio::basic_socket_streambuf< Protocol, StreamSocketService >, and asio::basic_stream_socket< Protocol, StreamSocketService >.

template<typename Protocol, typename SocketService>
typedef basic_socket<Protocol, SocketService> asio::basic_socket< Protocol, SocketService >::lowest_layer_type

A basic_socket is always the lowest layer.

typedef SocketService asio::basic_io_object< SocketService >::service_type [inherited]

The type of the service that will be used to provide I/O operations.

typedef service_type::implementation_type asio::basic_io_object< SocketService >::implementation_type [inherited]

The underlying implementation type of I/O object.

typedef int asio::socket_base::message_flags [inherited]

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

typedef implementation_defined asio::socket_base::broadcast [inherited]

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

typedef implementation_defined asio::socket_base::debug [inherited]

Socket option to enable socket-level debugging.

Implements the SOL_SOCKET/SO_DEBUG socket option.

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

typedef implementation_defined asio::socket_base::do_not_route [inherited]

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

typedef implementation_defined asio::socket_base::keep_alive [inherited]

Socket option to send keep-alives.

Implements the SOL_SOCKET/SO_KEEPALIVE socket option.

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

typedef implementation_defined asio::socket_base::send_buffer_size [inherited]

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(io_service); 
 ...
 asio::socket_base::send_buffer_size option(8192);
 socket.set_option(option);
Getting the current option value:
 asio::ip::tcp::socket socket(io_service); 
 ...
 asio::socket_base::send_buffer_size option;
 socket.get_option(option);
 int size = option.value();
Concepts:
Socket_Option, Integer_Socket_Option.

typedef implementation_defined asio::socket_base::send_low_watermark [inherited]

Socket option for the send low watermark.

Implements the SOL_SOCKET/SO_SNDLOWAT socket option.

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

typedef implementation_defined asio::socket_base::receive_buffer_size [inherited]

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(io_service); 
 ...
 asio::socket_base::receive_buffer_size option(8192);
 socket.set_option(option);
Getting the current option value:
 asio::ip::tcp::socket socket(io_service); 
 ...
 asio::socket_base::receive_buffer_size option;
 socket.get_option(option);
 int size = option.value();
Concepts:
Socket_Option, Integer_Socket_Option.

typedef implementation_defined asio::socket_base::receive_low_watermark [inherited]

Socket option for the receive low watermark.

Implements the SOL_SOCKET/SO_RCVLOWAT socket option.

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

typedef implementation_defined asio::socket_base::reuse_address [inherited]

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.

typedef implementation_defined asio::socket_base::linger [inherited]

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

typedef implementation_defined asio::socket_base::enable_connection_aborted [inherited]

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.

typedef implementation_defined asio::socket_base::non_blocking_io [inherited]

IO control command to set the blocking mode of the socket.

Implements the FIONBIO IO control command.

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

typedef implementation_defined asio::socket_base::bytes_readable [inherited]

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(io_service); 
 ...
 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.


Member Enumeration Documentation

enum asio::socket_base::shutdown_type [inherited]

Different ways a socket may be shutdown.

Enumerator:
shutdown_receive  Shutdown the receive side of the socket.
shutdown_send  Shutdown the send side of the socket.
shutdown_both  Shutdown both send and receive on the socket.


Constructor & Destructor Documentation

template<typename Protocol, typename SocketService>
asio::basic_socket< Protocol, SocketService >::basic_socket ( asio::io_service io_service  )  [explicit]

Construct a basic_socket without opening it.

This constructor creates a socket without opening it.

Parameters:
io_service The io_service object that the socket will use to dispatch handlers for any asynchronous operations performed on the socket.

template<typename Protocol, typename SocketService>
asio::basic_socket< Protocol, SocketService >::basic_socket ( asio::io_service io_service,
const protocol_type protocol 
)

Construct and open a basic_socket.

This constructor creates and opens a socket.

Parameters:
io_service The io_service object that the socket will use 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.

template<typename Protocol, typename SocketService>
asio::basic_socket< Protocol, SocketService >::basic_socket ( asio::io_service io_service,
const endpoint_type endpoint 
)

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:
io_service The io_service object that the socket will use 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.

template<typename Protocol, typename SocketService>
asio::basic_socket< Protocol, SocketService >::basic_socket ( asio::io_service io_service,
const protocol_type protocol,
const native_type native_socket 
)

Construct a basic_socket on an existing native socket.

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

Parameters:
io_service The io_service object that the socket will use 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.

template<typename Protocol, typename SocketService>
asio::basic_socket< Protocol, SocketService >::~basic_socket (  )  [protected]

Protected destructor to prevent deletion through this type.


Member Function Documentation

template<typename Protocol, typename SocketService>
lowest_layer_type& asio::basic_socket< Protocol, SocketService >::lowest_layer (  ) 

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.

template<typename Protocol, typename SocketService>
void asio::basic_socket< Protocol, SocketService >::open ( const protocol_type protocol = protocol_type()  ) 

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(io_service);
 socket.open(asio::ip::tcp::v4());

template<typename Protocol, typename SocketService>
asio::error_code asio::basic_socket< Protocol, SocketService >::open ( const protocol_type protocol,
asio::error_code ec 
)

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(io_service);
 asio::error_code ec;
 socket.open(asio::ip::tcp::v4(), ec);
 if (ec)
 {
   // An error occurred.
 }

template<typename Protocol, typename SocketService>
void asio::basic_socket< Protocol, SocketService >::assign ( const protocol_type protocol,
const native_type native_socket 
)

Assign an existing native socket to the socket.

template<typename Protocol, typename SocketService>
asio::error_code asio::basic_socket< Protocol, SocketService >::assign ( const protocol_type protocol,
const native_type native_socket,
asio::error_code ec 
)

Assign an existing native socket to the socket.

template<typename Protocol, typename SocketService>
bool asio::basic_socket< Protocol, SocketService >::is_open (  )  const

Determine whether the socket is open.

template<typename Protocol, typename SocketService>
void asio::basic_socket< Protocol, SocketService >::close (  ) 

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.

Reimplemented in asio::basic_socket_streambuf< Protocol, StreamSocketService >.

template<typename Protocol, typename SocketService>
asio::error_code asio::basic_socket< Protocol, SocketService >::close ( asio::error_code ec  ) 

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.
Example
 asio::ip::tcp::socket socket(io_service);
 ...
 asio::error_code ec;
 socket.close(ec);
 if (ec)
 {
   // An error occurred.
 }

template<typename Protocol, typename SocketService>
native_type asio::basic_socket< Protocol, SocketService >::native (  ) 

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.

template<typename Protocol, typename SocketService>
void asio::basic_socket< Protocol, SocketService >::cancel (  ) 

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.

template<typename Protocol, typename SocketService>
asio::error_code asio::basic_socket< Protocol, SocketService >::cancel ( asio::error_code ec  ) 

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.

template<typename Protocol, typename SocketService>
bool asio::basic_socket< Protocol, SocketService >::at_mark (  )  const

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.

template<typename Protocol, typename SocketService>
bool asio::basic_socket< Protocol, SocketService >::at_mark ( asio::error_code ec  )  const

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.

template<typename Protocol, typename SocketService>
std::size_t asio::basic_socket< Protocol, SocketService >::available (  )  const

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.

template<typename Protocol, typename SocketService>
std::size_t asio::basic_socket< Protocol, SocketService >::available ( asio::error_code ec  )  const

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.

template<typename Protocol, typename SocketService>
void asio::basic_socket< Protocol, SocketService >::bind ( const endpoint_type endpoint  ) 

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(io_service);
 socket.open(asio::ip::tcp::v4());
 socket.bind(asio::ip::tcp::endpoint(
       asio::ip::tcp::v4(), 12345));

template<typename Protocol, typename SocketService>
asio::error_code asio::basic_socket< Protocol, SocketService >::bind ( const endpoint_type endpoint,
asio::error_code ec 
)

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(io_service);
 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.
 }

template<typename Protocol, typename SocketService>
void asio::basic_socket< Protocol, SocketService >::connect ( const endpoint_type peer_endpoint  ) 

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 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(io_service);
 asio::ip::tcp::endpoint endpoint(
     asio::ip::address::from_string("1.2.3.4"), 12345);
 socket.connect(endpoint);

Reimplemented in asio::basic_socket_streambuf< Protocol, StreamSocketService >.

template<typename Protocol, typename SocketService>
asio::error_code asio::basic_socket< Protocol, SocketService >::connect ( const endpoint_type peer_endpoint,
asio::error_code ec 
)

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 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(io_service);
 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.
 }

template<typename Protocol, typename SocketService>
template<typename ConnectHandler>
void asio::basic_socket< Protocol, SocketService >::async_connect ( const endpoint_type peer_endpoint,
ConnectHandler  handler 
)

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 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. Invocation of the handler will be performed in a manner equivalent to using asio::io_service::post().
Example
 void connect_handler(const asio::error_code& error)
 {
   if (!error)
   {
     // Connect succeeded.
   }
 }

 ...

 asio::ip::tcp::socket socket(io_service);
 asio::ip::tcp::endpoint endpoint(
     asio::ip::address::from_string("1.2.3.4"), 12345);
 socket.async_connect(endpoint, connect_handler);

template<typename Protocol, typename SocketService>
template<typename SettableSocketOption>
void asio::basic_socket< Protocol, SocketService >::set_option ( const SettableSocketOption &  option  ) 

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(io_service);
 ...
 asio::ip::tcp::no_delay option(true);
 socket.set_option(option);

template<typename Protocol, typename SocketService>
template<typename SettableSocketOption>
asio::error_code asio::basic_socket< Protocol, SocketService >::set_option ( const SettableSocketOption &  option,
asio::error_code ec 
)

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(io_service);
 ...
 asio::ip::tcp::no_delay option(true);
 asio::error_code ec;
 socket.set_option(option, ec);
 if (ec)
 {
   // An error occurred.
 }

template<typename Protocol, typename SocketService>
template<typename GettableSocketOption>
void asio::basic_socket< Protocol, SocketService >::get_option ( GettableSocketOption &  option  )  const

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(io_service);
 ...
 asio::ip::tcp::socket::keep_alive option;
 socket.get_option(option);
 bool is_set = option.get();

template<typename Protocol, typename SocketService>
template<typename GettableSocketOption>
asio::error_code asio::basic_socket< Protocol, SocketService >::get_option ( GettableSocketOption &  option,
asio::error_code ec 
) const

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(io_service);
 ...
 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.get();

template<typename Protocol, typename SocketService>
template<typename IoControlCommand>
void asio::basic_socket< Protocol, SocketService >::io_control ( IoControlCommand &  command  ) 

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(io_service);
 ...
 asio::ip::tcp::socket::bytes_readable command;
 socket.io_control(command);
 std::size_t bytes_readable = command.get();

template<typename Protocol, typename SocketService>
template<typename IoControlCommand>
asio::error_code asio::basic_socket< Protocol, SocketService >::io_control ( IoControlCommand &  command,
asio::error_code ec 
)

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(io_service);
 ...
 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();

template<typename Protocol, typename SocketService>
endpoint_type asio::basic_socket< Protocol, SocketService >::local_endpoint (  )  const

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(io_service);
 ...
 asio::ip::tcp::endpoint endpoint = socket.local_endpoint();

template<typename Protocol, typename SocketService>
endpoint_type asio::basic_socket< Protocol, SocketService >::local_endpoint ( asio::error_code ec  )  const

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(io_service);
 ...
 asio::error_code ec;
 asio::ip::tcp::endpoint endpoint = socket.local_endpoint(ec);
 if (ec)
 {
   // An error occurred.
 }

template<typename Protocol, typename SocketService>
endpoint_type asio::basic_socket< Protocol, SocketService >::remote_endpoint (  )  const

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(io_service);
 ...
 asio::ip::tcp::endpoint endpoint = socket.remote_endpoint();

template<typename Protocol, typename SocketService>
endpoint_type asio::basic_socket< Protocol, SocketService >::remote_endpoint ( asio::error_code ec  )  const

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(io_service);
 ...
 asio::error_code ec;
 asio::ip::tcp::endpoint endpoint = socket.remote_endpoint(ec);
 if (ec)
 {
   // An error occurred.
 }

template<typename Protocol, typename SocketService>
void asio::basic_socket< Protocol, SocketService >::shutdown ( shutdown_type  what  ) 

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(io_service);
 ...
 socket.shutdown(asio::ip::tcp::socket::shutdown_send);

template<typename Protocol, typename SocketService>
asio::error_code asio::basic_socket< Protocol, SocketService >::shutdown ( shutdown_type  what,
asio::error_code ec 
)

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(io_service);
 ...
 asio::error_code ec;
 socket.shutdown(asio::ip::tcp::socket::shutdown_send, ec);
 if (ec)
 {
   // An error occurred.
 }

asio::io_service& asio::basic_io_object< SocketService >::io_service (  )  [inherited]

Get the io_service associated with the object.

This function may be used to obtain the io_service object that the I/O object uses to dispatch handlers for asynchronous operations.

Returns:
A reference to the io_service object that the I/O object will use to dispatch handlers. Ownership is not transferred to the caller.


Member Data Documentation

const int asio::socket_base::message_peek = implementation_defined [static, inherited]

Peek at incoming data without removing it from the input queue.

const int asio::socket_base::message_out_of_band = implementation_defined [static, inherited]

Process out-of-band data.

const int asio::socket_base::message_do_not_route = implementation_defined [static, inherited]

Specify that the data should not be subject to routing.

const int asio::socket_base::max_connections = implementation_defined [static, inherited]

The maximum length of the queue of pending incoming connections.

asio 0.3.8rc3 Home | Reference | Tutorial | Examples | Design