summaryrefslogtreecommitdiff
path: root/TAO/CIAO/examples/handcrafted/BasicSP_EC2/BasicSP.idl
blob: 8cbdc2967bc0b174ff68bcba852bad178900ae88 (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
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
// $Id$
//=============================================================================
/**
 * @file BasicSP.idl
 *
 * Definition of events, and common interfaces used in the BasicSP module.
 *
 * @author Balachandran Natarajan <bala@dre.vanderbilt.edu>
 */
//=============================================================================

#ifndef CIAO_BASIC_SP_IDL
#define CIAO_BASIC_SP_IDL

#include <Components.idl>
#include <RtecEventChannelAdmin.idl>

// @@NOTE: Do we need a pragma prefix. Anyway its broken now in TAO..
// #pragma prefix ""


module BasicSP
{

  /**
   * @NOTE: Not sure whether this is a good abstraction. Just copying
   *  the stuff from Cadena folks.
   */
  /**
   * @interface ReadData
   *
   */

  interface ReadData {
    string get_data ();
  };

  /**
   * @eventtype Events that represent timeouts
   */
  eventtype TimeOut {};

  /**
   * @eventtype Events that represent data availability
   */
  eventtype DataAvailable {};

};

/*module TimeBase
{
  typedef unsigned long long TimeT;
};


typedef sequence<octet> EventPayload;

struct RtecEventData
{
  long pad1;

  EventPayload payload;

  any any_value;
};

module RtecEventComm
{

  typedef RtecEventData EventData;

  typedef TimeBase::TimeT Time;

  typedef long EventSourceID;

  typedef long _EventType;

  struct EventHeader
  {
    _EventType type;

    EventSourceID source;

    long ttl;

    Time creation_time;

    Time ec_recv_time;

    Time ec_send_time;
  };

  struct Event
  {
    EventHeader header;

    EventData data;
  };

  typedef sequence<Event> EventSet;

  interface PushConsumer
  {
    oneway void push (in EventSet data);

    void disconnect_push_consumer ();
  };

  interface PushSupplier
  {
    void disconnect_push_supplier ();
  };

};

module RtecBase
{

  enum Dependency_Type_t
  {
    ONE_WAY_CALL,
    TWO_WAY_CALL
  };

  typedef long handle_t;

  struct Dependency_Info
  {
    Dependency_Type_t dependency_type;

    long number_of_calls;

    handle_t rt_info;
  };

};

module RtecEventChannelAdmin
{
  exception AlreadyConnected {};

  exception TypeError {};

  struct Dependency
  {
    RtecEventComm::Event event;

    RtecBase::handle_t rt_info;
  };

  typedef sequence<Dependency> DependencySet;

  struct Publication
  {
    RtecEventComm::Event event;

    RtecBase::Dependency_Info dependency_info;
  };

  typedef sequence<Publication> PublicationSet;

  struct ConsumerQOS
  {
    DependencySet dependencies;

    boolean is_gateway;
  };

  struct SupplierQOS
  {
    PublicationSet publications;

    boolean is_gateway;
  };

  interface ProxyPushConsumer : RtecEventComm::PushConsumer
  {
    void connect_push_supplier (in RtecEventComm::PushSupplier push_supplier,
                                in SupplierQOS qos)
      raises (AlreadyConnected);
  };

  interface ProxyPushSupplier : RtecEventComm::PushSupplier
  {
    void connect_push_consumer(in RtecEventComm::PushConsumer push_consumer,
                               in ConsumerQOS qos)
      raises(AlreadyConnected, TypeError);

    void suspend_connection ();

    void resume_connection ();

  };

  interface ConsumerAdmin
  {
    ProxyPushSupplier obtain_push_supplier ();
  };

  interface SupplierAdmin
  {
    ProxyPushConsumer obtain_push_consumer ();
  };

  interface Observer
  {
    void update_consumer (in ConsumerQOS sub);

    void update_supplier (in SupplierQOS pub);
  };

  typedef unsigned long Observer_Handle;

  interface EventChannel
  {

    exception SYNCHRONIZATION_ERROR {};

    exception CANT_APPEND_OBSERVER {};

    exception CANT_REMOVE_OBSERVER {};

    exception QOS_ERROR {};

    exception SUBSCRIPTION_ERROR {};

    exception CORRELATION_ERROR {};

    exception DISPATCH_ERROR {};

    ConsumerAdmin for_consumers ();

    SupplierAdmin for_suppliers ();

    void destroy ();

    Observer_Handle append_observer (in Observer gw)
       raises (SYNCHRONIZATION_ERROR,CANT_APPEND_OBSERVER);

    void remove_observer (in Observer_Handle gw)
       raises (SYNCHRONIZATION_ERROR,CANT_REMOVE_OBSERVER);
  };

};
*/

#endif /*CIAO_BASIC_SP_IDL*/