# ACE_Select_Reactor_Impl Class Reference

This class simply defines how Select_Reactor's basic interface functions should look like and provides a common base class for <select_reactor> using various locking mechanism. More...

`#include <Select_Reactor_Base.h>`

Inheritance diagram for ACE_Select_Reactor_Impl:

[legend]
Collaboration diagram for ACE_Select_Reactor_Impl:

[legend]
List of all members.

## Public Types

enum | { DEFAULT_SIZE = ACE_DEFAULT_SELECT_REACTOR_SIZE }

## Public Member Functions

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

## Protected Member Functions

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 | renew (void)=0
virtual int | is_suspended_i (ACE_HANDLE handle)=0
virtual void | clear_dispatch_mask (ACE_HANDLE handle, ACE_Reactor_Mask mask)
int | supress_notify_renew (void)
void | supress_notify_renew (int sr)

## Protected Attributes

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...
int | restart_
int | requeue_position_
ACE_thread_t | owner_
| The original thread that created this Select_Reactor.
bool | state_changed_
bool | mask_signals_

## Private Member Functions

| ACE_Select_Reactor_Impl (const ACE_Select_Reactor_Impl &)
| Deny access since member-wise won't work...
ACE_Select_Reactor_Impl & | operator= (const ACE_Select_Reactor_Impl &)

## Private Attributes

int | supress_renew_

## Friends

class | ACE_Select_Reactor_Notify
class | ACE_Select_Reactor_Handler_Repository

## Detailed Description

This class simply defines how Select_Reactor's basic interface functions should look like and provides a common base class for <select_reactor> using various locking mechanism.

## Member Enumeration Documentation

anonymous enum

Enumeration values:

  DEFAULT_SIZE | Default size of the Select_Reactor's handle table.

## Constructor & Destructor Documentation

ACE_INLINE ACE_Select_Reactor_Impl::ACE_Select_Reactor_Impl | ( | bool | mask_signals = `true` | ) |

| Constructor.

ACE_Select_Reactor_Impl::ACE_Select_Reactor_Impl | ( | const ACE_Select_Reactor_Impl & |  | ) | `[private]`

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

## Member Function Documentation

int ACE_Select_Reactor_Impl::bit_ops | ( | ACE_HANDLE | handle,
|  | ACE_Reactor_Mask | mask,
|  | ACE_Select_Reactor_Handle_Set & | handle_set,
|  | int | ops
| ) | `[protected, virtual]`

| Allow manipulation of the <wait_set_> mask and <ready_set_> mask. Reimplemented in ACE_QtReactor.

void ACE_Select_Reactor_Impl::clear_dispatch_mask | ( | ACE_HANDLE | handle,
|  | ACE_Reactor_Mask | mask
| ) | `[protected, virtual]`

| When register/unregister occur, then we need to re-eval our wait/suspend/dispatch set. Reimplemented in ACE_TP_Reactor.

virtual int ACE_Select_Reactor_Impl::is_suspended_i | ( | ACE_HANDLE | handle | ) | `[protected, pure virtual]`

| Check to see if the <event_handler> associated with handle is suspended. Returns 0 if not, 1 if so. Implemented in ACE_Select_Reactor_T< ACE_SELECT_REACTOR_TOKEN >, and ACE_Select_Reactor_T< ACE_Select_Reactor_Token >.

ACE_Select_Reactor_Impl& ACE_Select_Reactor_Impl::operator= | ( | const ACE_Select_Reactor_Impl & |  | ) | `[private]`

int ACE_Select_Reactor_Impl::purge_pending_notifications | ( | ACE_Event_Handler * | = `0`,
|  | ACE_Reactor_Mask | = `ACE_Event_Handler::ALL_EVENTS_MASK`
| ) | `[virtual]`

| Purge any notifications pending in this reactor for the specified ACE_Event_Handler object. Returns the number of notifications purged. Returns -1 on error. Implements ACE_Reactor_Impl.

virtual void ACE_Select_Reactor_Impl::renew | ( | void |  | ) | `[protected, pure virtual]`

| Enqueue ourselves into the list of waiting threads at the appropriate point specified by <requeue_position_>. Implemented in ACE_Select_Reactor_T< ACE_SELECT_REACTOR_TOKEN >, and ACE_Select_Reactor_T< ACE_Select_Reactor_Token >.

int ACE_Select_Reactor_Impl::resumable_handler | ( | void |  | ) | `[virtual]`

| Does the reactor allow the application to resume the handle on its own ie. can it pass on the control of handle resumption to the application. The select reactor has no handlers that can be resumed by the application. So return 0; Implements ACE_Reactor_Impl. Reimplemented in ACE_TP_Reactor.

ACE_INLINE void ACE_Select_Reactor_Impl::supress_notify_renew | ( | int | sr | ) | `[protected]`

ACE_INLINE int ACE_Select_Reactor_Impl::supress_notify_renew | ( | void |  | ) | `[protected]`

| Controls/access whether the notify handler should renew the Select_Reactor's token or not.

## Friends And Related Function Documentation

friend class ACE_Select_Reactor_Handler_Repository `[friend]`

friend class ACE_Select_Reactor_Notify `[friend]`

## Member Data Documentation

bool ACE_Select_Reactor_Impl::delete_notify_handler_ `[protected]`

| Keeps track of whether we need to delete the notify handler (if we didn't create it, then we don't delete it).

bool ACE_Select_Reactor_Impl::delete_signal_handler_ `[protected]`

| Keeps track of whether we should delete the signal handler (if we didn't create it, then we don't delete it).

bool ACE_Select_Reactor_Impl::delete_timer_queue_ `[protected]`

| Keeps track of whether we should delete the timer queue (if we didn't create it, then we don't delete it).

ACE_Select_Reactor_Handle_Set ACE_Select_Reactor_Impl::dispatch_set_ `[protected]`

| Tracks handles that are ready for dispatch from <select>.

ACE_Select_Reactor_Handler_Repository ACE_Select_Reactor_Impl::handler_rep_ `[protected]`

| Table that maps <ace_handles> to <ACE_Event_Handler *>'s.

bool ACE_Select_Reactor_Impl::initialized_ `[protected]`

| True if we've been initialized yet...

bool ACE_Select_Reactor_Impl::mask_signals_ `[protected]`

| If 0 then the Reactor will not mask the signals during the event dispatching. This is useful for applications that do not register any signal handlers and want to reduce the overhead introduce by the kernel level locks required to change the mask.

ACE_Reactor_Notify* ACE_Select_Reactor_Impl::notify_handler_ `[protected]`

| Callback object that unblocks the ACE_Select_Reactor if it's sleeping.

ACE_thread_t ACE_Select_Reactor_Impl::owner_ `[protected]`

| The original thread that created this Select_Reactor.

ACE_Select_Reactor_Handle_Set ACE_Select_Reactor_Impl::ready_set_ `[protected]`

| Track HANDLES we are interested in for various events that must be dispatched *without* going through <select>.

int ACE_Select_Reactor_Impl::requeue_position_ `[protected]`

| Position that the main ACE_Select_Reactor thread is requeued in the list of waiters during a <notify> callback. If this value == -1 we are requeued at the end of the list. Else if it's 0 then we are requeued at the front of the list. Else if it's > 1 then that indicates the number of waiters to skip over.

int ACE_Select_Reactor_Impl::restart_ `[protected]`

| Restart the <handle_events> event-loop method automatically when <select> is interrupted via <eintr>.

ACE_Sig_Handler* ACE_Select_Reactor_Impl::signal_handler_ `[protected]`

| Handle signals without requiring global/static variables.

bool ACE_Select_Reactor_Impl::state_changed_ `[protected]`

| True if state has changed during dispatching of <ace_event_handlers>, else false. This is used to determine whether we need to make another trip through the <select_reactor>'s <wait_for_multiple_events> loop.

int ACE_Select_Reactor_Impl::supress_renew_ `[private]`

| Determine whether we should renew Select_Reactor's token after handling the notification message.

ACE_Select_Reactor_Handle_Set ACE_Select_Reactor_Impl::suspend_set_ `[protected]`

| Tracks handles that are currently suspended.

ACE_Timer_Queue* ACE_Select_Reactor_Impl::timer_queue_ `[protected]`

| Defined as a pointer to allow overriding by derived classes...

ACE_Select_Reactor_Handle_Set ACE_Select_Reactor_Impl::wait_set_ `[protected]`

| Tracks handles that are waited for by <select>.

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

- Select_Reactor_Base.h
- Select_Reactor_Base.cpp
- Select_Reactor_Base.inl