diff options
Diffstat (limited to 'TAO/orbsvcs/orbsvcs/Notify/Event_Map_T.h')
-rw-r--r-- | TAO/orbsvcs/orbsvcs/Notify/Event_Map_T.h | 119 |
1 files changed, 119 insertions, 0 deletions
diff --git a/TAO/orbsvcs/orbsvcs/Notify/Event_Map_T.h b/TAO/orbsvcs/orbsvcs/Notify/Event_Map_T.h new file mode 100644 index 00000000000..b7219b3f509 --- /dev/null +++ b/TAO/orbsvcs/orbsvcs/Notify/Event_Map_T.h @@ -0,0 +1,119 @@ +/* -*- C++ -*- */ +/** + * @file Event_Map_T.h + * + * $Id$ + * + * @author Pradeep Gore <pradeep@oomworks.com> + * + * + */ + +#ifndef TAO_NS_EVENT_MAP_T_H +#define TAO_NS_EVENT_MAP_T_H +#include "ace/pre.h" + +#include "notify_export.h" + +#if !defined (ACE_LACKS_PRAGMA_ONCE) +# pragma once +#endif /* ACE_LACKS_PRAGMA_ONCE */ + +#include "ace/Hash_Map_Manager.h" +#include "ace/CORBA_macros.h" + +#include "EventType.h" +#include "Event_Map_Entry_T.h" +#include "EventTypeSeq.h" + +/** + * @class TAO_NS_Event_Map_T + * + * @brief Template class for storing the collection of Proxys. + * + */ +template <class PROXY, class ACE_LOCK> +class TAO_NS_Event_Map_T +{ + +public: + typedef TAO_NS_Event_Map_Entry_T<PROXY> ENTRY; + + /// Constuctor + TAO_NS_Event_Map_T (void); + + /// Destructor + ~TAO_NS_Event_Map_T (); + + /// Init + void init (ACE_ENV_SINGLE_ARG_DECL); + + /// Connect a PROXY + void connect (PROXY* proxy ACE_ENV_ARG_DECL); + + /// Disconnect a PROXY + void disconnect (PROXY* proxy ACE_ENV_ARG_DECL); + + /// Associate PROXY and event_type. + /// Returns 1 if <event_type> is being seem for the 1st time otherwise returns 0. + /// Returns -1 on error. + int insert (PROXY* proxy, const TAO_NS_EventType& event_type ACE_ENV_ARG_DECL); + + /// Remove association of PROXY and event_type. + /// Returns 1 if <event_type> is being seem for the last time otherwise returns 0. + /// Returns -1 on error. + int remove (PROXY* proxy, const TAO_NS_EventType& event_type ACE_ENV_ARG_DECL); + + /// Find the collection mapped to the <event_type> + /// The usage_count on the entry returned is incremented. + ENTRY* find (const TAO_NS_EventType& event_type ACE_ENV_ARG_DECL); + + /// Find the default broadcast list. + ACE_TYPENAME ENTRY::COLLECTION* broadcast_collection (void); + + /// Find the update list. This is all the PROXYS connected to this Map. + ACE_TYPENAME ENTRY::COLLECTION* updates_collection (void); + + /// Release the usage count on this entry. + void release (ENTRY* entry); + + /// Access all the event types available + const TAO_NS_EventTypeSeq& event_types (void); + + /// Access number of proxys connected in all. + int proxy_count (void); + +protected: + /// The Map that stores eventtype to entry mapping. + ACE_Hash_Map_Manager <TAO_NS_EventType, ENTRY*, ACE_SYNCH_NULL_MUTEX> map_; + + /// The lock to use. + ACE_LOCK lock_; + + /// Count of proxys connected. + int proxy_count_; + + /// The default broadcast list for EventType::special. + ENTRY broadcast_entry_; + + /// Update Entry - Keeps a list of all PROXY's connected to this Map. Updates are send to this list. + ENTRY updates_entry_; + + /// The event types that are available in this map. + TAO_NS_EventTypeSeq event_types_; +}; + +#if defined (__ACE_INLINE__) +#include "Event_Map_T.inl" +#endif /* __ACE_INLINE__ */ + +#if defined (ACE_TEMPLATES_REQUIRE_SOURCE) +#include "Event_Map_T.cpp" +#endif /* ACE_TEMPLATES_REQUIRE_SOURCE */ + +#if defined (ACE_TEMPLATES_REQUIRE_PRAGMA) +#pragma implementation ("Event_Map_T.cpp") +#endif /* ACE_TEMPLATES_REQUIRE_PRAGMA */ + +#include "ace/post.h" +#endif /* TAO_NS_EVENT_MAP_T_H */ |