Merge pull request #1551 from DOCGroup/plm_jira_333
[ACE_TAO.git] / TAO / orbsvcs / CosEvent_Service / README
blobac849bc6013881283cfe7b8c021f7e9bfffc4189
3                         CORBA COS Event Service
4                         -----------------------
6 The CosEvent_Service is a COS compliant Event Service.
8 The service is registered with the naming service with the name
9 "CosEventService" .  It exposes the <EventChannel> interface which can be
10 used by suppliers and consumers to send and receive events.
12 WARNING: In TAO 1.0.14 we introduced a new implementation of the COS
13 Event Service, this new implementation supports both the push and pull
14 models, and does not use the Real-time Event Service as its backend.
15 Both implementations are useful, for example, the native
16 implementation is more efficient and fully featured, but cannot
17 exploit the features in the RTEC, such as filtering and multicast
18 based federations.
20 To run the Event Channel:
21 ------------------------
22 1. you should have a running Naming Service.
23    if not, start one as:
24    $TAO_ROOT/orbsvcs/Naming_Service/Naming_Service -m 1
26 2. if you want to use the -t option you should have a running
27    Real Time Event Channel.
28    if not, start one at $TAO_ROOT/orbsvcs/Event_Service/Event_Service
30 3. execute the CosEvent_Service.
32 Command line parameters:
33 ------------------------
34        -n <COS Event Service name>
35         specifies the name with which to register the Event Service.
37        -r
38         specifies that a local Real Time Event Channel (Rtec) should be
39         created and used.
41         -t <Real Time Event Service name>
42         specifies the name with which to *look* for the RtEC.This option is
43         only useful along with the -r option.
45 The next 3 options are used to introduce a filtering mechanism for the
46 Event Channel based on event types and source ids.
48         -e ["EventType_1 EventType_2..."]
49         specifies the event types for the ConsumerQOS.When the Rtec is being
50         setup, the ConsumerQOS is specified.
51         The event types should start at  >= ACE_ES_EVENT_UNDEFINED = 16.
52         e.g. -e "17 20 40" specifies that event types with ids 17, 20 and 40
53         should be passed to the consumers.
55         -o ["EventSourceID_1 EventSourceID_2.."]
56         specifies the source ids for the ConsumerQOS.
58         -p ["sourceID EventTypeID"]
59         specifies a pair of sourceid and event type for the Supplier QOS.
62 Running the native COS Event Channel
63 ------------------------------------
65         The native implementation of the COS Event Channel is run
66 using:
68 $ CosEvent_Service_Native
70         on top of the regular -ORB arguments and the service
71 configurator parameters described in:
73 $TAO_ROOT/docs/cec_options.html
75         this implementation also understands the following arguments:
77         -n name         Use <name> when binding the object
78                         reference in the naming service
79         -r              Use rebind() to store the object
80                         reference in the naming service
81         -x              do not use the naming service
85    Note:
86    ====
87    By default, the Naming Service disables multicast discovery.
88    The "-m 1" option enables the Naming Service to be resolved via
89    multicast.
91    If you do not wish to do this, then use the
92    -ORBInitRef option in which case the Naming Service should be started
93    as:
95    $TAO_ROOT/orbsvcs/Naming_Service/Naming_Service -o naming.ior
97    and the CosEvent_Service as
99    $ CosEvent_Service_Native -ORBInitRef NameService=file://naming.ior
101 Author:
102 -------
103 Pradeep Gore <pradeep@cs.wustl.edu>