Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members   Related Pages  

ACE_WFMO_Reactor_Handler_Repository::Common_Info Class Reference

This struct contains the necessary information for every <Event_Handler> entry. The reason the event is not in this structure is because we need to pass an event array into WaitForMultipleObjects and therefore keeping the events seperate makes sense. More...

#include <WFMO_Reactor.h>

Inheritance diagram for ACE_WFMO_Reactor_Handler_Repository::Common_Info:

Inheritance graph
[legend]
Collaboration diagram for ACE_WFMO_Reactor_Handler_Repository::Common_Info:

Collaboration graph
[legend]
List of all members.

Public Methods

 Common_Info (void)
 Constructor used for initializing the structure. More...

void reset (void)
 Reset the state of the structure. More...

void set (int io_entry, ACE_Event_Handler *event_handler, ACE_HANDLE io_handle, long network_events, int delete_event, int delete_entry, ACE_Reactor_Mask close_masks)
 Set the structure to these new values. More...

void set (Common_Info &common_info)
 Set the structure to these new values. More...

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


Public Attributes

int io_entry_
 This indicates whether this entry is for I/O or for a regular event. More...

ACE_Event_Handler * event_handler_
 The assosiated <Event_Handler>. More...

ACE_HANDLE io_handle_
 The I/O handle related to the <Event_Handler>. This entry is only valid if the <io_entry_> flag is true. More...

long network_events_
int delete_event_
int delete_entry_
 This is set when the entry needed to be deleted. More...

ACE_Reactor_Mask close_masks_

Detailed Description

This struct contains the necessary information for every <Event_Handler> entry. The reason the event is not in this structure is because we need to pass an event array into WaitForMultipleObjects and therefore keeping the events seperate makes sense.

Definition at line 111 of file WFMO_Reactor.h.

Constructor & Destructor Documentation

ACE_INLINE ACE_WFMO_Reactor_Handler_Repository::Common_Info::Common_Info (  void    ) 
 

Constructor used for initializing the structure.

Definition at line 27 of file WFMO_Reactor.i. 

00028   : io_entry_ (0),
00029     event_handler_ (0),
00030     io_handle_ (ACE_INVALID_HANDLE),
00031     network_events_ (0),
00032     delete_event_ (0),
00033     delete_entry_ (0),
00034     close_masks_ (ACE_Event_Handler::NULL_MASK)
00035 {
00036 }

Member Function Documentation

ACE_INLINE void ACE_WFMO_Reactor_Handler_Repository::Common_Info::dump (  void    )  const
 

Dump the state of an object.

Reimplemented in ACE_WFMO_Reactor_Handler_Repository::To_Be_Added_Info.

Definition at line 75 of file WFMO_Reactor.i.

References ACE_BEGIN_DUMP, ACE_DEBUG, ACE_END_DUMP, ACE_LIB_TEXT, ACE_TRACE, and LM_DEBUG. 

00076 {
00077   ACE_TRACE ("ACE_WFMO_Reactor_Handler_Repository::Common_Info::dump");
00078 
00079   ACE_DEBUG ((LM_DEBUG, ACE_BEGIN_DUMP, this));
00080 
00081   ACE_DEBUG ((LM_DEBUG,
00082               ACE_LIB_TEXT ("I/O Entry = %d\n"),
00083               this->io_entry_));
00084 
00085   ACE_DEBUG ((LM_DEBUG,
00086               ACE_LIB_TEXT ("Event Handler = %d\n"),
00087               this->event_handler_));
00088 
00089   ACE_DEBUG ((LM_DEBUG,
00090               ACE_LIB_TEXT ("I/O Handle = %d\n"),
00091               this->io_handle_));
00092 
00093   ACE_DEBUG ((LM_DEBUG,
00094               ACE_LIB_TEXT ("Network Events = %d\n"),
00095               this->network_events_));
00096 
00097   ACE_DEBUG ((LM_DEBUG,
00098               ACE_LIB_TEXT ("Delete Event = %d\n"),
00099               this->delete_event_));
00100 
00101   ACE_DEBUG ((LM_DEBUG,
00102               ACE_LIB_TEXT ("Delete Entry = %d\n"),
00103               this->delete_entry_));
00104 
00105   ACE_DEBUG ((LM_DEBUG,
00106               ACE_LIB_TEXT ("Close Masks = %d\n"),
00107               this->close_masks_));
00108 
00109   ACE_DEBUG ((LM_DEBUG, ACE_END_DUMP));
00110 }

ACE_INLINE void ACE_WFMO_Reactor_Handler_Repository::Common_Info::reset (  void    ) 
 

Reset the state of the structure.

Reimplemented in ACE_WFMO_Reactor_Handler_Repository::Current_Info.

Definition at line 39 of file WFMO_Reactor.i.

References close_masks_, delete_entry_, delete_event_, event_handler_, io_entry_, io_handle_, network_events_, and ACE_Event_Handler::NULL_MASK. 

00040 {
00041   this->event_handler_ = 0;
00042   this->io_entry_ = 0;
00043   this->io_handle_ = ACE_INVALID_HANDLE;
00044   this->network_events_ = 0;
00045   this->delete_event_ = 0;
00046   this->delete_entry_ = 0;
00047   this->close_masks_ = ACE_Event_Handler::NULL_MASK;
00048 }

ACE_INLINE void ACE_WFMO_Reactor_Handler_Repository::Common_Info::set (  Common_Info &    common_info ) 
 

Set the structure to these new values.

Definition at line 69 of file WFMO_Reactor.i. 

00070 {
00071   *this = common_info;
00072 }

ACE_INLINE void ACE_WFMO_Reactor_Handler_Repository::Common_Info::set (  int    io_entry,
ACE_Event_Handler *    event_handler,
ACE_HANDLE    io_handle,
long    network_events,
int    delete_event,
int    delete_entry,
ACE_Reactor_Mask    close_masks
) 
 

Set the structure to these new values.

Definition at line 51 of file WFMO_Reactor.i.

References ACE_Reactor_Mask, close_masks_, delete_entry_, delete_event_, event_handler_, io_entry_, io_handle_, and network_events_. 

00058 {
00059   this->event_handler_ = event_handler;
00060   this->io_entry_ = io_entry;
00061   this->io_handle_ = io_handle;
00062   this->network_events_ = network_events;
00063   this->delete_event_ = delete_event;
00064   this->delete_entry_ = delete_entry;
00065   this->close_masks_ = close_masks;
00066 }

Member Data Documentation

ACE_Reactor_Mask ACE_WFMO_Reactor_Handler_Repository::Common_Info::close_masks_
 

These are the masks related to <handle_close> for the <Event_Handler>. This is only valid when <delete_entry_> is set.

Definition at line 148 of file WFMO_Reactor.h.

Referenced by ACE_WFMO_Reactor_Handler_Repository::make_changes_in_current_infos, ACE_WFMO_Reactor_Handler_Repository::make_changes_in_suspension_infos, ACE_WFMO_Reactor_Handler_Repository::make_changes_in_to_be_added_infos, ACE_WFMO_Reactor_Handler_Repository::remove_handler_i, ACE_WFMO_Reactor_Handler_Repository::remove_suspended_handler_i, ACE_WFMO_Reactor_Handler_Repository::remove_to_be_added_handler_i, reset, and set.

int ACE_WFMO_Reactor_Handler_Repository::Common_Info::delete_entry_
 

This is set when the entry needed to be deleted.

Definition at line 141 of file WFMO_Reactor.h.

Referenced by ACE_WFMO_Reactor_Handler_Repository::handler, ACE_WFMO_Reactor_Handler_Repository::make_changes_in_current_infos, ACE_WFMO_Reactor_Handler_Repository::make_changes_in_suspension_infos, ACE_WFMO_Reactor_Handler_Repository::make_changes_in_to_be_added_infos, ACE_WFMO_Reactor_Handler_Repository::modify_network_events_i, ACE_WFMO_Reactor_Handler_Repository::remove_handler_i, ACE_WFMO_Reactor_Handler_Repository::remove_suspended_handler_i, ACE_WFMO_Reactor_Handler_Repository::remove_to_be_added_handler_i, reset, ACE_WFMO_Reactor_Handler_Repository::scheduled_for_deletion, set, and ACE_WFMO_Reactor_Handler_Repository::unbind_i.

int ACE_WFMO_Reactor_Handler_Repository::Common_Info::delete_event_
 

This flag indicates that <WFMO_Reactor> created the event on behalf of the user. Therefore we need to clean this up when the <Event_Handler> removes itself from <WFMO_Reactor>. This entry is only valid if the <io_entry_> flag is true.

Definition at line 138 of file WFMO_Reactor.h.

Referenced by ACE_WFMO_Reactor_Handler_Repository::make_changes_in_current_infos, ACE_WFMO_Reactor_Handler_Repository::make_changes_in_suspension_infos, ACE_WFMO_Reactor_Handler_Repository::make_changes_in_to_be_added_infos, ACE_WFMO_Reactor_Handler_Repository::modify_network_events_i, reset, and set.

ACE_Event_Handler* ACE_WFMO_Reactor_Handler_Repository::Common_Info::event_handler_
 

The assosiated <Event_Handler>.

Definition at line 119 of file WFMO_Reactor.h.

Referenced by ACE_WFMO_Reactor::complex_dispatch_handler, ACE_WFMO_Reactor_Handler_Repository::handler, ACE_WFMO_Reactor_Handler_Repository::make_changes_in_current_infos, ACE_WFMO_Reactor_Handler_Repository::make_changes_in_suspension_infos, ACE_WFMO_Reactor_Handler_Repository::make_changes_in_to_be_added_infos, ACE_WFMO_Reactor_Handler_Repository::remove_handler_i, ACE_WFMO_Reactor_Handler_Repository::remove_suspended_handler_i, ACE_WFMO_Reactor_Handler_Repository::remove_to_be_added_handler_i, reset, and set.

int ACE_WFMO_Reactor_Handler_Repository::Common_Info::io_entry_
 

This indicates whether this entry is for I/O or for a regular event.

Definition at line 116 of file WFMO_Reactor.h.

Referenced by ACE_WFMO_Reactor_Handler_Repository::make_changes_in_current_infos, ACE_WFMO_Reactor_Handler_Repository::make_changes_in_suspension_infos, ACE_WFMO_Reactor_Handler_Repository::make_changes_in_to_be_added_infos, ACE_WFMO_Reactor_Handler_Repository::remove_handler_i, ACE_WFMO_Reactor_Handler_Repository::remove_suspended_handler_i, ACE_WFMO_Reactor_Handler_Repository::remove_to_be_added_handler_i, reset, and set.

ACE_HANDLE ACE_WFMO_Reactor_Handler_Repository::Common_Info::io_handle_
 

The I/O handle related to the <Event_Handler>. This entry is only valid if the <io_entry_> flag is true.

Definition at line 123 of file WFMO_Reactor.h.

Referenced by ACE_WFMO_Reactor::complex_dispatch_handler, ACE_WFMO_Reactor_Handler_Repository::handler, ACE_WFMO_Reactor_Handler_Repository::make_changes_in_current_infos, ACE_WFMO_Reactor_Handler_Repository::make_changes_in_suspension_infos, ACE_WFMO_Reactor_Handler_Repository::make_changes_in_to_be_added_infos, ACE_WFMO_Reactor_Handler_Repository::modify_network_events_i, ACE_WFMO_Reactor_Handler_Repository::remove_handler_i, ACE_WFMO_Reactor_Handler_Repository::remove_suspended_handler_i, ACE_WFMO_Reactor_Handler_Repository::remove_to_be_added_handler_i, reset, ACE_WFMO_Reactor_Handler_Repository::resume_handler_i, set, ACE_WFMO_Reactor_Handler_Repository::suspend_handler_i, and ACE_WFMO_Reactor_Handler_Repository::unbind_i.

long ACE_WFMO_Reactor_Handler_Repository::Common_Info::network_events_
 

This is the set of events that the <Event_Handler> is interested in. This entry is only valid if the <io_entry_> flag is true.

Definition at line 130 of file WFMO_Reactor.h.

Referenced by ACE_WFMO_Reactor::complex_dispatch_handler, ACE_WFMO_Reactor_Handler_Repository::handler, ACE_WFMO_Reactor_Handler_Repository::modify_network_events_i, ACE_WFMO_Reactor_Handler_Repository::remove_handler_i, ACE_WFMO_Reactor_Handler_Repository::remove_suspended_handler_i, ACE_WFMO_Reactor_Handler_Repository::remove_to_be_added_handler_i, reset, and set.

The documentation for this class was generated from the following files:
Generated on Mon Jun 16 12:59:15 2003 for ACE by doxygen1.2.14 written by Dimitri van Heesch, © 1997-2002