Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | File Members | Related Pages | Search for 

ACE_WFMO_Reactor_Handler_Repository::Common_Info Class Reference

This struct contains the necessary information for every 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 Member Functions

 Common_Info (void)
 Constructor used for initializing the structure.

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

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.

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

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


Public Attributes

int io_entry_
ACE_Event_Handler * event_handler_
 The assosiated .

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

ACE_Reactor_Mask close_masks_

Detailed Description

This struct contains the necessary information for every 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 118 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 30 of file WFMO_Reactor.inl. 

00031   : io_entry_ (0),
00032     event_handler_ (0),
00033     io_handle_ (ACE_INVALID_HANDLE),
00034     network_events_ (0),
00035     delete_event_ (0),
00036     delete_entry_ (0),
00037     close_masks_ (ACE_Event_Handler::NULL_MASK)
00038 {
00039 }

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, and ACE_WFMO_Reactor_Handler_Repository::Suspended_Info.

Definition at line 78 of file WFMO_Reactor.inl.

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

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

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, ACE_WFMO_Reactor_Handler_Repository::To_Be_Added_Info, and ACE_WFMO_Reactor_Handler_Repository::Suspended_Info.

Definition at line 42 of file WFMO_Reactor.inl.

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

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

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 72 of file WFMO_Reactor.inl. 

00073 {
00074   *this = common_info;
00075 }

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 54 of file WFMO_Reactor.inl.

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

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

Member Data Documentation

ACE_Reactor_Mask ACE_WFMO_Reactor_Handler_Repository::Common_Info::close_masks_
 

These are the masks related to for the . This is only valid when is set.

Definition at line 155 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 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(), 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 created the event on behalf of the user. Therefore we need to clean this up when the removes itself from . This entry is only valid if the flag is true.

Definition at line 145 of file WFMO_Reactor.h.

Referenced by reset(), and set().

ACE_Event_Handler* ACE_WFMO_Reactor_Handler_Repository::Common_Info::event_handler_
 

The assosiated .

Definition at line 126 of file WFMO_Reactor.h.

Referenced by ACE_WFMO_Reactor::complex_dispatch_handler().

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 123 of file WFMO_Reactor.h.

Referenced by 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 . This entry is only valid if the 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(), 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 is interested in. This entry is only valid if the flag is true.

Definition at line 137 of file WFMO_Reactor.h.

Referenced by ACE_WFMO_Reactor::complex_dispatch_handler(), 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 Thu Nov 9 11:32:33 2006 for ACE by doxygen 1.3.6