summaryrefslogtreecommitdiff
path: root/TAO/orbsvcs/orbsvcs/Notify/Event_Map_T.h
blob: 22eccd88c42de9e671cffd92192e06a3e8b8ca4e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
/* -*- 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 "Types.h"
#include "EventType.h"
#include "Event_Map_Entry_T.h"

class TAO_NS_Event_Map_Observer;

/**
 * @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
{
  typedef TAO_NS_Event_Map_Entry_T<PROXY> ENTRY;

public:
  typedef TAO_ESF_Proxy_Collection<PROXY> COLLECTION;
  /// Constuctor
  TAO_NS_Event_Map_T (void);

  /// Destructor
  ~TAO_NS_Event_Map_T ();

  /// Init
  void init (ACE_ENV_SINGLE_ARG_DECL);

  /// Attach an Observer.
  void attach_observer (TAO_NS_Event_Map_Observer* observer);

  /// An entry can be precreated for an event_type. else it is created when required (during insert).
  COLLECTION* create_entry (const TAO_NS_EventType& event_type ACE_ENV_ARG_DECL);

  /// Associate PROXY and event_type. returns count of PROXYs.
  int insert (PROXY* proxy, const TAO_NS_EventType& event_type ACE_ENV_ARG_DECL);

  /// Remove association of PROXY and event_type. returns count of PROXYs.
  int remove (PROXY* proxy, const TAO_NS_EventType& event_type ACE_ENV_ARG_DECL);

  /// Find the collection mapped to the <event_type>
  COLLECTION* find (const TAO_NS_EventType& event_type ACE_ENV_ARG_DECL);

  /// Find the default broadcast list.
  COLLECTION* broadcast_collection (void);

  /// Access count, number of different event types in the map.
  int event_type_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 items entered in the map.
  int event_type_count_;

  /// The default broadcast list for EventType::special.
  COLLECTION* broadcast_collection_;

  /// Observer attached to us.
  TAO_NS_Event_Map_Observer* observer_;
};

#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 */