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
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
|
// -*- C++ -*-
/**
* @file EC_ObserverStrategy.h
*
* $Id$
*
* @author Carlos O'Ryan (coryan@cs.wustl.edu)
* @author Johnny Willemsen (jwillemsen@remedy.nl)
* @author Kees van Marle (kvmarle@remedy.nl)
*
* Based on previous work by Tim Harrison (harrison@cs.wustl.edu) and
* other members of the DOC group. More details can be found in:
*
* http://doc.ece.uci.edu/~coryan/EC/index.html
*/
#ifndef TAO_EC_OBSERVERSTRATEGY_H
#define TAO_EC_OBSERVERSTRATEGY_H
#include /**/ "ace/pre.h"
#include "orbsvcs/ESF/ESF_Worker.h"
#if !defined (ACE_LACKS_PRAGMA_ONCE)
# pragma once
#endif /* ACE_LACKS_PRAGMA_ONCE */
#include "ace/Null_Mutex.h"
#include "ace/RB_Tree.h"
#include "ace/Map_Manager.h"
#include "orbsvcs/RtecEventChannelAdminC.h"
#include /**/ "event_serv_export.h"
ACE_BEGIN_VERSIONED_NAMESPACE_DECL
class ACE_Lock;
ACE_END_VERSIONED_NAMESPACE_DECL
TAO_BEGIN_VERSIONED_NAMESPACE_DECL
class TAO_EC_Event_Channel_Base;
class TAO_EC_ProxyPushConsumer;
class TAO_EC_ProxyPushSupplier;
/**
* @class TAO_EC_ObserverStrategy
*
* @brief The strategy to handle observers for the Event Channel subscriptions
* and publication.
*
* The Event Channel supports Observers for the set of subscriptions and
* publications. This is used to implement federations of event channels,
* either through UDP (multicast and unicast) and/or regular CORBA calls.
* This behavior of the EC is strategized to avoid overhead when no gateways
* are needed.
*/
class TAO_RTEvent_Serv_Export TAO_EC_ObserverStrategy
{
public:
/// Destructor
virtual ~TAO_EC_ObserverStrategy (void);
/// The basic methods to support the EC strategies.
virtual RtecEventChannelAdmin::Observer_Handle
append_observer (RtecEventChannelAdmin::Observer_ptr
ACE_ENV_ARG_DECL)
ACE_THROW_SPEC ((
CORBA::SystemException,
RtecEventChannelAdmin::EventChannel::SYNCHRONIZATION_ERROR,
RtecEventChannelAdmin::EventChannel::CANT_APPEND_OBSERVER))
= 0;
virtual void remove_observer (
RtecEventChannelAdmin::Observer_Handle
ACE_ENV_ARG_DECL)
ACE_THROW_SPEC ((
CORBA::SystemException,
RtecEventChannelAdmin::EventChannel::SYNCHRONIZATION_ERROR,
RtecEventChannelAdmin::EventChannel::CANT_REMOVE_OBSERVER))
= 0;
/// Used by the EC to inform the ObserverStrategy that a Consumer has
/// connected or disconnected from it.
virtual void connected (TAO_EC_ProxyPushConsumer*
ACE_ENV_ARG_DECL_NOT_USED) = 0;
virtual void disconnected (TAO_EC_ProxyPushConsumer*
ACE_ENV_ARG_DECL_NOT_USED) = 0;
/// Used by the EC to inform the ObserverStrategy that a Supplier has
/// connected or disconnected from it.
virtual void connected (TAO_EC_ProxyPushSupplier*
ACE_ENV_ARG_DECL_NOT_USED) = 0;
virtual void disconnected (TAO_EC_ProxyPushSupplier*
ACE_ENV_ARG_DECL_NOT_USED) = 0;
};
// ****************************************************************
/**
* @class TAO_EC_Null_ObserverStrategy
*
* @brief A null observer strategy.
*
* This class keeps no information and simply ignores the messages
* from the EC.
*/
class TAO_RTEvent_Serv_Export TAO_EC_Null_ObserverStrategy : public TAO_EC_ObserverStrategy
{
public:
/// Constructor
TAO_EC_Null_ObserverStrategy (void);
// = The TAO_EC_ObserverStrategy methods.
virtual RtecEventChannelAdmin::Observer_Handle
append_observer (RtecEventChannelAdmin::Observer_ptr
ACE_ENV_ARG_DECL)
ACE_THROW_SPEC ((
CORBA::SystemException,
RtecEventChannelAdmin::EventChannel::SYNCHRONIZATION_ERROR,
RtecEventChannelAdmin::EventChannel::CANT_APPEND_OBSERVER));
virtual void remove_observer (
RtecEventChannelAdmin::Observer_Handle
ACE_ENV_ARG_DECL)
ACE_THROW_SPEC ((
CORBA::SystemException,
RtecEventChannelAdmin::EventChannel::SYNCHRONIZATION_ERROR,
RtecEventChannelAdmin::EventChannel::CANT_REMOVE_OBSERVER));
virtual void connected (TAO_EC_ProxyPushConsumer*
ACE_ENV_ARG_DECL_NOT_USED);
virtual void disconnected (TAO_EC_ProxyPushConsumer*
ACE_ENV_ARG_DECL_NOT_USED);
virtual void connected (TAO_EC_ProxyPushSupplier*
ACE_ENV_ARG_DECL_NOT_USED);
virtual void disconnected (TAO_EC_ProxyPushSupplier*
ACE_ENV_ARG_DECL_NOT_USED);
};
// ****************************************************************
/**
* @class TAO_EC_Basic_ObserverStrategy
*
* @brief A simple observer strategy.
*
* This class simply keeps the information about the current list
* of observers, whenever the list of consumers and/or suppliers
* changes in queries the EC, computes the global subscription
* and/or publication list and sends the update message to all the
* observers.
*
* <H2>Memory Management</H2>
* It assumes ownership of the @a lock, but not of the
* Event_Channel.
*/
class TAO_RTEvent_Serv_Export TAO_EC_Basic_ObserverStrategy :
public TAO_EC_ObserverStrategy
{
public:
/// Constructor
TAO_EC_Basic_ObserverStrategy (TAO_EC_Event_Channel_Base* ec,
ACE_Lock* lock);
/// Destructor
virtual ~TAO_EC_Basic_ObserverStrategy (void);
// = The TAO_EC_ObserverStrategy methods.
virtual RtecEventChannelAdmin::Observer_Handle
append_observer (RtecEventChannelAdmin::Observer_ptr
ACE_ENV_ARG_DECL)
ACE_THROW_SPEC ((
CORBA::SystemException,
RtecEventChannelAdmin::EventChannel::SYNCHRONIZATION_ERROR,
RtecEventChannelAdmin::EventChannel::CANT_APPEND_OBSERVER));
virtual void remove_observer (
RtecEventChannelAdmin::Observer_Handle
ACE_ENV_ARG_DECL)
ACE_THROW_SPEC ((
CORBA::SystemException,
RtecEventChannelAdmin::EventChannel::SYNCHRONIZATION_ERROR,
RtecEventChannelAdmin::EventChannel::CANT_REMOVE_OBSERVER));
virtual void connected (TAO_EC_ProxyPushConsumer*
ACE_ENV_ARG_DECL_NOT_USED);
virtual void disconnected (TAO_EC_ProxyPushConsumer*
ACE_ENV_ARG_DECL_NOT_USED);
virtual void connected (TAO_EC_ProxyPushSupplier*
ACE_ENV_ARG_DECL_NOT_USED);
virtual void disconnected (TAO_EC_ProxyPushSupplier*
ACE_ENV_ARG_DECL_NOT_USED);
/**
* @struct Observer_Entry
*
* @brief The data kept for each observer.
*
* The observer and its handle are kept in a simple structure.
* In the future this structure could contain QoS information,
* such as:
* + how often do we update the observer?
* + When was the last update.
* + Does it want to receive all changes?
*/
struct Observer_Entry
{
Observer_Entry (void);
Observer_Entry (RtecEventChannelAdmin::Observer_Handle h,
RtecEventChannelAdmin::Observer_ptr o);
/// The handle
RtecEventChannelAdmin::Observer_Handle handle;
/// The observer
RtecEventChannelAdmin::Observer_var observer;
};
struct Header_Compare
{
int operator () (const RtecEventComm::EventHeader& lhs,
const RtecEventComm::EventHeader& rhs) const;
};
typedef ACE_Map_Manager<RtecEventChannelAdmin::Observer_Handle,Observer_Entry,ACE_Null_Mutex> Observer_Map;
typedef ACE_Map_Iterator<RtecEventChannelAdmin::Observer_Handle,Observer_Entry,ACE_Null_Mutex> Observer_Map_Iterator;
typedef ACE_RB_Tree<RtecEventComm::EventHeader,int,Header_Compare,ACE_Null_Mutex> Headers;
typedef ACE_RB_Tree_Iterator<RtecEventComm::EventHeader,int,Header_Compare,ACE_Null_Mutex> HeadersIterator;
protected:
/// Helpers.
//@{
/// Recompute EC consumer subscriptions and send them out to all observers.
virtual void consumer_qos_update (TAO_EC_ProxyPushSupplier *supplier
ACE_ENV_ARG_DECL);
/// Recompute EC supplier publications and send them out to all observers.
virtual void supplier_qos_update (TAO_EC_ProxyPushConsumer *consumer
ACE_ENV_ARG_DECL);
/// Compute consumer QOS.
void fill_qos (RtecEventChannelAdmin::ConsumerQOS &qos
ACE_ENV_ARG_DECL);
/// Compute supplier QOS.
void fill_qos (RtecEventChannelAdmin::SupplierQOS &qos
ACE_ENV_ARG_DECL);
/// Copies all current observers into an array and passes it
/// back to the caller through @a lst. Returns the size of the array.
int create_observer_list (RtecEventChannelAdmin::Observer_var *&lst
ACE_ENV_ARG_DECL);
//@}
protected:
/// The event channel.
TAO_EC_Event_Channel_Base* event_channel_;
/// The lock
ACE_Lock* lock_;
/// The handles are generated in sequential order, but are opaque to
/// the client.
RtecEventChannelAdmin::Observer_Handle handle_generator_;
/// Keep the set of Observers
Observer_Map observers_;
};
// ****************************************************************
/**
* @class TAO_EC_Reactive_ObserverStrategy
*
* @brief A reactive observer strategy.
*
* This class simply keeps the information about the current list
* of observers, whenever the list of consumers and/or suppliers
* changes in queries the EC, computes the global subscription
* and/or publication list and sends the update message to all the
* observers. When an observer isn't reachable it is removed from
* the observer list.
*
* <H2>Memory Management</H2>
* It assumes ownership of the <lock>, but not of the
* Event_Channel.
*/
class TAO_RTEvent_Serv_Export TAO_EC_Reactive_ObserverStrategy :
public TAO_EC_Basic_ObserverStrategy
{
public:
/// Constructor
TAO_EC_Reactive_ObserverStrategy (TAO_EC_Event_Channel_Base* ec,
ACE_Lock* lock);
/// Destructor
virtual ~TAO_EC_Reactive_ObserverStrategy (void);
protected:
/// Helpers.
//@{
/// Recompute EC consumer subscriptions and send them out to all observers.
virtual void consumer_qos_update (TAO_EC_ProxyPushSupplier *supplier
ACE_ENV_ARG_DECL);
/// Recompute EC supplier publications and send them out to all observers.
virtual void supplier_qos_update (TAO_EC_ProxyPushConsumer *consumer
ACE_ENV_ARG_DECL);
/**
* Copies all current observers into a map and passes it
* back to the caller through @a map.
* @return Returns the size of the map.
*/
int create_observer_map (Observer_Map &map
ACE_ENV_ARG_DECL);
/// The observer doesn't exist anymore
void observer_not_exists (Observer_Entry& observer
ACE_ENV_ARG_DECL);
//@}
};
// ****************************************************************
class TAO_EC_Accumulate_Supplier_Headers :
public TAO_ESF_Worker<TAO_EC_ProxyPushSupplier>
{
public:
/// Constructor
TAO_EC_Accumulate_Supplier_Headers (TAO_EC_Basic_ObserverStrategy::Headers &headers);
virtual void work (TAO_EC_ProxyPushSupplier *supplier
ACE_ENV_ARG_DECL);
private:
TAO_EC_Basic_ObserverStrategy::Headers &headers_;
};
// ****************************************************************
class TAO_EC_Accumulate_Consumer_Headers :
public TAO_ESF_Worker<TAO_EC_ProxyPushConsumer>
{
public:
/// Constructor
TAO_EC_Accumulate_Consumer_Headers (TAO_EC_Basic_ObserverStrategy::Headers &headers);
virtual void work (TAO_EC_ProxyPushConsumer *consumer
ACE_ENV_ARG_DECL);
private:
TAO_EC_Basic_ObserverStrategy::Headers &headers_;
};
TAO_END_VERSIONED_NAMESPACE_DECL
#if defined (__ACE_INLINE__)
#include "EC_ObserverStrategy.i"
#endif /* __ACE_INLINE__ */
#include /**/ "ace/post.h"
#endif /* TAO_EC_OBSERVERSTRATEGY_H */
|