asio::socket_acceptor_service< Protocol > Class Template Reference

Default service implementation for a socket acceptor. More...

#include <socket_acceptor_service.hpp>

Inheritance diagram for asio::socket_acceptor_service< Protocol >:

Public Types
typedef protocol_type::endpoint	endpoint_type
	The endpoint type.
typedef service_impl_type::implementation_type	implementation_type
	The native type of the socket acceptor.
typedef service_impl_type::native_type	native_type
	The native acceptor type.
typedef Protocol	protocol_type
	The protocol type.
Public Member Functions
template<typename SocketService >
asio::error_code	accept (implementation_type &impl, basic_socket< protocol_type, SocketService > &peer, endpoint_type *peer_endpoint, asio::error_code &ec)
	Accept a new connection.
asio::error_code	assign (implementation_type &impl, const protocol_type &protocol, const native_type &native_acceptor, asio::error_code &ec)
	Assign an existing native acceptor to a socket acceptor.
template<typename SocketService , typename AcceptHandler >
void	async_accept (implementation_type &impl, basic_socket< protocol_type, SocketService > &peer, endpoint_type *peer_endpoint, AcceptHandler handler)
	Start an asynchronous accept.
asio::error_code	bind (implementation_type &impl, const endpoint_type &endpoint, asio::error_code &ec)
	Bind the socket acceptor to the specified local endpoint.
asio::error_code	cancel (implementation_type &impl, asio::error_code &ec)
	Cancel all asynchronous operations associated with the acceptor.
asio::error_code	close (implementation_type &impl, asio::error_code &ec)
	Close a socket acceptor implementation.
void	construct (implementation_type &impl)
	Construct a new socket acceptor implementation.
void	destroy (implementation_type &impl)
	Destroy a socket acceptor implementation.
template<typename GettableSocketOption >
asio::error_code	get_option (const implementation_type &impl, GettableSocketOption &option, asio::error_code &ec) const
	Get a socket option.
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.
bool	is_open (const implementation_type &impl) const
	Determine whether the acceptor is open.
asio::error_code	listen (implementation_type &impl, int backlog, asio::error_code &ec)
endpoint_type	local_endpoint (const implementation_type &impl, asio::error_code &ec) const
	Get the local endpoint.
native_type	native (implementation_type &impl)
	Get the native acceptor implementation.
asio::error_code	open (implementation_type &impl, const protocol_type &protocol, asio::error_code &ec)
	Open a new socket acceptor implementation.
template<typename SettableSocketOption >
asio::error_code	set_option (implementation_type &impl, const SettableSocketOption &option, asio::error_code &ec)
	Set a socket option.
void	shutdown_service ()
	Destroy all user-defined handler objects owned by the service.
	socket_acceptor_service (asio::io_service &io_service)
	Construct a new socket acceptor service for the specified io_service.
Private Types
typedef detail::reactive_socket_service < Protocol, detail::select_reactor< false > >	service_impl_type
Private Attributes
service_impl_type &	service_impl_

Detailed Description

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

Default service implementation for a socket acceptor.

Definition at line 34 of file socket_acceptor_service.hpp.

Member Typedef Documentation

template<typename Protocol >

typedef protocol_type::endpoint asio::socket_acceptor_service< Protocol >::endpoint_type

The endpoint type.

Definition at line 51 of file socket_acceptor_service.hpp.

template<typename Protocol >

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

The native type of the socket acceptor.

Definition at line 76 of file socket_acceptor_service.hpp.

template<typename Protocol >

typedef service_impl_type::native_type asio::socket_acceptor_service< Protocol >::native_type

The native acceptor type.

Definition at line 83 of file socket_acceptor_service.hpp.

template<typename Protocol >

typedef Protocol asio::socket_acceptor_service< Protocol >::protocol_type

The protocol type.

Definition at line 48 of file socket_acceptor_service.hpp.

template<typename Protocol >

typedef detail::reactive_socket_service< Protocol, detail::select_reactor<false> > asio::socket_acceptor_service< Protocol >::service_impl_type [private]

Definition at line 68 of file socket_acceptor_service.hpp.

Constructor & Destructor Documentation

template<typename Protocol >

asio::socket_acceptor_service< Protocol >::socket_acceptor_service ( asio::io_service & io_service ) [inline, explicit]

Construct a new socket acceptor service for the specified io_service.

Definition at line 87 of file socket_acceptor_service.hpp.

Member Function Documentation

template<typename Protocol >

template<typename SocketService >

asio::error_code asio::socket_acceptor_service< Protocol >::accept	(	implementation_type &	impl,
		basic_socket< protocol_type, SocketService > &	peer,
		endpoint_type *	peer_endpoint,
		asio::error_code &	ec
	)			`[inline]`

Accept a new connection.

Definition at line 200 of file socket_acceptor_service.hpp.

template<typename Protocol >

asio::error_code asio::socket_acceptor_service< Protocol >::assign	(	implementation_type &	impl,
		const protocol_type &	protocol,
		const native_type &	native_acceptor,
		asio::error_code &	ec
	)			`[inline]`

Assign an existing native acceptor to a socket acceptor.

Definition at line 119 of file socket_acceptor_service.hpp.

template<typename Protocol >

template<typename SocketService , typename AcceptHandler >

void asio::socket_acceptor_service< Protocol >::async_accept	(	implementation_type &	impl,
		basic_socket< protocol_type, SocketService > &	peer,
		endpoint_type *	peer_endpoint,
		AcceptHandler	handler
	)			`[inline]`

Start an asynchronous accept.

Definition at line 209 of file socket_acceptor_service.hpp.

template<typename Protocol >

asio::error_code asio::socket_acceptor_service< Protocol >::bind	(	implementation_type &	impl,
		const endpoint_type &	endpoint,
		asio::error_code &	ec
	)			`[inline]`

Bind the socket acceptor to the specified local endpoint.

Definition at line 140 of file socket_acceptor_service.hpp.

template<typename Protocol >

asio::error_code asio::socket_acceptor_service< Protocol >::cancel	(	implementation_type &	impl,
		asio::error_code &	ec
	)			`[inline]`

Cancel all asynchronous operations associated with the acceptor.

Definition at line 133 of file socket_acceptor_service.hpp.

template<typename Protocol >

asio::error_code asio::socket_acceptor_service< Protocol >::close	(	implementation_type &	impl,
		asio::error_code &	ec
	)			`[inline]`

Close a socket acceptor implementation.

Definition at line 155 of file socket_acceptor_service.hpp.

template<typename Protocol >

void asio::socket_acceptor_service< Protocol >::construct ( implementation_type & impl ) [inline]

Construct a new socket acceptor implementation.

Definition at line 100 of file socket_acceptor_service.hpp.

template<typename Protocol >

void asio::socket_acceptor_service< Protocol >::destroy ( implementation_type & impl ) [inline]

Destroy a socket acceptor implementation.

Definition at line 106 of file socket_acceptor_service.hpp.

template<typename Protocol >

template<typename GettableSocketOption >

asio::error_code asio::socket_acceptor_service< Protocol >::get_option	(	const implementation_type &	impl,
		GettableSocketOption &	option,
		asio::error_code &	ec
	)			const `[inline]`

Get a socket option.

Definition at line 177 of file socket_acceptor_service.hpp.

template<typename Protocol >

template<typename IoControlCommand >

asio::error_code asio::socket_acceptor_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 185 of file socket_acceptor_service.hpp.

template<typename Protocol >

bool asio::socket_acceptor_service< Protocol >::is_open ( const implementation_type & impl ) const [inline]

Determine whether the acceptor is open.

Definition at line 127 of file socket_acceptor_service.hpp.

template<typename Protocol >

asio::error_code asio::socket_acceptor_service< Protocol >::listen	(	implementation_type &	impl,
		int	backlog,
		asio::error_code &	ec
	)			`[inline]`

Place the socket acceptor into the state where it will listen for new connections.

Definition at line 148 of file socket_acceptor_service.hpp.

template<typename Protocol >

endpoint_type asio::socket_acceptor_service< Protocol >::local_endpoint	(	const implementation_type &	impl,
		asio::error_code &	ec
	)			const `[inline]`

Get the local endpoint.

Definition at line 192 of file socket_acceptor_service.hpp.

template<typename Protocol >

native_type asio::socket_acceptor_service< Protocol >::native ( implementation_type & impl ) [inline]

Get the native acceptor implementation.

Definition at line 162 of file socket_acceptor_service.hpp.

template<typename Protocol >

asio::error_code asio::socket_acceptor_service< Protocol >::open	(	implementation_type &	impl,
		const protocol_type &	protocol,
		asio::error_code &	ec
	)			`[inline]`

Open a new socket acceptor implementation.

Definition at line 112 of file socket_acceptor_service.hpp.

template<typename Protocol >

template<typename SettableSocketOption >

asio::error_code asio::socket_acceptor_service< Protocol >::set_option	(	implementation_type &	impl,
		const SettableSocketOption &	option,
		asio::error_code &	ec
	)			`[inline]`