Generic factory for passively connecting clients and creating exactly one service handler of the type SVC_HANDLER specified in the template. More...

#include <Acceptor.h>

Inheritance diagram for ACE_Oneshot_Acceptor< SVC_HANDLER, PEER_ACCEPTOR >:

[legend]

Collaboration diagram for ACE_Oneshot_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. More...

Public Member Functions
	ACE_Oneshot_Acceptor (void)
	Constructor. More...

	ACE_Oneshot_Acceptor (const typename PEER_ACCEPTOR::PEER_ADDR &local_addr, ACE_Reactor reactor=ACE_Reactor::instance(), ACE_Concurrency_Strategy< SVC_HANDLER > =0)

int	open (const typename PEER_ACCEPTOR::PEER_ADDR &, ACE_Reactor reactor=ACE_Reactor::instance(), ACE_Concurrency_Strategy< SVC_HANDLER > =0)

virtual	~ACE_Oneshot_Acceptor (void)
	Close down the {Oneshot_Acceptor}. More...

virtual int	accept (SVC_HANDLER =0, typename PEER_ACCEPTOR::PEER_ADDR remote_addr=0, const ACE_Synch_Options &synch_options=ACE_Synch_Options::defaults, bool restart=true, bool reset_new_handle=false)

virtual int	cancel (void)
	Cancel a oneshot acceptor that was started asynchronously. More...

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

virtual PEER_ACCEPTOR &	acceptor (void) const
	Return the underlying {PEER_ACCEPTOR} object. More...

virtual int	close (void)
	Close down the {Oneshot_Acceptor}. More...

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

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

virtual	~ACE_Service_Object (void)
	Destructor. More...

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

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

virtual int	priority (void) const

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

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

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

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

virtual int	resume_handler (void)

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

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

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

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

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

Reference_Counting_Policy &	reference_counting_policy (void)
	Current Reference_Counting_Policy. More...

Public Member Functions inherited from ACE_Shared_Object
	ACE_Shared_Object (void)
	Constructor. More...

virtual	~ACE_Shared_Object (void)
	Destructor. More...

Public Attributes
	ACE_ALLOC_HOOK_DECLARE
	Declare the dynamic allocation hooks. More...

Protected Member Functions
virtual int	activate_svc_handler (SVC_HANDLER *svc_handler)

int	shared_accept (SVC_HANDLER svc_handler, typename PEER_ACCEPTOR::PEER_ADDR remote_addr, ACE_Time_Value *timeout, bool restart, bool reset_new_handle)

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

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	handle_timeout (const ACE_Time_Value &tv, const void *arg)
	Called when an acceptor times out... More...

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

virtual int	fini (void)

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

virtual int	suspend (void)

virtual int	resume (void)

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

Private Member Functions
int	register_handler (SVC_HANDLER *svc_handler, const ACE_Synch_Options &options, bool restart)

Private Attributes
SVC_HANDLER *	svc_handler_
	Hold the svc_handler_ across asynchrony boundaries. More...

bool	restart_
	Hold the restart flag across asynchrony boundaries. More...

PEER_ACCEPTOR	peer_acceptor_
	Factory that establishes connections passively. More...

ACE_Concurrency_Strategy< SVC_HANDLER > *	concurrency_strategy_
	Concurrency strategy for an Acceptor. More...

bool	delete_concurrency_strategy_

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

Protected Types inherited from ACE_Event_Handler
typedef ACE_Atomic_Op< ACE_SYNCH_MUTEX, Reference_Count >	Atomic_Reference_Count
	Typedef for implementation of reference counting. More...

Protected Attributes inherited from ACE_Event_Handler
Atomic_Reference_Count	reference_count_
	Reference count. More...

Detailed Description

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

Generic factory for passively connecting clients and creating exactly one service handler of the type SVC_HANDLER specified in the template.

This class works similarly to the regular ACE_Acceptor, but with the following differences:

ACE_Oneshot_Acceptor doesn't automatically register itself with the ACE_Reactor; the caller is expected to call the accept() method directly. Since a later call to accept() may require a reactor, the constructor and open() methods both accept an ACE_Reactor pointer which is saved in case it's needed in accept().
ACE_Oneshot_Acceptor doesn't need an ACE_Creation_Strategy (because the user supplies the SVC_HANDLER) or an ACE_Accept_Strategy (because this class only accepts one connection and then removes all traces of itself from the ACE_Reactor if it was registered for asynchronous accepts).

The usage model for ACE_Oneshot_Acceptor is:

Instantiate an object and establish its local address to listen at. This can be accomplished using either the address-accepting constructor (but there's no error indication) or the default constructor followed by a call to open().
Call the accept() method. This will attempt to accept a connection immediately. If there is no immediately available connection to accept, behavior is governed by the ACE_Synch_Options argument passed to open().