diff options
Diffstat (limited to 'ACE/apps/Gateway/Gateway/Event_Forwarding_Discriminator.h')
| -rw-r--r-- | ACE/apps/Gateway/Gateway/Event_Forwarding_Discriminator.h | 53 |
1 files changed, 28 insertions, 25 deletions
diff --git a/ACE/apps/Gateway/Gateway/Event_Forwarding_Discriminator.h b/ACE/apps/Gateway/Gateway/Event_Forwarding_Discriminator.h index 2a83a53a584..a30d48da7d0 100644 --- a/ACE/apps/Gateway/Gateway/Event_Forwarding_Discriminator.h +++ b/ACE/apps/Gateway/Gateway/Event_Forwarding_Discriminator.h @@ -1,18 +1,15 @@ /* -*- C++ -*- */ -// $Id$ -// ============================================================================ -// -// = LIBRARY -// gateway -// -// = FILENAME -// Event_Forwarding_Discriminator.h -// -// = AUTHOR -// Doug Schmidt -// -// ============================================================================ +//============================================================================= +/** + * @file Event_Forwarding_Discriminator.h + * + * $Id$ + * + * @author Doug Schmidt + */ +//============================================================================= + #ifndef _CONSUMER_MAP_H #define _CONSUMER_MAP_H @@ -27,39 +24,45 @@ #include "Event.h" #include "Consumer_Dispatch_Set.h" +/** + * @class Event_Forwarding_Discriminator + * + * @brief Map events to the set of Consumer_Proxies that have subscribed + * to receive the event. + */ class Event_Forwarding_Discriminator { - // = TITLE - // Map events to the set of Consumer_Proxies that have subscribed - // to receive the event. public: + /// Associate Event with the Consumer_Dispatch_Set. int bind (Event_Key event, Consumer_Dispatch_Set *cds); - // Associate Event with the Consumer_Dispatch_Set. + /// Locate EXID and pass out parameter via INID. If found, + /// return 0, else -1. int unbind (Event_Key event); - // Locate EXID and pass out parameter via INID. If found, - // return 0, else -1. + /// Break any association of EXID. int find (Event_Key event, Consumer_Dispatch_Set *&cds); - // Break any association of EXID. public: + /// Map that associates <Event_Key>s (external ids) with + /// <Consumer_Dispatch_Set> *'s <internal IDs>. ACE_Map_Manager<Event_Key, Consumer_Dispatch_Set *, ACE_Null_Mutex> map_; - // Map that associates <Event_Key>s (external ids) with - // <Consumer_Dispatch_Set> *'s <internal IDs>. }; +/** + * @class Event_Forwarding_Discriminator_Iterator + * + * @brief Define an iterator for the Consumer Map. + */ class Event_Forwarding_Discriminator_Iterator { - // = TITLE - // Define an iterator for the Consumer Map. public: Event_Forwarding_Discriminator_Iterator (Event_Forwarding_Discriminator &mm); int next (Consumer_Dispatch_Set *&); int advance (void); private: + /// Map we are iterating over. ACE_Map_Iterator<Event_Key, Consumer_Dispatch_Set *, ACE_Null_Mutex> map_iter_; - // Map we are iterating over. }; #endif /* _CONSUMER_MAP_H */ |