Provides stream-oriented socket functionality. More...

#include <basic_stream_socket.hpp>

Inheritance diagram for asio::basic_stream_socket< Protocol, StreamSocketService >:

Public Types
typedef StreamSocketService::native_handle_type	native_type

typedef StreamSocketService::native_handle_type	native_handle_type
	The native representation of a socket. More...

typedef Protocol	protocol_type
	The protocol type. More...

typedef Protocol::endpoint	endpoint_type
	The endpoint type. More...

Public Types inherited from asio::basic_socket< Protocol, StreamSocketService >
typedef StreamSocketService::native_handle_type	native_type

typedef StreamSocketService::native_handle_type	native_handle_type
	The native representation of a socket. More...

typedef Protocol	protocol_type
	The protocol type. More...

typedef Protocol::endpoint	endpoint_type
	The endpoint type. More...

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

Public Types inherited from asio::basic_io_object< StreamSocketService >
typedef StreamSocketService	service_type
	The type of the service that will be used to provide I/O operations. More...

typedef service_type::implementation_type	implementation_type
	The underlying implementation type of I/O object. More...

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. 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_option >	enable_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
	basic_stream_socket (asio::io_service &io_service)
	Construct a basic_stream_socket without opening it. More...

	basic_stream_socket (asio::io_service &io_service, const protocol_type &protocol)
	Construct and open a basic_stream_socket. More...

	basic_stream_socket (asio::io_service &io_service, const endpoint_type &endpoint)

	basic_stream_socket (asio::io_service &io_service, const protocol_type &protocol, const native_handle_type &native_socket)
	Construct a basic_stream_socket on an existing native socket. More...

template<typename ConstBufferSequence >
std::size_t	send (const ConstBufferSequence &buffers)
	Send some data on the socket. More...

template<typename ConstBufferSequence >
std::size_t	send (const ConstBufferSequence &buffers, socket_base::message_flags flags)
	Send some data on the socket. More...

template<typename ConstBufferSequence >
std::size_t	send (const ConstBufferSequence &buffers, socket_base::message_flags flags, asio::error_code &ec)
	Send some data on the socket. More...

template<typename ConstBufferSequence , typename WriteHandler >
	ASIO_INITFN_RESULT_TYPE (WriteHandler, void(asio::error_code, std::size_t)) async_send(const ConstBufferSequence &buffers
	Start an asynchronous send. More...

	ASIO_MOVE_ARG (WriteHandler) handler)

template<typename ConstBufferSequence , typename WriteHandler >
	ASIO_INITFN_RESULT_TYPE (WriteHandler, void(asio::error_code, std::size_t)) async_send(const ConstBufferSequence &buffers
	Start an asynchronous send. More...

socket_base::message_flags	ASIO_MOVE_ARG (WriteHandler) handler)

template<typename MutableBufferSequence >
std::size_t	receive (const MutableBufferSequence &buffers)
	Receive some data on the socket. More...

template<typename MutableBufferSequence >
std::size_t	receive (const MutableBufferSequence &buffers, socket_base::message_flags flags)
	Receive some data on the socket. More...

template<typename MutableBufferSequence >
std::size_t	receive (const MutableBufferSequence &buffers, socket_base::message_flags flags, asio::error_code &ec)
	Receive some data on a connected socket. More...

template<typename MutableBufferSequence , typename ReadHandler >
	ASIO_INITFN_RESULT_TYPE (ReadHandler, void(asio::error_code, std::size_t)) async_receive(const MutableBufferSequence &buffers
	Start an asynchronous receive. More...

	ASIO_MOVE_ARG (ReadHandler) handler)

template<typename MutableBufferSequence , typename ReadHandler >
	ASIO_INITFN_RESULT_TYPE (ReadHandler, void(asio::error_code, std::size_t)) async_receive(const MutableBufferSequence &buffers
	Start an asynchronous receive. More...

socket_base::message_flags	ASIO_MOVE_ARG (ReadHandler) handler)

template<typename ConstBufferSequence >
std::size_t	write_some (const ConstBufferSequence &buffers)
	Write some data to the socket. More...

template<typename ConstBufferSequence >
std::size_t	write_some (const ConstBufferSequence &buffers, asio::error_code &ec)
	Write some data to the socket. More...

template<typename ConstBufferSequence , typename WriteHandler >
	ASIO_INITFN_RESULT_TYPE (WriteHandler, void(asio::error_code, std::size_t)) async_write_some(const ConstBufferSequence &buffers
	Start an asynchronous write. More...

	ASIO_MOVE_ARG (WriteHandler) handler)

template<typename MutableBufferSequence >
std::size_t	read_some (const MutableBufferSequence &buffers)
	Read some data from the socket. More...

template<typename MutableBufferSequence >
std::size_t	read_some (const MutableBufferSequence &buffers, asio::error_code &ec)
	Read some data from the socket. More...

template<typename MutableBufferSequence , typename ReadHandler >
	ASIO_INITFN_RESULT_TYPE (ReadHandler, void(asio::error_code, std::size_t)) async_read_some(const MutableBufferSequence &buffers
	Start an asynchronous read. More...

	ASIO_MOVE_ARG (ReadHandler) handler)

Public Member Functions inherited from asio::basic_socket< Protocol, StreamSocketService >
	basic_socket (asio::io_service &io_service)
	Construct a basic_socket without opening it. More...

	basic_socket (asio::io_service &io_service, const protocol_type &protocol)
	Construct and open a basic_socket. More...

	basic_socket (asio::io_service &io_service, const endpoint_type &endpoint)

	basic_socket (asio::io_service &io_service, const protocol_type &protocol, const native_handle_type &native_socket)
	Construct a basic_socket on an existing native socket. More...

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::error_code	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. More...

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

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

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

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

native_type	native ()
	(Deprecated: Use native_handle().) Get the native socket representation. More...

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

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

asio::error_code	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::error_code	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::error_code	connect (const endpoint_type &peer_endpoint, asio::error_code &ec)
	Connect the socket to the specified endpoint. More...

	ASIO_INITFN_RESULT_TYPE (ConnectHandler, void(asio::error_code)) async_connect(const endpoint_type &peer_endpoint
	Start an asynchronous connect. More...

	ASIO_MOVE_ARG (ConnectHandler) handler)

void	set_option (const SettableSocketOption &option)
	Set an option on the socket. More...

asio::error_code	set_option (const SettableSocketOption &option, asio::error_code &ec)
	Set an option on the socket. More...

void	get_option (GettableSocketOption &option) const
	Get an option from the socket. More...

asio::error_code	get_option (GettableSocketOption &option, asio::error_code &ec) const
	Get an option from the socket. More...

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

asio::error_code	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::error_code	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::error_code	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::error_code	shutdown (shutdown_type what, asio::error_code &ec)
	Disable sends or receives on the socket. More...

Public Member Functions inherited from asio::basic_io_object< StreamSocketService >
asio::io_service &	get_io_service ()
	Get the io_service associated with the object. More...

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

Public Attributes
socket_base::message_flags	flags

Additional Inherited Members
Protected Member Functions inherited from asio::basic_socket< Protocol, StreamSocketService >
	~basic_socket ()
	Protected destructor to prevent deletion through this type. More...

Protected Member Functions inherited from asio::basic_io_object< StreamSocketService >
	basic_io_object (asio::io_service &io_service)
	Construct a basic_io_object. More...

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

service_type &	get_service ()
	Get the service associated with the I/O object. More...

const service_type &	get_service () const
	Get the service associated with the I/O object. More...

implementation_type &	get_implementation ()
	Get the underlying implementation of the I/O object. More...

const implementation_type &	get_implementation () const
	Get the underlying implementation of the I/O object. More...

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

Protected Attributes inherited from asio::basic_io_object< StreamSocketService >
service_type &	service

implementation_type	implementation

Detailed Description

template<typename Protocol, typename StreamSocketService = stream_socket_service<Protocol>>
class asio::basic_stream_socket< Protocol, StreamSocketService >

Provides stream-oriented socket functionality.

The basic_stream_socket class template provides asynchronous and blocking stream-oriented socket functionality.

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

Concepts:: AsyncReadStream, AsyncWriteStream, Stream, SyncReadStream, SyncWriteStream.

Definition at line 45 of file basic_stream_socket.hpp.

Member Typedef Documentation

template<typename Protocol , typename StreamSocketService = stream_socket_service<Protocol>>

typedef Protocol::endpoint asio::basic_stream_socket< Protocol, StreamSocketService >::endpoint_type

The endpoint type.

Definition at line 60 of file basic_stream_socket.hpp.

template<typename Protocol , typename StreamSocketService = stream_socket_service<Protocol>>

typedef StreamSocketService::native_handle_type asio::basic_stream_socket< Protocol, StreamSocketService >::native_handle_type

The native representation of a socket.

Definition at line 54 of file basic_stream_socket.hpp.

template<typename Protocol , typename StreamSocketService = stream_socket_service<Protocol>>

typedef StreamSocketService::native_handle_type asio::basic_stream_socket< Protocol, StreamSocketService >::native_type

(Deprecated: Use native_handle_type.) The native representation of a socket.

Definition at line 51 of file basic_stream_socket.hpp.

template<typename Protocol , typename StreamSocketService = stream_socket_service<Protocol>>

typedef Protocol asio::basic_stream_socket< Protocol, StreamSocketService >::protocol_type

The protocol type.

Definition at line 57 of file basic_stream_socket.hpp.

Constructor & Destructor Documentation

template<typename Protocol , typename StreamSocketService = stream_socket_service<Protocol>>

asio::basic_stream_socket< Protocol, StreamSocketService >::basic_stream_socket ( asio::io_service & io_service )

inlineexplicit

Construct a basic_stream_socket without opening it.

This constructor creates a stream socket without opening it. The socket needs to be opened and then connected or accepted before data can be sent or received on it.

Parameters

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

Definition at line 71 of file basic_stream_socket.hpp.

template<typename Protocol , typename StreamSocketService = stream_socket_service<Protocol>>

asio::basic_stream_socket< Protocol, StreamSocketService >::basic_stream_socket	(	asio::io_service &	io_service,
		const protocol_type &	protocol
	)

inline

Construct and open a basic_stream_socket.

This constructor creates and opens a stream socket. The socket needs to be connected or accepted before data can be sent or received on it.

Parameters

io_service	The io_service object that the stream 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.

Definition at line 88 of file basic_stream_socket.hpp.

template<typename Protocol , typename StreamSocketService = stream_socket_service<Protocol>>

asio::basic_stream_socket< Protocol, StreamSocketService >::basic_stream_socket	(	asio::io_service &	io_service,
		const endpoint_type &	endpoint
	)

inline

Construct a basic_stream_socket, opening it and binding it to the given local endpoint. This constructor creates a stream 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 stream socket will use to dispatch handlers for any asynchronous operations performed on the socket.
endpoint	An endpoint on the local machine to which the stream socket will be bound.

Exceptions

asio::system_error Thrown on failure.

Definition at line 109 of file basic_stream_socket.hpp.

template<typename Protocol , typename StreamSocketService = stream_socket_service<Protocol>>

asio::basic_stream_socket< Protocol, StreamSocketService >::basic_stream_socket	(	asio::io_service &	io_service,
		const protocol_type &	protocol,
		const native_handle_type &	native_socket
	)

inline

Construct a basic_stream_socket on an existing native socket.

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

Parameters

io_service	The io_service object that the stream 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	The new underlying socket implementation.

Exceptions

asio::system_error Thrown on failure.

Definition at line 129 of file basic_stream_socket.hpp.

Member Function Documentation

template<typename Protocol , typename StreamSocketService = stream_socket_service<Protocol>>

template<typename ConstBufferSequence , typename WriteHandler >

asio::basic_stream_socket< Protocol, StreamSocketService >::ASIO_INITFN_RESULT_TYPE	(	WriteHandler	,
		void(asio::error_code, std::size_t)
	)		const

Start an asynchronous send.

This function is used to asynchronously send data on the stream socket. The function call always returns immediately.

Parameters

buffers One or more data buffers to be sent on the socket. Although the buffers object may be copied as necessary, ownership of the underlying memory blocks is retained by the caller, which must guarantee that they remain valid until the handler is called.

handler

The handler to be called when the send 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.
  std::size_t bytes_transferred           // Number of bytes sent.
); 

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

Note: The send operation may not transmit all of the data to the peer. Consider using the asio::async_write function if you need to ensure that all data is written before the asynchronous operation completes.

Example: To send a single data buffer use the asio::buffer function as follows:
socket.async_send(asio::buffer(data, size), handler);
See the asio::buffer documentation for information on sending multiple buffers in one go, and how to use it with arrays, boost::array or std::vector.

template<typename Protocol , typename StreamSocketService = stream_socket_service<Protocol>>

template<typename ConstBufferSequence , typename WriteHandler >

asio::basic_stream_socket< Protocol, StreamSocketService >::ASIO_INITFN_RESULT_TYPE	(	WriteHandler	,
		void(asio::error_code, std::size_t)
	)		const

Start an asynchronous send.

This function is used to asynchronously send data on the stream socket. The function call always returns immediately.

Parameters

buffers	One or more data buffers to be sent on the socket. Although the buffers object may be copied as necessary, ownership of the underlying memory blocks is retained by the caller, which must guarantee that they remain valid until the handler is called.
flags	Flags specifying how the send call is to be made.
handler	The handler to be called when the send 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. std::size_t bytes_transferred // Number of bytes sent. ); 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().

Note: The send operation may not transmit all of the data to the peer. Consider using the asio::async_write function if you need to ensure that all data is written before the asynchronous operation completes.

Example: To send a single data buffer use the asio::buffer function as follows:
socket.async_send(asio::buffer(data, size), 0, handler);
See the asio::buffer documentation for information on sending multiple buffers in one go, and how to use it with arrays, boost::array or std::vector.

template<typename Protocol , typename StreamSocketService = stream_socket_service<Protocol>>

template<typename MutableBufferSequence , typename ReadHandler >

asio::basic_stream_socket< Protocol, StreamSocketService >::ASIO_INITFN_RESULT_TYPE	(	ReadHandler	,
		void(asio::error_code, std::size_t)
	)		const

Start an asynchronous receive.

This function is used to asynchronously receive data from the stream socket. The function call always returns immediately.

Parameters

buffers One or more buffers into which the data will be received. Although the buffers object may be copied as necessary, ownership of the underlying memory blocks is retained by the caller, which must guarantee that they remain valid until the handler is called.

handler

The handler to be called when the receive 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.
  std::size_t bytes_transferred           // Number of bytes received.
); 

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

Note: The receive operation may not receive all of the requested number of bytes. Consider using the asio::async_read function if you need to ensure that the requested amount of data is received before the asynchronous operation completes.

Example: To receive into a single data buffer use the asio::buffer function as follows:
socket.async_receive(asio::buffer(data, size), handler);
See the asio::buffer documentation for information on receiving into multiple buffers in one go, and how to use it with arrays, boost::array or std::vector.

template<typename Protocol , typename StreamSocketService = stream_socket_service<Protocol>>

template<typename MutableBufferSequence , typename ReadHandler >

asio::basic_stream_socket< Protocol, StreamSocketService >::ASIO_INITFN_RESULT_TYPE	(	ReadHandler	,
		void(asio::error_code, std::size_t)
	)		const

Start an asynchronous receive.

This function is used to asynchronously receive data from the stream socket. The function call always returns immediately.

Parameters

buffers	One or more buffers into which the data will be received. Although the buffers object may be copied as necessary, ownership of the underlying memory blocks is retained by the caller, which must guarantee that they remain valid until the handler is called.
flags	Flags specifying how the receive call is to be made.
handler	The handler to be called when the receive 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. std::size_t bytes_transferred // Number of bytes received. ); 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().

Note: The receive operation may not receive all of the requested number of bytes. Consider using the asio::async_read function if you need to ensure that the requested amount of data is received before the asynchronous operation completes.

Example: To receive into a single data buffer use the asio::buffer function as follows:
socket.async_receive(asio::buffer(data, size), 0, handler);
See the asio::buffer documentation for information on receiving into multiple buffers in one go, and how to use it with arrays, boost::array or std::vector.

template<typename Protocol , typename StreamSocketService = stream_socket_service<Protocol>>

template<typename ConstBufferSequence , typename WriteHandler >

asio::basic_stream_socket< Protocol, StreamSocketService >::ASIO_INITFN_RESULT_TYPE	(	WriteHandler	,
		void(asio::error_code, std::size_t)
	)		const

Start an asynchronous write.

This function is used to asynchronously write data to the stream socket. The function call always returns immediately.

Parameters

buffers One or more data buffers to be written to the socket. Although the buffers object may be copied as necessary, ownership of the underlying memory blocks is retained by the caller, which must guarantee that they remain valid until the handler is called.

handler

The handler to be called when the write 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.
  std::size_t bytes_transferred           // Number of bytes written.
); 

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

Note: The write operation may not transmit all of the data to the peer. Consider using the asio::async_write function if you need to ensure that all data is written before the asynchronous operation completes.

Example: To write a single data buffer use the asio::buffer function as follows:
socket.async_write_some(asio::buffer(data, size), handler);
See the asio::buffer documentation for information on writing multiple buffers in one go, and how to use it with arrays, boost::array or std::vector.

template<typename Protocol , typename StreamSocketService = stream_socket_service<Protocol>>

template<typename MutableBufferSequence , typename ReadHandler >

asio::basic_stream_socket< Protocol, StreamSocketService >::ASIO_INITFN_RESULT_TYPE	(	ReadHandler	,
		void(asio::error_code, std::size_t)
	)		const

Start an asynchronous read.

This function is used to asynchronously read data from the stream socket. The function call always returns immediately.

Parameters

buffers One or more buffers into which the data will be read. Although the buffers object may be copied as necessary, ownership of the underlying memory blocks is retained by the caller, which must guarantee that they remain valid until the handler is called.

handler

The handler to be called when the read 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.
  std::size_t bytes_transferred           // Number of bytes read.
); 

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

Note: The read operation may not read all of the requested number of bytes. Consider using the asio::async_read function if you need to ensure that the requested amount of data is read before the asynchronous operation completes.

Example: To read into a single data buffer use the asio::buffer function as follows:
socket.async_read_some(asio::buffer(data, size), handler);
See the asio::buffer documentation for information on reading into multiple buffers in one go, and how to use it with arrays, boost::array or std::vector.

template<typename Protocol , typename StreamSocketService = stream_socket_service<Protocol>>

asio::basic_stream_socket< Protocol, StreamSocketService >::ASIO_MOVE_ARG ( WriteHandler )

inline

Definition at line 351 of file basic_stream_socket.hpp.

template<typename Protocol , typename StreamSocketService = stream_socket_service<Protocol>>

socket_base::message_flags asio::basic_stream_socket< Protocol, StreamSocketService >::ASIO_MOVE_ARG ( WriteHandler )

inline

Definition at line 404 of file basic_stream_socket.hpp.

template<typename Protocol , typename StreamSocketService = stream_socket_service<Protocol>>

asio::basic_stream_socket< Protocol, StreamSocketService >::ASIO_MOVE_ARG ( ReadHandler )

inline

Definition at line 561 of file basic_stream_socket.hpp.

template<typename Protocol , typename StreamSocketService = stream_socket_service<Protocol>>

socket_base::message_flags asio::basic_stream_socket< Protocol, StreamSocketService >::ASIO_MOVE_ARG ( ReadHandler )

inline

Definition at line 615 of file basic_stream_socket.hpp.

template<typename Protocol , typename StreamSocketService = stream_socket_service<Protocol>>

asio::basic_stream_socket< Protocol, StreamSocketService >::ASIO_MOVE_ARG ( WriteHandler )

inline

Definition at line 724 of file basic_stream_socket.hpp.

template<typename Protocol , typename StreamSocketService = stream_socket_service<Protocol>>

asio::basic_stream_socket< Protocol, StreamSocketService >::ASIO_MOVE_ARG ( ReadHandler )

inline

Definition at line 837 of file basic_stream_socket.hpp.

template<typename Protocol , typename StreamSocketService = stream_socket_service<Protocol>>

template<typename MutableBufferSequence >

std::size_t asio::basic_stream_socket< Protocol, StreamSocketService >::read_some ( const MutableBufferSequence & buffers )

inline

Read some data from the socket.

This function is used to read data from the stream socket. The function call will block until one or more bytes of data has been read successfully, or until an error occurs.

Parameters

buffers One or more buffers into which the data will be read.

Returns: The number of bytes read.

Exceptions

asio::system_error Thrown on failure. An error code of asio::error::eof indicates that the connection was closed by the peer.

Note: The read_some operation may not read all of the requested number of bytes. Consider using the asio::read function if you need to ensure that the requested amount of data is read before the blocking operation completes.

Example: To read into a single data buffer use the asio::buffer function as follows:
socket.read_some(asio::buffer(data, size));
See the asio::buffer documentation for information on reading into multiple buffers in one go, and how to use it with arrays, boost::array or std::vector.

Definition at line 763 of file basic_stream_socket.hpp.

template<typename Protocol , typename StreamSocketService = stream_socket_service<Protocol>>

template<typename MutableBufferSequence >

std::size_t asio::basic_stream_socket< Protocol, StreamSocketService >::read_some	(	const MutableBufferSequence &	buffers,
		asio::error_code &	ec
	)

inline

Read some data from the socket.

This function is used to read data from the stream socket. The function call will block until one or more bytes of data has been read successfully, or until an error occurs.

Parameters

buffers	One or more buffers into which the data will be read.
ec	Set to indicate what error occurred, if any.

Returns: The number of bytes read. Returns 0 if an error occurred.

Note: The read_some operation may not read all of the requested number of bytes. Consider using the asio::read function if you need to ensure that the requested amount of data is read before the blocking operation completes.

Definition at line 790 of file basic_stream_socket.hpp.

template<typename Protocol , typename StreamSocketService = stream_socket_service<Protocol>>

template<typename MutableBufferSequence >

std::size_t asio::basic_stream_socket< Protocol, StreamSocketService >::receive ( const MutableBufferSequence & buffers )

inline

Receive some data on the socket.

This function is used to receive data on the stream socket. The function call will block until one or more bytes of data has been received successfully, or until an error occurs.

Parameters

buffers One or more buffers into which the data will be received.

Returns: The number of bytes received.

Exceptions

asio::system_error Thrown on failure. An error code of asio::error::eof indicates that the connection was closed by the peer.

Note: The receive operation may not receive all of the requested number of bytes. Consider using the asio::read function if you need to ensure that the requested amount of data is read before the blocking operation completes.

Example: To receive into a single data buffer use the asio::buffer function as follows:
socket.receive(asio::buffer(data, size));
See the asio::buffer documentation for information on receiving into multiple buffers in one go, and how to use it with arrays, boost::array or std::vector.

Definition at line 444 of file basic_stream_socket.hpp.

template<typename Protocol , typename StreamSocketService = stream_socket_service<Protocol>>

template<typename MutableBufferSequence >

std::size_t asio::basic_stream_socket< Protocol, StreamSocketService >::receive	(	const MutableBufferSequence &	buffers,
		socket_base::message_flags	flags
	)

inline

Receive some data on the socket.

This function is used to receive data on the stream socket. The function call will block until one or more bytes of data has been received successfully, or until an error occurs.

Parameters

buffers	One or more buffers into which the data will be received.
flags	Flags specifying how the receive call is to be made.

Returns: The number of bytes received.

Exceptions

asio::system_error Thrown on failure. An error code of asio::error::eof indicates that the connection was closed by the peer.

Note: The receive operation may not receive all of the requested number of bytes. Consider using the asio::read function if you need to ensure that the requested amount of data is read before the blocking operation completes.

Example: To receive into a single data buffer use the asio::buffer function as follows:
socket.receive(asio::buffer(data, size), 0);
See the asio::buffer documentation for information on receiving into multiple buffers in one go, and how to use it with arrays, boost::array or std::vector.

Definition at line 484 of file basic_stream_socket.hpp.

template<typename Protocol , typename StreamSocketService = stream_socket_service<Protocol>>

template<typename MutableBufferSequence >

std::size_t asio::basic_stream_socket< Protocol, StreamSocketService >::receive	(	const MutableBufferSequence &	buffers,
		socket_base::message_flags	flags,
		asio::error_code &	ec
	)

inline

Receive some data on a connected socket.

This function is used to receive data on the stream socket. The function call will block until one or more bytes of data has been received successfully, or until an error occurs.

Parameters

buffers	One or more buffers into which the data will be received.
flags	Flags specifying how the receive call is to be made.
ec	Set to indicate what error occurred, if any.

Returns: The number of bytes received. Returns 0 if an error occurred.

Note: The receive operation may not receive all of the requested number of bytes. Consider using the asio::read function if you need to ensure that the requested amount of data is read before the blocking operation completes.

Definition at line 513 of file basic_stream_socket.hpp.

template<typename Protocol , typename StreamSocketService = stream_socket_service<Protocol>>

template<typename ConstBufferSequence >

std::size_t asio::basic_stream_socket< Protocol, StreamSocketService >::send ( const ConstBufferSequence & buffers )

inline

Send some data on the socket.

This function is used to send data on the stream socket. The function call will block until one or more bytes of the data has been sent successfully, or an until error occurs.

Parameters

buffers One or more data buffers to be sent on the socket.

Returns: The number of bytes sent.

Exceptions

asio::system_error Thrown on failure.

Note: The send operation may not transmit all of the data to the peer. Consider using the asio::write function if you need to ensure that all data is written before the blocking operation completes.

Example: To send a single data buffer use the asio::buffer function as follows:
socket.send(asio::buffer(data, size));
See the asio::buffer documentation for information on sending multiple buffers in one go, and how to use it with arrays, boost::array or std::vector.

Definition at line 239 of file basic_stream_socket.hpp.

template<typename Protocol , typename StreamSocketService = stream_socket_service<Protocol>>

template<typename ConstBufferSequence >

std::size_t asio::basic_stream_socket< Protocol, StreamSocketService >::send	(	const ConstBufferSequence &	buffers,
		socket_base::message_flags	flags
	)

inline

Send some data on the socket.

This function is used to send data on the stream socket. The function call will block until one or more bytes of the data has been sent successfully, or an until error occurs.

Parameters

buffers	One or more data buffers to be sent on the socket.
flags	Flags specifying how the send call is to be made.

Returns: The number of bytes sent.

Exceptions

asio::system_error Thrown on failure.

Note: The send operation may not transmit all of the data to the peer. Consider using the asio::write function if you need to ensure that all data is written before the blocking operation completes.

Example: To send a single data buffer use the asio::buffer function as follows:
socket.send(asio::buffer(data, size), 0);
See the asio::buffer documentation for information on sending multiple buffers in one go, and how to use it with arrays, boost::array or std::vector.

Definition at line 276 of file basic_stream_socket.hpp.

template<typename Protocol , typename StreamSocketService = stream_socket_service<Protocol>>

template<typename ConstBufferSequence >

std::size_t asio::basic_stream_socket< Protocol, StreamSocketService >::send	(	const ConstBufferSequence &	buffers,
		socket_base::message_flags	flags,
		asio::error_code &	ec
	)

inline

Send some data on the socket.

This function is used to send data on the stream socket. The function call will block until one or more bytes of the data has been sent successfully, or an until error occurs.

Parameters

buffers	One or more data buffers to be sent on the socket.
flags	Flags specifying how the send call is to be made.
ec	Set to indicate what error occurred, if any.

Returns: The number of bytes sent. Returns 0 if an error occurred.

Note: The send operation may not transmit all of the data to the peer. Consider using the asio::write function if you need to ensure that all data is written before the blocking operation completes.

Definition at line 305 of file basic_stream_socket.hpp.

template<typename Protocol , typename StreamSocketService = stream_socket_service<Protocol>>

template<typename ConstBufferSequence >

std::size_t asio::basic_stream_socket< Protocol, StreamSocketService >::write_some ( const ConstBufferSequence & buffers )

inline

Write some data to the socket.

This function is used to write data to the stream socket. The function call will block until one or more bytes of the data has been written successfully, or until an error occurs.

Parameters

buffers One or more data buffers to be written to the socket.

Returns: The number of bytes written.

Exceptions

asio::system_error Thrown on failure. An error code of asio::error::eof indicates that the connection was closed by the peer.

Note: The write_some operation may not transmit all of the data to the peer. Consider using the asio::write function if you need to ensure that all data is written before the blocking operation completes.

Example: To write a single data buffer use the asio::buffer function as follows:
socket.write_some(asio::buffer(data, size));
See the asio::buffer documentation for information on writing multiple buffers in one go, and how to use it with arrays, boost::array or std::vector.

Definition at line 653 of file basic_stream_socket.hpp.

template<typename Protocol , typename StreamSocketService = stream_socket_service<Protocol>>

template<typename ConstBufferSequence >

std::size_t asio::basic_stream_socket< Protocol, StreamSocketService >::write_some	(	const ConstBufferSequence &	buffers,
		asio::error_code &	ec
	)

inline

Write some data to the socket.

This function is used to write data to the stream socket. The function call will block until one or more bytes of the data has been written successfully, or until an error occurs.

Parameters

buffers	One or more data buffers to be written to the socket.
ec	Set to indicate what error occurred, if any.

Returns: The number of bytes written. Returns 0 if an error occurred.

Note: The write_some operation may not transmit all of the data to the peer. Consider using the asio::write function if you need to ensure that all data is written before the blocking operation completes.

Definition at line 679 of file basic_stream_socket.hpp.

Member Data Documentation

template<typename Protocol , typename StreamSocketService = stream_socket_service<Protocol>>

socket_base::message_flags asio::basic_stream_socket< Protocol, StreamSocketService >::flags

Definition at line 403 of file basic_stream_socket.hpp.

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

/home/martin/ver/3DLab/code/asio-1.10.6/include/asio/basic_stream_socket.hpp

Public Types

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

template<typename Protocol, typename StreamSocketService = stream_socket_service<Protocol>> class asio::basic_stream_socket< Protocol, StreamSocketService >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<typename Protocol, typename StreamSocketService = stream_socket_service<Protocol>>
class asio::basic_stream_socket< Protocol, StreamSocketService >