summaryrefslogtreecommitdiff
path: root/TAO/orbsvcs/orbsvcs/CosEventComm.idl
blob: f478880176d2791942d986052751dcb7e2065604 (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
//
// $Id$
//

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

  exception Disconnected{};
  // 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.
 };
};