Implements priority based dispatching. More...

#include <Priority_Reactor.h>

Inheritance diagram for ACE_Priority_Reactor:

Collaboration diagram for ACE_Priority_Reactor:

Public Member Functions
	ACE_Priority_Reactor (ACE_Sig_Handler =0, ACE_Timer_Queue =0)
	Initialize ACE_Priority_Reactor with the default size.
	ACE_Priority_Reactor (size_t size, bool restart=false, ACE_Sig_Handler =0, ACE_Timer_Queue =0)
	Initialize ACE_Priority_Reactor with size size.
virtual	~ACE_Priority_Reactor (void)
	Close down the select_reactor and release all of its resources.
void	dump (void) const
	Dump the state of an object.
Public Member Functions inherited from ACE_Select_Reactor_T< ACE_Select_Reactor_Token >
	ACE_Select_Reactor_T (ACE_Sig_Handler =0, ACE_Timer_Queue =0, int disable_notify_pipe=ACE_DISABLE_NOTIFY_PIPE_DEFAULT, ACE_Reactor_Notify *notify=0, bool mask_signals=true, int s_queue=ACE_SELECT_TOKEN::FIFO)
	ACE_Select_Reactor_T (size_t size, bool restart=false, ACE_Sig_Handler =0, ACE_Timer_Queue =0, int disable_notify_pipe=ACE_DISABLE_NOTIFY_PIPE_DEFAULT, ACE_Reactor_Notify *notify=0, bool mask_signals=true, int s_queue=ACE_SELECT_TOKEN::FIFO)
virtual int	open (size_t max_number_of_handles=DEFAULT_SIZE, bool restart=false, ACE_Sig_Handler =0, ACE_Timer_Queue =0, int disable_notify_pipe=ACE_DISABLE_NOTIFY_PIPE_DEFAULT, ACE_Reactor_Notify *=0)
virtual int	current_info (ACE_HANDLE, size_t &size)
	Returns -1 (not used in this implementation);.
virtual int	set_sig_handler (ACE_Sig_Handler *signal_handler)
	Use a user specified signal handler instead.
virtual int	timer_queue (ACE_Timer_Queue *tq)
	Set a user-specified timer queue.
virtual ACE_Timer_Queue *	timer_queue (void) const
	Return the current ACE_Timer_Queue.
virtual int	close (void)
	Close down the select_reactor and release all of its resources.
virtual	~ACE_Select_Reactor_T (void)
	Close down the select_reactor and release all of its resources.
virtual int	work_pending (const ACE_Time_Value &max_wait_time=ACE_Time_Value::zero)
virtual int	deactivated (void)
virtual void	deactivate (int do_stop)
virtual int	register_handler (ACE_Event_Handler *eh, ACE_Reactor_Mask mask)
virtual int	register_handler (ACE_HANDLE handle, ACE_Event_Handler *eh, ACE_Reactor_Mask mask)
virtual int	register_handler (ACE_Event_Handler *event_handler, ACE_HANDLE event_handle=ACE_INVALID_HANDLE)
	Not implemented.
virtual int	register_handler (ACE_HANDLE event_handle, ACE_HANDLE io_handle, ACE_Event_Handler *event_handler, ACE_Reactor_Mask mask)
	Not implemented.
virtual int	register_handler (const ACE_Handle_Set &handles, ACE_Event_Handler *eh, ACE_Reactor_Mask mask)
	Register eh with all the handles in the <Handle_Set>.
virtual int	register_handler (int signum, ACE_Event_Handler new_sh, ACE_Sig_Action new_disp=0, ACE_Event_Handler *old_sh=0, ACE_Sig_Action old_disp=0)
virtual int	register_handler (const ACE_Sig_Set &sigset, ACE_Event_Handler new_sh, ACE_Sig_Action new_disp=0)
virtual int	remove_handler (ACE_Event_Handler *eh, ACE_Reactor_Mask mask)
virtual int	remove_handler (ACE_HANDLE handle, ACE_Reactor_Mask)
virtual int	remove_handler (const ACE_Handle_Set &handle_set, ACE_Reactor_Mask)
virtual int	remove_handler (int signum, ACE_Sig_Action new_disp, ACE_Sig_Action old_disp=0, int sigkey=-1)
virtual int	remove_handler (const ACE_Sig_Set &sigset)
	Calls <remove_handler> for every signal in sigset.
virtual int	suspend_handler (ACE_Event_Handler *eh)
	Temporarily suspend the <Event_Handler> associated with eh.
virtual int	suspend_handler (ACE_HANDLE handle)
	Temporarily suspend the Event_Handler associated with handle.
virtual int	suspend_handler (const ACE_Handle_Set &handles)
	Suspend all handles in handle set temporarily.
virtual int	suspend_handlers (void)
	Suspend all the <Event_Handlers> in the Select_Reactor.
virtual int	resume_handler (ACE_Event_Handler *eh)
virtual int	resume_handler (ACE_HANDLE handle)
virtual int	resume_handler (const ACE_Handle_Set &handles)
	Resume all handles in handle set.
virtual int	resume_handlers (void)
	Resume all the <Event_Handlers> in the Select_Reactor.
virtual bool	uses_event_associations (void)
virtual long	schedule_timer (ACE_Event_Handler event_handler, const void arg, const ACE_Time_Value &delay, const ACE_Time_Value &interval=ACE_Time_Value::zero)
virtual int	reset_timer_interval (long timer_id, const ACE_Time_Value &interval)
virtual int	cancel_timer (ACE_Event_Handler *event_handler, int dont_call_handle_close=1)
virtual int	cancel_timer (long timer_id, const void **arg=0, int dont_call_handle_close=1)
virtual int	schedule_wakeup (ACE_Event_Handler *eh, ACE_Reactor_Mask mask)
	ADD the dispatch MASK "bit" bound with the eh and the mask.
virtual int	schedule_wakeup (ACE_HANDLE handle, ACE_Reactor_Mask mask)
	ADD the dispatch MASK "bit" bound with the handle and the mask.
virtual int	cancel_wakeup (ACE_Event_Handler *eh, ACE_Reactor_Mask mask)
	CLR the dispatch MASK "bit" bound with the eh and the mask.
virtual int	cancel_wakeup (ACE_HANDLE handle, ACE_Reactor_Mask mask)
	CLR the dispatch MASK "bit" bound with the handle and the mask.
virtual int	notify (ACE_Event_Handler =0, ACE_Reactor_Mask=ACE_Event_Handler::EXCEPT_MASK, ACE_Time_Value =0)
virtual void	max_notify_iterations (int)
virtual int	max_notify_iterations (void)
virtual bool	restart (void)
	Get the existing restart value.
virtual bool	restart (bool r)
	Set a new value for restart and return the original value.
virtual void	requeue_position (int)
virtual int	requeue_position (void)
virtual int	mask_ops (ACE_Event_Handler *eh, ACE_Reactor_Mask mask, int ops)
virtual int	mask_ops (ACE_HANDLE handle, ACE_Reactor_Mask mask, int ops)
virtual int	ready_ops (ACE_Event_Handler *eh, ACE_Reactor_Mask mask, int ops)
	GET/SET/ADD/CLR the ready "bit" bound with the eh and mask.
virtual int	ready_ops (ACE_HANDLE handle, ACE_Reactor_Mask, int ops)
	GET/SET/ADD/CLR the ready "bit" bound with the handle and mask.
virtual void	wakeup_all_threads (void)
	Wake up all threads in waiting in the event loop.
virtual int	owner (ACE_thread_t n_id, ACE_thread_t *o_id=0)
	Set the new owner of the thread and return the old owner.
virtual int	owner (ACE_thread_t *)
	Return the current owner of the thread.
virtual ACE_Event_Handler *	find_handler (ACE_HANDLE handle)
virtual int	handler (ACE_HANDLE handle, ACE_Reactor_Mask mask, ACE_Event_Handler **eh=0)
virtual int	handler (int signum, ACE_Event_Handler **=0)
virtual bool	initialized (void)
	Returns true if we've been successfully initialized, else false.
virtual size_t	size (void) const
virtual ACE_Lock &	lock (void)
virtual int	handle_events (ACE_Time_Value *max_wait_time=0)
virtual int	alertable_handle_events (ACE_Time_Value *max_wait_time=0)
virtual int	handle_events (ACE_Time_Value &max_wait_time)
virtual int	alertable_handle_events (ACE_Time_Value &max_wait_time)
Public Member Functions inherited from ACE_Select_Reactor_Impl
	ACE_Select_Reactor_Impl (bool mask_signals=true)
	Constructor.
virtual int	purge_pending_notifications (ACE_Event_Handler *=0, ACE_Reactor_Mask=ACE_Event_Handler::ALL_EVENTS_MASK)
virtual int	resumable_handler (void)
Public Member Functions inherited from ACE_Reactor_Impl
virtual	~ACE_Reactor_Impl (void)
	Close down and release all resources.

Public Attributes
	ACE_ALLOC_HOOK_DECLARE
	Declare the dynamic allocation hooks.
Public Attributes inherited from ACE_Select_Reactor_T< ACE_Select_Reactor_Token >

Protected Member Functions
virtual int	dispatch_io_set (int number_of_active_handles, int &number_dispatched, int mask, ACE_Handle_Set &dispatch_mask, ACE_Handle_Set &ready_mask, ACE_EH_PTMF callback)
Protected Member Functions inherited from ACE_Select_Reactor_T< ACE_Select_Reactor_Token >
virtual int	register_handler_i (ACE_HANDLE handle, ACE_Event_Handler *eh, ACE_Reactor_Mask mask)
virtual int	register_handler_i (const ACE_Handle_Set &handles, ACE_Event_Handler *handler, ACE_Reactor_Mask mask)
	Register a set of handles.
virtual int	remove_handler_i (ACE_HANDLE handle, ACE_Reactor_Mask)
virtual int	remove_handler_i (const ACE_Handle_Set &handles, ACE_Reactor_Mask)
	Remove a set of handles.
virtual int	suspend_i (ACE_HANDLE handle)
	Suspend the <Event_Handler> associated with handle.
virtual int	is_suspended_i (ACE_HANDLE handle)
virtual int	resume_i (ACE_HANDLE handle)
	Resume the <Event_Handler> associated with handle.
virtual ACE_Event_Handler *	find_handler_i (ACE_HANDLE handle)
	Implement the public handler method.
virtual int	handler_i (ACE_HANDLE handle, ACE_Reactor_Mask, ACE_Event_Handler **=0)
	Implement the public handler method.
virtual int	handler_i (int signum, ACE_Event_Handler **=0)
	Implement the public handler method.
virtual int	any_ready (ACE_Select_Reactor_Handle_Set &handle_set)
virtual int	any_ready_i (ACE_Select_Reactor_Handle_Set &handle_set)
virtual int	handle_error (void)
	Take corrective action when errors occur.
virtual int	check_handles (void)
	Make sure the handles are all valid.
virtual int	wait_for_multiple_events (ACE_Select_Reactor_Handle_Set &, ACE_Time_Value *)
	Wait for events to occur.
virtual int	dispatch (int nfound, ACE_Select_Reactor_Handle_Set &)
virtual int	dispatch_timer_handlers (int &number_dispatched)
virtual int	dispatch_notification_handlers (ACE_Select_Reactor_Handle_Set &dispatch_set, int &number_of_active_handles, int &number_of_handlers_dispatched)
virtual int	dispatch_io_handlers (ACE_Select_Reactor_Handle_Set &dispatch_set, int &number_of_active_handles, int &number_of_handlers_dispatched)
virtual void	notify_handle (ACE_HANDLE handle, ACE_Reactor_Mask mask, ACE_Handle_Set &, ACE_Event_Handler *eh, ACE_EH_PTMF callback)
virtual void	renew (void)
int	release_token (void)
	Release the token lock when a Win32 structured exception occurs.
int	handle_events_i (ACE_Time_Value *max_wait_time=0)
	Stops the VC++ compiler from bitching about exceptions and destructors.
Protected Member Functions inherited from ACE_Select_Reactor_Impl
virtual int	bit_ops (ACE_HANDLE handle, ACE_Reactor_Mask mask, ACE_Select_Reactor_Handle_Set &handle_set, int ops)
	Allow manipulation of the <wait_set_> mask and <ready_set_> mask.
virtual void	clear_dispatch_mask (ACE_HANDLE handle, ACE_Reactor_Mask mask)
int	supress_notify_renew (void)
void	supress_notify_renew (int sr)

Private Types
typedef ACE_Unbounded_Queue < ACE_Event_Tuple >	QUEUE

Private Member Functions
void	init_bucket (void)
	A small helper to initialize the bucket.
int	build_bucket (ACE_Handle_Set &dispatch_mask, int &min_priority, int &max_priority)
	ACE_Priority_Reactor (const ACE_Priority_Reactor &)
	Deny access since member-wise won't work...
ACE_Priority_Reactor &	operator= (const ACE_Priority_Reactor &)

Private Attributes
QUEUE **	bucket_
ACE_Allocator *	tuple_allocator_

Additional Inherited Members
Protected Attributes inherited from ACE_Select_Reactor_T< ACE_Select_Reactor_Token >
ACE_Select_Reactor_Token	token_
	Synchronization token for the MT_SAFE ACE_Select_Reactor.
ACE_Lock_Adapter < ACE_Select_Reactor_Token >	lock_adapter_
	Adapter used to return internal lock to outside world.
sig_atomic_t	deactivated_
Protected Attributes inherited from ACE_Select_Reactor_Impl
ACE_Select_Reactor_Handler_Repository	handler_rep_
	Table that maps <ACE_HANDLEs> to <ACE_Event_Handler *>'s.
ACE_Select_Reactor_Handle_Set	dispatch_set_
	Tracks handles that are ready for dispatch from <select>
ACE_Select_Reactor_Handle_Set	wait_set_
	Tracks handles that are waited for by <select>.
ACE_Select_Reactor_Handle_Set	suspend_set_
	Tracks handles that are currently suspended.
ACE_Select_Reactor_Handle_Set	ready_set_
ACE_Timer_Queue *	timer_queue_
	Defined as a pointer to allow overriding by derived classes...
ACE_Sig_Handler *	signal_handler_
	Handle signals without requiring global/static variables.
ACE_Reactor_Notify *	notify_handler_
bool	delete_timer_queue_
bool	delete_signal_handler_
bool	delete_notify_handler_
bool	initialized_
	True if we've been initialized yet...
bool	restart_
int	requeue_position_
ACE_thread_t	owner_
	The original thread that created this Select_Reactor.
bool	state_changed_
bool	mask_signals_

Detailed Description

Implements priority based dispatching.

This class refines the dispatching mechanism for the Select_Reactor by taking advantage of the priority method on ACE_Event_Handler.

Member Typedef Documentation

typedef ACE_Unbounded_Queue<ACE_Event_Tuple> ACE_Priority_Reactor::QUEUE

private

There is a queue per-priority, which simply holds the Event_Handlers until we know who goes first.

Constructor & Destructor Documentation

ACE_Priority_Reactor::ACE_Priority_Reactor	(	ACE_Sig_Handler *	sh = `0`,
		ACE_Timer_Queue *	tq = `0`
	)

Initialize ACE_Priority_Reactor with the default size.

ACE_Priority_Reactor::ACE_Priority_Reactor	(	size_t	size,
		bool	restart = `false`,
		ACE_Sig_Handler *	sh = `0`,
		ACE_Timer_Queue *	tq = `0`
	)

Initialize ACE_Priority_Reactor with size size.

ACE_Priority_Reactor::~ACE_Priority_Reactor ( void )

virtual

Close down the select_reactor and release all of its resources.

ACE_Priority_Reactor::ACE_Priority_Reactor ( const ACE_Priority_Reactor & )

private

Deny access since member-wise won't work...

Member Function Documentation

int ACE_Priority_Reactor::build_bucket	(	ACE_Handle_Set &	dispatch_mask,
		int &	min_priority,
		int &	max_priority
	)

private

Build the bucket from the given dispatch_mask. Return -1 on failure, 0 otherwise.

int ACE_Priority_Reactor::dispatch_io_set	(	int	number_of_active_handles,
		int &	number_dispatched,
		int	mask,
		ACE_Handle_Set &	dispatch_mask,
		ACE_Handle_Set &	ready_mask,
		ACE_EH_PTMF	callback
	)

protectedvirtual

We simply override this function to implement the priority dispatching.

Reimplemented from ACE_Select_Reactor_T< ACE_Select_Reactor_Token >.

void ACE_Priority_Reactor::dump ( void ) const

virtual

Dump the state of an object.

Reimplemented from ACE_Select_Reactor_T< ACE_Select_Reactor_Token >.

void ACE_Priority_Reactor::init_bucket ( void )

private

A small helper to initialize the bucket.

ACE_Priority_Reactor& ACE_Priority_Reactor::operator= ( const ACE_Priority_Reactor & )

private

Member Data Documentation

ACE_Priority_Reactor::ACE_ALLOC_HOOK_DECLARE

Declare the dynamic allocation hooks.

Reimplemented from ACE_Select_Reactor_T< ACE_Select_Reactor_Token >.

QUEUE** ACE_Priority_Reactor::bucket_

private

ACE_Allocator* ACE_Priority_Reactor::tuple_allocator_

private

The queues themselves use this allocator to minimize dynamic memory usage.

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

Public Member Functions

Public Attributes

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation