summaryrefslogtreecommitdiff
path: root/TAO/orbsvcs/orbsvcs/CosEventComm.idl
blob: 69ce506fbadd1c43951f37c382dd58869dda2f86 (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
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
// $Id$

// ============================================================================
//
// = LIBRARY
//    orbsvcs
//
// = FILENAME
//    CosEventComm.idl
//
// = DESCRIPTION
//    EVENT SERVICE - described in CORBAservices: Common Object Services
//    Specification, chapter 4.
//    CosEventComm Module, page 4-8 includes the following interfaces:
//    PushConsumer, PushSupplier, PullSupplier, PullConsumer
//    The Event service description can be downloaded from
//    ftp://www.omg.org/pub/docs/formal/97-11-02.idl
//
// = AUTHOR
//    Pradeep Gore <pradeep@cs.wustl.edu>
//
// ============================================================================

#ifndef TAO_EVENTCOMM_IDL
#define TAO_EVENTCOMM_IDL

#pragma prefix "omg.org"

module CosEventComm
{
  // = TITLE
  //   IDL module for the Corba Object Service for Event
  //   Communication.

  exception Disconnected
    {
      // = TITLE
      // If the event communication has already been disconnected, the
      // Disconnected exception is raised.
    };

  interface PushConsumer
    {
      // = TITLE
      //   definition of the PushConsumer.
      //
      // = DESCRIPTION
      //   A push-style consumer supports the PushConsumer interface to
      //   receive event data.

      void push (in any data) raises (Disconnected);
      // A supplier communicates event data to the consumer by invoking
      // the push operation and passing the event data as a parameter.
      // If the event communication has already been disconnected, the
      // Disconnected exception is raised.

      void disconnect_push_consumer ();
      // The disconnect_push_consumer operation terminates the event
      // communication; it releases resources used at the consumer to
      // support the event communication.  The PushConsumer object
      // reference is disposed.
    };

  interface PushSupplier
    {
      // = TITLE
      //   Definition of the PushSupplier.
      //
      // = DESCRIPTION
      //   A push-style supplier supports the PushSupplier interface.

      void disconnect_push_supplier ();
      // The disconnect_push_supplier operation terminates the event
      // communication; it releases resources used at the supplier to
      // support the event communication.  The PushSupplier object
      // reference is disposed.
    };

  interface PullSupplier
    {
      // = TITLE
      //   Definition of the PullSupplier.
      //
      // = DESCRIPTION
      //   A pull-style supplier supports the PullSupplier interface to
      //   transmit event data.

      any pull () raises (Disconnected);
      // The pull operation blocks until the event data is available or
      // an exception is raised. It returns the event data to the
      // consumer.  If the event communication has already been
      // disconnected, the Disconnected exception is raised.

      any try_pull (out boolean has_event) raises (Disconnected);
      // The try_pull operation does not block: if the event data is
      // available, it returns the event data and sets the has_event
      // parameter to true; if the event is not available, it sets the
      // has_event parameter to false and the event data is returned as
      // long with an undefined value.  If the event communication has
      // already been disconnected, the Disconnected exception is
      // raised.

      void disconnect_pull_supplier ();
      // The disconnect_pull_supplier operation terminates the event
      // communication; it releases resources used at the supplier to
      // support the event communication.  The PullSupplier object
      // reference is disposed.
    };

  interface PullConsumer
    {
      // = TITLE
      //   Definition of the PullConsumer.
      //
      // = DESCRIPTION
      //   A pull-style consumer supports the PullConsumer interface.

      void disconnect_pull_consumer ();
      // The disconnect_pull_consumer operation terminates the event
      // communication; it releases resources used at the consumer to
      // support the event communication. The PullConsumer object
      // reference is disposed.
    };
};

#endif /* TAO_EVENTCOMM_IDL */