Default service implementation for a sequenced packet socket. More...

#include <seq_packet_socket_service.hpp>

Inheritance diagram for asio::seq_packet_socket_service< Protocol >:

Public Types
typedef Protocol	protocol_type
	The protocol type. More...

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

typedef service_impl_type::implementation_type	implementation_type
	The type of a sequenced packet socket implementation. More...

typedef service_impl_type::native_handle_type	native_type
	(Deprecated: Use native_handle_type.) The native socket type. More...

typedef service_impl_type::native_handle_type	native_handle_type
	The native socket type. More...

Public Member Functions
	seq_packet_socket_service (asio::io_service &io_service)

void	construct (implementation_type &impl)
	Construct a new sequenced packet socket implementation. More...

void	destroy (implementation_type &impl)
	Destroy a sequenced packet socket implementation. More...

asio::error_code	open (implementation_type &impl, const protocol_type &protocol, asio::error_code &ec)
	Open a sequenced packet socket. More...

asio::error_code	assign (implementation_type &impl, const protocol_type &protocol, const native_handle_type &native_socket, asio::error_code &ec)
	Assign an existing native socket to a sequenced packet socket. More...

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

asio::error_code	close (implementation_type &impl, asio::error_code &ec)
	Close a sequenced packet socket implementation. More...

native_type	native (implementation_type &impl)
	(Deprecated: Use native_handle().) Get the native socket implementation. More...

native_handle_type	native_handle (implementation_type &impl)
	Get the native socket implementation. More...

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

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

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

asio::error_code	bind (implementation_type &impl, const endpoint_type &endpoint, asio::error_code &ec)
	Bind the sequenced packet socket to the specified local endpoint. More...

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

template<typename ConnectHandler >
	ASIO_INITFN_RESULT_TYPE (ConnectHandler, void(asio::error_code)) async_connect(implementation_type &impl
	Start an asynchronous connect. More...

const endpoint_type	ASIO_MOVE_ARG (ConnectHandler) handler)

template<typename SettableSocketOption >
asio::error_code	set_option (implementation_type &impl, const SettableSocketOption &option, asio::error_code &ec)
	Set a socket option. More...

template<typename GettableSocketOption >
asio::error_code	get_option (const implementation_type &impl, GettableSocketOption &option, asio::error_code &ec) const
	Get a socket option. More...

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

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

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

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

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

endpoint_type	local_endpoint (const implementation_type &impl, asio::error_code &ec) const
	Get the local endpoint. More...

endpoint_type	remote_endpoint (const implementation_type &impl, asio::error_code &ec) const
	Get the remote endpoint. More...

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

template<typename ConstBufferSequence >
std::size_t	send (implementation_type &impl, const ConstBufferSequence &buffers, socket_base::message_flags flags, asio::error_code &ec)
	Send the given data to the peer. More...

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

const ConstBufferSequence socket_base::message_flags	ASIO_MOVE_ARG (WriteHandler) handler)

template<typename MutableBufferSequence >
std::size_t	receive (implementation_type &impl, const MutableBufferSequence &buffers, socket_base::message_flags in_flags, socket_base::message_flags &out_flags, asio::error_code &ec)
	Receive some data from the peer. More...

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

const MutableBufferSequence socket_base::message_flags socket_base::message_flags	ASIO_MOVE_ARG (ReadHandler) handler)

Public Member Functions inherited from asio::detail::service_base< seq_packet_socket_service< Protocol > >
	service_base (asio::io_service &io_service)

Public Member Functions inherited from asio::io_service::service
asio::io_service &	get_io_service ()
	Get the io_service object that owns the service. More...

Public Attributes
const endpoint_type &	peer_endpoint

const ConstBufferSequence &	buffers

const ConstBufferSequence socket_base::message_flags	flags

const MutableBufferSequence &	buffers

const MutableBufferSequence socket_base::message_flags	in_flags

const MutableBufferSequence socket_base::message_flags socket_base::message_flags &	out_flags

Additional Inherited Members
Static Public Attributes inherited from asio::detail::service_base< seq_packet_socket_service< Protocol > >
static asio::detail::service_id< seq_packet_socket_service< Protocol > >	id

Protected Member Functions inherited from asio::io_service::service
ASIO_DECL	service (asio::io_service &owner)
	Constructor. More...

virtual ASIO_DECL	~service ()
	Destructor. More...

Detailed Description

template<typename Protocol>
class asio::seq_packet_socket_service< Protocol >

Default service implementation for a sequenced packet socket.

Definition at line 39 of file seq_packet_socket_service.hpp.

Member Typedef Documentation

template<typename Protocol >

typedef Protocol::endpoint asio::seq_packet_socket_service< Protocol >::endpoint_type

The endpoint type.

Definition at line 57 of file seq_packet_socket_service.hpp.

template<typename Protocol >

typedef service_impl_type::implementation_type asio::seq_packet_socket_service< Protocol >::implementation_type

The type of a sequenced packet socket implementation.

Definition at line 74 of file seq_packet_socket_service.hpp.

template<typename Protocol >

typedef service_impl_type::native_handle_type asio::seq_packet_socket_service< Protocol >::native_handle_type

The native socket type.

Definition at line 88 of file seq_packet_socket_service.hpp.

template<typename Protocol >

typedef service_impl_type::native_handle_type asio::seq_packet_socket_service< Protocol >::native_type

(Deprecated: Use native_handle_type.) The native socket type.

Definition at line 81 of file seq_packet_socket_service.hpp.

template<typename Protocol >

typedef Protocol asio::seq_packet_socket_service< Protocol >::protocol_type

The protocol type.

Definition at line 54 of file seq_packet_socket_service.hpp.

Constructor & Destructor Documentation

template<typename Protocol >

asio::seq_packet_socket_service< Protocol >::seq_packet_socket_service ( asio::io_service & io_service )

inlineexplicit

Construct a new sequenced packet socket service for the specified io_service.

Definition at line 93 of file seq_packet_socket_service.hpp.

Member Function Documentation

template<typename Protocol >

template<typename ConnectHandler >

asio::seq_packet_socket_service< Protocol >::ASIO_INITFN_RESULT_TYPE	(	ConnectHandler	,
		void(asio::error_code)
	)

Start an asynchronous connect.

template<typename Protocol >

template<typename ConstBufferSequence , typename WriteHandler >

asio::seq_packet_socket_service< Protocol >::ASIO_INITFN_RESULT_TYPE	(	WriteHandler	,
		void(asio::error_code, std::size_t)
	)

Start an asynchronous send.

template<typename Protocol >

template<typename MutableBufferSequence , typename ReadHandler >

asio::seq_packet_socket_service< Protocol >::ASIO_INITFN_RESULT_TYPE	(	ReadHandler	,
		void(asio::error_code, std::size_t)
	)

Start an asynchronous receive.

template<typename Protocol >

const endpoint_type asio::seq_packet_socket_service< Protocol >::ASIO_MOVE_ARG ( ConnectHandler )

inline

Definition at line 227 of file seq_packet_socket_service.hpp.

template<typename Protocol >

const ConstBufferSequence socket_base::message_flags asio::seq_packet_socket_service< Protocol >::ASIO_MOVE_ARG ( WriteHandler )

inline

Definition at line 325 of file seq_packet_socket_service.hpp.

template<typename Protocol >

const MutableBufferSequence socket_base::message_flags socket_base::message_flags asio::seq_packet_socket_service< Protocol >::ASIO_MOVE_ARG ( ReadHandler )

inline

Definition at line 353 of file seq_packet_socket_service.hpp.

template<typename Protocol >

asio::error_code asio::seq_packet_socket_service< Protocol >::assign	(	implementation_type &	impl,
		const protocol_type &	protocol,
		const native_handle_type &	native_socket,
		asio::error_code &	ec
	)

inline

Assign an existing native socket to a sequenced packet socket.

Definition at line 154 of file seq_packet_socket_service.hpp.

template<typename Protocol >

bool asio::seq_packet_socket_service< Protocol >::at_mark	(	const implementation_type &	impl,
		asio::error_code &	ec
	)		const

inline

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

Definition at line 194 of file seq_packet_socket_service.hpp.

template<typename Protocol >

std::size_t asio::seq_packet_socket_service< Protocol >::available	(	const implementation_type &	impl,
		asio::error_code &	ec
	)		const

inline

Determine the number of bytes available for reading.

Definition at line 201 of file seq_packet_socket_service.hpp.

template<typename Protocol >

asio::error_code asio::seq_packet_socket_service< Protocol >::bind	(	implementation_type &	impl,
		const endpoint_type &	endpoint,
		asio::error_code &	ec
	)

inline

Bind the sequenced packet socket to the specified local endpoint.

Definition at line 208 of file seq_packet_socket_service.hpp.

template<typename Protocol >

asio::error_code asio::seq_packet_socket_service< Protocol >::cancel	(	implementation_type &	impl,
		asio::error_code &	ec
	)

inline

Cancel all asynchronous operations associated with the socket.

Definition at line 187 of file seq_packet_socket_service.hpp.

template<typename Protocol >

asio::error_code asio::seq_packet_socket_service< Protocol >::close	(	implementation_type &	impl,
		asio::error_code &	ec
	)

inline

Close a sequenced packet socket implementation.

Definition at line 168 of file seq_packet_socket_service.hpp.

template<typename Protocol >

asio::error_code asio::seq_packet_socket_service< Protocol >::connect	(	implementation_type &	impl,
		const endpoint_type &	peer_endpoint,
		asio::error_code &	ec
	)

inline

Connect the sequenced packet socket to the specified endpoint.

Definition at line 215 of file seq_packet_socket_service.hpp.

template<typename Protocol >

void asio::seq_packet_socket_service< Protocol >::construct ( implementation_type & impl )

inline

Construct a new sequenced packet socket implementation.

Definition at line 101 of file seq_packet_socket_service.hpp.

template<typename Protocol >

void asio::seq_packet_socket_service< Protocol >::destroy ( implementation_type & impl )

inline

Destroy a sequenced packet socket implementation.

Definition at line 137 of file seq_packet_socket_service.hpp.

template<typename Protocol >

template<typename GettableSocketOption >

asio::error_code asio::seq_packet_socket_service< Protocol >::get_option	(	const implementation_type &	impl,
		GettableSocketOption &	option,
		asio::error_code &	ec
	)		const

inline

Get a socket option.

Definition at line 248 of file seq_packet_socket_service.hpp.

template<typename Protocol >

template<typename IoControlCommand >

asio::error_code asio::seq_packet_socket_service< Protocol >::io_control	(	implementation_type &	impl,
		IoControlCommand &	command,
		asio::error_code &	ec
	)

inline

Perform an IO control command on the socket.

Definition at line 256 of file seq_packet_socket_service.hpp.

template<typename Protocol >

bool asio::seq_packet_socket_service< Protocol >::is_open ( const implementation_type & impl ) const

inline

Determine whether the socket is open.

Definition at line 162 of file seq_packet_socket_service.hpp.

template<typename Protocol >

endpoint_type asio::seq_packet_socket_service< Protocol >::local_endpoint	(	const implementation_type &	impl,
		asio::error_code &	ec
	)		const

inline

Get the local endpoint.

Definition at line 289 of file seq_packet_socket_service.hpp.

template<typename Protocol >

native_type asio::seq_packet_socket_service< Protocol >::native ( implementation_type & impl )

inline

(Deprecated: Use native_handle().) Get the native socket implementation.

Definition at line 175 of file seq_packet_socket_service.hpp.

template<typename Protocol >

native_handle_type asio::seq_packet_socket_service< Protocol >::native_handle ( implementation_type & impl )

inline

Get the native socket implementation.

Definition at line 181 of file seq_packet_socket_service.hpp.

template<typename Protocol >

bool asio::seq_packet_socket_service< Protocol >::native_non_blocking ( const implementation_type & impl ) const

inline

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

Definition at line 276 of file seq_packet_socket_service.hpp.

template<typename Protocol >

asio::error_code asio::seq_packet_socket_service< Protocol >::native_non_blocking	(	implementation_type &	impl,
		bool	mode,
		asio::error_code &	ec
	)

inline

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

Definition at line 282 of file seq_packet_socket_service.hpp.

template<typename Protocol >

bool asio::seq_packet_socket_service< Protocol >::non_blocking ( const implementation_type & impl ) const

inline

Gets the non-blocking mode of the socket.

Definition at line 263 of file seq_packet_socket_service.hpp.

template<typename Protocol >

asio::error_code asio::seq_packet_socket_service< Protocol >::non_blocking	(	implementation_type &	impl,
		bool	mode,
		asio::error_code &	ec
	)

inline

Sets the non-blocking mode of the socket.

Definition at line 269 of file seq_packet_socket_service.hpp.

template<typename Protocol >

asio::error_code asio::seq_packet_socket_service< Protocol >::open	(	implementation_type &	impl,
		const protocol_type &	protocol,
		asio::error_code &	ec
	)

inline

Open a sequenced packet socket.

Definition at line 143 of file seq_packet_socket_service.hpp.

template<typename Protocol >

template<typename MutableBufferSequence >

std::size_t asio::seq_packet_socket_service< Protocol >::receive	(	implementation_type &	impl,
		const MutableBufferSequence &	buffers,
		socket_base::message_flags	in_flags,
		socket_base::message_flags &	out_flags,
		asio::error_code &	ec
	)

inline

Receive some data from the peer.

Definition at line 338 of file seq_packet_socket_service.hpp.

template<typename Protocol >

endpoint_type asio::seq_packet_socket_service< Protocol >::remote_endpoint	(	const implementation_type &	impl,
		asio::error_code &	ec
	)		const

inline

Get the remote endpoint.

Definition at line 296 of file seq_packet_socket_service.hpp.

template<typename Protocol >

template<typename ConstBufferSequence >

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

inline

Send the given data to the peer.

Definition at line 311 of file seq_packet_socket_service.hpp.

template<typename Protocol >

template<typename SettableSocketOption >

asio::error_code asio::seq_packet_socket_service< Protocol >::set_option	(	implementation_type &	impl,
		const SettableSocketOption &	option,
		asio::error_code &	ec
	)

inline

Set a socket option.

Definition at line 240 of file seq_packet_socket_service.hpp.

template<typename Protocol >

asio::error_code asio::seq_packet_socket_service< Protocol >::shutdown	(	implementation_type &	impl,
		socket_base::shutdown_type	what,
		asio::error_code &	ec
	)