Abstract factory for creating a service handler (SVC_HANDLER), accepting into the SVC_HANDLER, and activating the SVC_HANDLER. More...

#include <Acceptor.h>

Inheritance diagram for ACE_Acceptor< SVC_HANDLER, PEER_ACCEPTOR >:

[legend]

Collaboration diagram for ACE_Acceptor< SVC_HANDLER, PEER_ACCEPTOR >:

[legend]

Public Types
typedef PEER_ACCEPTOR::PEER_ADDR	addr_type

typedef PEER_ACCEPTOR	acceptor_type

typedef SVC_HANDLER	handler_type

typedef SVC_HANDLER::stream_type	stream_type

Public Types inherited from ACE_Event_Handler
enum	{ LO_PRIORITY = 0 , HI_PRIORITY = 10 , NULL_MASK = 0 , READ_MASK = (1 << 0) , WRITE_MASK = (1 << 1) , EXCEPT_MASK = (1 << 2) , ACCEPT_MASK = (1 << 3) , CONNECT_MASK = (1 << 4) , TIMER_MASK = (1 << 5) , QOS_MASK = (1 << 6) , GROUP_QOS_MASK = (1 << 7) , SIGNAL_MASK = (1 << 8) , ALL_EVENTS_MASK , RWE_MASK , DONT_CALL = (1 << 9) }

enum	{ ACE_EVENT_HANDLER_NOT_RESUMED = -1 , ACE_REACTOR_RESUMES_HANDLER = 0 , ACE_APPLICATION_RESUMES_HANDLER }

typedef long	Reference_Count
	Reference count type.

Public Member Functions
	ACE_Acceptor (ACE_Reactor *=0, int use_select=ACE_DEFAULT_ACCEPTOR_USE_SELECT)
	"Do-nothing" constructor.

	ACE_Acceptor (const typename PEER_ACCEPTOR::PEER_ADDR &local_addr, ACE_Reactor *reactor=ACE_Reactor::instance(), int flags=0, int use_select=ACE_DEFAULT_ACCEPTOR_USE_SELECT, int reuse_addr=1)

virtual int	open (const typename PEER_ACCEPTOR::PEER_ADDR &local_addr, ACE_Reactor *reactor=ACE_Reactor::instance(), int flags=0, int use_select=ACE_DEFAULT_ACCEPTOR_USE_SELECT, int reuse_addr=1)

virtual	~ACE_Acceptor ()
	Close down the Acceptor's resources.

virtual	operator PEER_ACCEPTOR & () const
	Return the underlying PEER_ACCEPTOR object.

virtual PEER_ACCEPTOR &	acceptor () const
	Return the underlying PEER_ACCEPTOR object.

virtual ACE_HANDLE	get_handle () const
	Returns the listening acceptor's {ACE_HANDLE}.

virtual int	close ()
	Close down the Acceptor.

virtual int	handle_accept_error ()

void	dump () const
	Dump the state of an object.

virtual int	suspend ()
	This method calls {Reactor::suspend}.

virtual int	resume ()
	This method calls {Reactor::resume}.

Public Member Functions inherited from ACE_Service_Object
	ACE_Service_Object (ACE_Reactor *=0)
	Constructor.

virtual	~ACE_Service_Object ()
	Destructor.

Public Member Functions inherited from ACE_Event_Handler
virtual	~ACE_Event_Handler ()=default
	Destructor is virtual to enable proper cleanup.

virtual void	set_handle (ACE_HANDLE)
	Set the I/O handle.

virtual int	priority () const

virtual void	priority (int priority)
	Set the priority of the Event_Handler.

virtual int	handle_output (ACE_HANDLE fd=ACE_INVALID_HANDLE)

virtual int	handle_exception (ACE_HANDLE fd=ACE_INVALID_HANDLE)
	Called when an exceptional events occur (e.g., SIGURG).

virtual int	handle_timeout (const ACE_Time_Value &current_time, const void *act=0)

virtual int	handle_exit (ACE_Process *)
	Called when a process exits.

virtual int	handle_signal (int signum, siginfo_t =0, ucontext_t =0)

virtual int	resume_handler ()

virtual int	handle_qos (ACE_HANDLE=ACE_INVALID_HANDLE)

virtual int	handle_group_qos (ACE_HANDLE=ACE_INVALID_HANDLE)

virtual void	reactor (ACE_Reactor *reactor)
	Set the event demultiplexors.

virtual ACE_Reactor *	reactor () const
	Get the event demultiplexors.

virtual ACE_Reactor_Timer_Interface *	reactor_timer_interface () const
	Get only the reactor's timer related interface.

virtual Reference_Count	add_reference ()
	Increment reference count on the handler.

virtual Reference_Count	remove_reference ()
	Decrement reference count on the handler.

Reference_Counting_Policy &	reference_counting_policy ()
	Current Reference_Counting_Policy.

Public Member Functions inherited from ACE_Shared_Object
	ACE_Shared_Object ()
	Constructor.

virtual	~ACE_Shared_Object ()
	Destructor.

Public Attributes
	ACE_ALLOC_HOOK_DECLARE
	Declare the dynamic allocation hooks.

Public Attributes inherited from ACE_Service_Object
	ACE_ALLOC_HOOK_DECLARE
	Declare the dynamic allocation hooks.

Protected Member Functions
virtual int	make_svc_handler (SVC_HANDLER *&sh)

virtual int	accept_svc_handler (SVC_HANDLER *svc_handler)

virtual int	activate_svc_handler (SVC_HANDLER *svc_handler)

virtual int	handle_close (ACE_HANDLE=ACE_INVALID_HANDLE, ACE_Reactor_Mask=ACE_Event_Handler::ALL_EVENTS_MASK)

virtual int	handle_input (ACE_HANDLE)

virtual int	init (int argc, ACE_TCHAR *argv[])

virtual int	fini ()
	Calls {handle_close}.

virtual int	info (ACE_TCHAR **buf, size_t) const
	Default version returns address info in {buf}.

Protected Member Functions inherited from ACE_Event_Handler
	ACE_Event_Handler (ACE_Reactor *=nullptr, int priority=ACE_Event_Handler::LO_PRIORITY)
	Force ACE_Event_Handler to be an abstract base class.

Protected Attributes
PEER_ACCEPTOR	peer_acceptor_
	Concrete factory for accepting connections from clients...

PEER_ACCEPTOR::PEER_ADDR	peer_acceptor_addr_
	Needed to reopen the socket if {accept} fails.

int	flags_

int	use_select_

int	reuse_addr_
	Needed to reopen the socket if {accept} fails.

Protected Attributes inherited from ACE_Event_Handler
Atomic_Reference_Count	reference_count_
	Reference count.

Additional Inherited Members
Static Public Member Functions inherited from ACE_Event_Handler
static ACE_THR_FUNC_RETURN	read_adapter (void *event_handler)

static int	register_stdin_handler (ACE_Event_Handler eh, ACE_Reactor reactor, ACE_Thread_Manager *thr_mgr, int flags=THR_DETACHED)

static int	remove_stdin_handler (ACE_Reactor reactor, ACE_Thread_Manager thr_mgr)
	Performs the inverse of the register_stdin_handler() method.

Protected Types inherited from ACE_Event_Handler
typedef std::atomic< Reference_Count >	Atomic_Reference_Count
	Typedef for implementation of reference counting.

Detailed Description

template<typename SVC_HANDLER, typename PEER_ACCEPTOR>
class ACE_Acceptor< SVC_HANDLER, PEER_ACCEPTOR >

Abstract factory for creating a service handler (SVC_HANDLER), accepting into the SVC_HANDLER, and activating the SVC_HANDLER.

Implements the basic strategy for passively establishing connections with clients. An ACE_Acceptor inherits from ACE_Service_Object, which in turn inherits from ACE_Event_Handler. This enables the ACE_Reactor to dispatch the ACE_Acceptor's handle_input method when connection events occur. The handle_input method performs the ACE_Acceptor's default creation, connection establishment, and service activation strategies. These strategies can be overridden by subclasses individually or as a group.

An ACE_Acceptor is parameterized by concrete types that conform to the interfaces of SVC_HANDLER and PEER_ACCEPTOR described below.

Template Parameters

SVC_HANDLER The name of the concrete type that performs the application-specific service. The SVC_HANDLER typically inherits from ACE_Svc_Handler.

See also: Svc_Handler.h.

Template Parameters

PEER_ACCEPTOR The name of the class that implements the PEER_ACCEPTOR endpoint (e.g., ACE_SOCK_Acceptor) to passively establish connections. A PEER_ACCEPTOR implementation must provide a PEER_STREAM and PEER_ADDR trait to identify the type of stream (e.g., ACE_SOCK_Stream) and type of address (e.g., ACE_INET_Addr) used by the endpoint.

Member Typedef Documentation

◆ acceptor_type

template<typename SVC_HANDLER , typename PEER_ACCEPTOR >

typedef PEER_ACCEPTOR ACE_Acceptor< SVC_HANDLER, PEER_ACCEPTOR >::acceptor_type

◆ addr_type

template<typename SVC_HANDLER , typename PEER_ACCEPTOR >

typedef PEER_ACCEPTOR::PEER_ADDR ACE_Acceptor< SVC_HANDLER, PEER_ACCEPTOR >::addr_type

◆ handler_type

template<typename SVC_HANDLER , typename PEER_ACCEPTOR >

typedef SVC_HANDLER ACE_Acceptor< SVC_HANDLER, PEER_ACCEPTOR >::handler_type

◆ stream_type

template<typename SVC_HANDLER , typename PEER_ACCEPTOR >

typedef SVC_HANDLER::stream_type ACE_Acceptor< SVC_HANDLER, PEER_ACCEPTOR >::stream_type

Constructor & Destructor Documentation

◆ ACE_Acceptor() [1/2]

template<typename SVC_HANDLER , typename PEER_ACCEPTOR >

ACE_Acceptor< SVC_HANDLER, PEER_ACCEPTOR >::ACE_Acceptor	(	ACE_Reactor *	reactor = 0,
		int	use_select = ACE_DEFAULT_ACCEPTOR_USE_SELECT )

"Do-nothing" constructor.

◆ ACE_Acceptor() [2/2]

template<typename SVC_HANDLER , typename PEER_ACCEPTOR >

ACE_Acceptor< SVC_HANDLER, PEER_ACCEPTOR >::ACE_Acceptor	(	const typename PEER_ACCEPTOR::PEER_ADDR &	local_addr,
		ACE_Reactor *	reactor = ACE_Reactor::instance (),
		int	flags = 0,
		int	use_select = ACE_DEFAULT_ACCEPTOR_USE_SELECT,
		int	reuse_addr = 1 )

Open the contained PEER_ACCEPTOR object to begin listening, and register with the specified reactor for accept events. An acceptor can only listen to one port at a time, so make sure to close() the acceptor before calling open() again.

The PEER_ACCEPTOR handle is put into non-blocking mode as a safeguard against the race condition that can otherwise occur between the time when the passive-mode socket handle is "ready" and when the actual accept() call is made. During this interval, the client can shutdown the connection, in which case, the accept() call can hang.

Parameters

local_addr	The address to listen at.
reactor	Pointer to the ACE_Reactor instance to register this object with. The default is the singleton.
flags	Flags to control what mode an accepted socket will be put into after it is accepted. The only legal value for this argument is `ACE_NONBLOCK`, which enables non-blocking mode on the accepted peer stream object in `SVC_HANDLER`. The default is 0.
use_select	Affects behavior when called back by the reactor when a connection can be accepted. If non-zero, this object will accept all pending connections, instead of just the one that triggered the reactor callback. Uses ACE_OS::select() internally to detect any remaining acceptable connections. The default is 1.
reuse_addr	Passed to the `PEER_ACCEPTOR::open()` method with `local_addr`. Generally used to request that the OS allow reuse of the listen port. The default is 1.

◆ ~ACE_Acceptor()

template<typename SVC_HANDLER , typename PEER_ACCEPTOR >

ACE_Acceptor< SVC_HANDLER, PEER_ACCEPTOR >::~ACE_Acceptor ( )

virtual

Close down the Acceptor's resources.

Member Function Documentation

◆ accept_svc_handler()

template<typename SVC_HANDLER , typename PEER_ACCEPTOR >

int ACE_Acceptor< SVC_HANDLER, PEER_ACCEPTOR >::accept_svc_handler ( SVC_HANDLER * svc_handler )

protectedvirtual

Bridge method for accepting the new connection into the svc_handler. The default behavior delegates to the PEER_ACCEPTOR::accept.

Reimplemented in ACE_Strategy_Acceptor< SVC_HANDLER, PEER_ACCEPTOR >.

◆ acceptor()

template<typename SVC_HANDLER , typename PEER_ACCEPTOR >

PEER_ACCEPTOR & ACE_Acceptor< SVC_HANDLER, PEER_ACCEPTOR >::acceptor ( ) const

virtual

Return the underlying PEER_ACCEPTOR object.

Reimplemented in ACE_Strategy_Acceptor< SVC_HANDLER, PEER_ACCEPTOR >.

◆ activate_svc_handler()

template<typename SVC_HANDLER , typename PEER_ACCEPTOR >

int ACE_Acceptor< SVC_HANDLER, PEER_ACCEPTOR >::activate_svc_handler ( SVC_HANDLER * svc_handler )

protectedvirtual

Bridge method for activating a svc_handler with the appropriate concurrency strategy. The default behavior of this method is to activate the SVC_HANDLER by calling its open() method (which allows the SVC_HANDLER to define its own concurrency strategy). However, subclasses can override this strategy to do more sophisticated concurrency activations (such as making the SVC_HANDLER as an "active object" via multi-threading or multi-processing).

Reimplemented in ACE_Strategy_Acceptor< SVC_HANDLER, PEER_ACCEPTOR >.

◆ close()

template<typename SVC_HANDLER , typename PEER_ACCEPTOR >

int ACE_Acceptor< SVC_HANDLER, PEER_ACCEPTOR >::close ( )

virtual

Close down the Acceptor.

◆ dump()

template<typename SVC_HANDLER , typename PEER_ACCEPTOR >

PEER_ACCEPTOR void ACE_Acceptor< SVC_HANDLER, PEER_ACCEPTOR >::dump ( ) const

Dump the state of an object.

◆ fini()

template<typename SVC_HANDLER , typename PEER_ACCEPTOR >

int ACE_Acceptor< SVC_HANDLER, PEER_ACCEPTOR >::fini ( )

protectedvirtual

Calls {handle_close}.

Reimplemented from ACE_Shared_Object.

Reimplemented in ACE_Strategy_Acceptor< SVC_HANDLER, PEER_ACCEPTOR >.

◆ get_handle()

template<typename SVC_HANDLER , typename PEER_ACCEPTOR >

ACE_HANDLE ACE_Acceptor< SVC_HANDLER, PEER_ACCEPTOR >::get_handle ( ) const

virtual

Returns the listening acceptor's {ACE_HANDLE}.

Reimplemented from ACE_Event_Handler.

Reimplemented in ACE_Strategy_Acceptor< SVC_HANDLER, PEER_ACCEPTOR >.

◆ handle_accept_error()

template<typename SVC_HANDLER , typename PEER_ACCEPTOR >

int ACE_Acceptor< SVC_HANDLER, PEER_ACCEPTOR >::handle_accept_error ( )

virtual

In the event that an accept fails, this method will be called and the return value will be returned from handle_input().

◆ handle_close()

template<typename SVC_HANDLER , typename PEER_ACCEPTOR >

int ACE_Acceptor< SVC_HANDLER, PEER_ACCEPTOR >::handle_close	(	ACE_HANDLE	= ACE_INVALID_HANDLE,
		ACE_Reactor_Mask	= ACE_Event_Handler::ALL_EVENTS_MASK )

protectedvirtual

Perform termination activities when {this} is removed from the {reactor}.

Reimplemented from ACE_Event_Handler.

Reimplemented in ACE_Strategy_Acceptor< SVC_HANDLER, PEER_ACCEPTOR >.

◆ handle_input()

template<typename SVC_HANDLER , typename PEER_ACCEPTOR >

int ACE_Acceptor< SVC_HANDLER, PEER_ACCEPTOR >::handle_input ( ACE_HANDLE listener )

protectedvirtual

Accepts all pending connections from clients, and creates and activates SVC_HANDLERs.

Reimplemented from ACE_Event_Handler.

◆ info()

template<typename SVC_HANDLER , typename PEER_ACCEPTOR >

int ACE_Acceptor< SVC_HANDLER, PEER_ACCEPTOR >::info	(	ACE_TCHAR **	buf,
		size_t	length ) const

protectedvirtual

Default version returns address info in {buf}.

Reimplemented from ACE_Shared_Object.

Reimplemented in ACE_Strategy_Acceptor< SVC_HANDLER, PEER_ACCEPTOR >.

◆ init()

template<typename SVC_HANDLER , typename PEER_ACCEPTOR >

int ACE_Acceptor< SVC_HANDLER, PEER_ACCEPTOR >::init	(	int	argc,
		ACE_TCHAR *	argv[] )

protectedvirtual

Default version does no work and returns -1. Must be overloaded by application developer to do anything meaningful.

Reimplemented from ACE_Shared_Object.

◆ make_svc_handler()

template<typename SVC_HANDLER , typename PEER_ACCEPTOR >

int ACE_Acceptor< SVC_HANDLER, PEER_ACCEPTOR >::make_svc_handler ( SVC_HANDLER *& sh )

protectedvirtual

Bridge method for creating a SVC_HANDLER. The default is to create a new {SVC_HANDLER} if {sh} == 0, else {sh} is unchanged. However, subclasses can override this policy to perform SVC_HANDLER creation in any way that they like (such as creating subclass instances of SVC_HANDLER, using a singleton, dynamically linking the handler, etc.). Returns -1 on failure, else 0.

Reimplemented in ACE_Strategy_Acceptor< SVC_HANDLER, PEER_ACCEPTOR >.

◆ open()

template<typename SVC_HANDLER , typename PEER_ACCEPTOR >

int ACE_Acceptor< SVC_HANDLER, PEER_ACCEPTOR >::open	(	const typename PEER_ACCEPTOR::PEER_ADDR &	local_addr,
		ACE_Reactor *	reactor = ACE_Reactor::instance (),
		int	flags = 0,
		int	use_select = ACE_DEFAULT_ACCEPTOR_USE_SELECT,
		int	reuse_addr = 1 )

virtual

Open the contained PEER_ACCEPTOR object to begin listening, and register with the specified reactor for accept events. An acceptor can only listen to one port at a time, so make sure to close() the acceptor before calling open() again.

The PEER_ACCEPTOR handle is put into non-blocking mode as a safeguard against the race condition that can otherwise occur between the time when the passive-mode socket handle is "ready" and when the actual accept() call is made. During this interval, the client can shutdown the connection, in which case, the accept() call can hang.

Parameters

local_addr	The address to listen at.
reactor	Pointer to the ACE_Reactor instance to register this object with. The default is the singleton.
flags	Flags to control what mode an accepted socket will be put into after it is accepted. The only legal value for this argument is `ACE_NONBLOCK`, which enables non-blocking mode on the accepted peer stream object in `SVC_HANDLER`. The default is 0.
use_select	Affects behavior when called back by the reactor when a connection can be accepted. If non-zero, this object will accept all pending connections, instead of just the one that triggered the reactor callback. Uses ACE_OS::select() internally to detect any remaining acceptable connections. The default is 1.
reuse_addr	Passed to the `PEER_ACCEPTOR::open()` method with `local_addr`. Generally used to request that the OS allow reuse of the listen port. The default is 1.

Return values

0	Success
-1	Failure, `errno` contains an error code.

Reimplemented in ACE_Strategy_Acceptor< SVC_HANDLER, PEER_ACCEPTOR >.

◆ operator PEER_ACCEPTOR &()

template<typename SVC_HANDLER , typename PEER_ACCEPTOR >

ACE_Acceptor< SVC_HANDLER, PEER_ACCEPTOR >::operator PEER_ACCEPTOR & ( ) const

virtual

Return the underlying PEER_ACCEPTOR object.

Reimplemented in ACE_Strategy_Acceptor< SVC_HANDLER, PEER_ACCEPTOR >.

◆ resume()

template<typename SVC_HANDLER , typename PEER_ACCEPTOR >

int ACE_Acceptor< SVC_HANDLER, PEER_ACCEPTOR >::resume ( )

virtual

This method calls {Reactor::resume}.

Reimplemented from ACE_Service_Object.

Reimplemented in ACE_Strategy_Acceptor< SVC_HANDLER, PEER_ACCEPTOR >.

◆ suspend()

template<typename SVC_HANDLER , typename PEER_ACCEPTOR >

int ACE_Acceptor< SVC_HANDLER, PEER_ACCEPTOR >::suspend ( )

virtual

This method calls {Reactor::suspend}.

Reimplemented from ACE_Service_Object.

Reimplemented in ACE_Strategy_Acceptor< SVC_HANDLER, PEER_ACCEPTOR >.

Member Data Documentation

◆ ACE_ALLOC_HOOK_DECLARE

template<typename SVC_HANDLER , typename PEER_ACCEPTOR >

ACE_Acceptor< SVC_HANDLER, PEER_ACCEPTOR >::ACE_ALLOC_HOOK_DECLARE

Declare the dynamic allocation hooks.

◆ flags_

template<typename SVC_HANDLER , typename PEER_ACCEPTOR >

int ACE_Acceptor< SVC_HANDLER, PEER_ACCEPTOR >::flags_

protected

Flags that indicate how {SVC_HANDLER}'s should be initialized prior to being activated. Right now, the only flag that is processed is {ACE_NONBLOCK}, which enabled non-blocking I/O on the {SVC_HANDLER} when it is opened.

◆ peer_acceptor_

template<typename SVC_HANDLER , typename PEER_ACCEPTOR >

PEER_ACCEPTOR ACE_Acceptor< SVC_HANDLER, PEER_ACCEPTOR >::peer_acceptor_

protected

Concrete factory for accepting connections from clients...

◆ peer_acceptor_addr_

template<typename SVC_HANDLER , typename PEER_ACCEPTOR >

PEER_ACCEPTOR::PEER_ADDR ACE_Acceptor< SVC_HANDLER, PEER_ACCEPTOR >::peer_acceptor_addr_

protected

Needed to reopen the socket if {accept} fails.

◆ reuse_addr_

template<typename SVC_HANDLER , typename PEER_ACCEPTOR >

int ACE_Acceptor< SVC_HANDLER, PEER_ACCEPTOR >::reuse_addr_

protected

Needed to reopen the socket if {accept} fails.

◆ use_select_

template<typename SVC_HANDLER , typename PEER_ACCEPTOR >

int ACE_Acceptor< SVC_HANDLER, PEER_ACCEPTOR >::use_select_

protected

Flag that indicates whether it shall use {select} in the {accept}-loop.

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

Public Types

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ acceptor_type

◆ addr_type

◆ handler_type

◆ stream_type

Constructor & Destructor Documentation

◆ ACE_Acceptor() [1/2]

◆ ACE_Acceptor() [2/2]

◆ ~ACE_Acceptor()

Member Function Documentation

◆ accept_svc_handler()

◆ acceptor()

◆ activate_svc_handler()

◆ close()

◆ dump()

◆ fini()

◆ get_handle()

◆ handle_accept_error()

◆ handle_close()

◆ handle_input()

◆ info()

◆ init()

◆ make_svc_handler()

◆ open()

◆ operator PEER_ACCEPTOR &()

◆ resume()

◆ suspend()

Member Data Documentation

◆ ACE_ALLOC_HOOK_DECLARE

◆ flags_

◆ peer_acceptor_

◆ peer_acceptor_addr_

◆ reuse_addr_

◆ use_select_