summaryrefslogtreecommitdiff
path: root/apps/Orbix-Examples/Event_Comm/libsrc/Event_Comm.idl
blob: 26890129d70974e4a8a7a4f6dcb4fdf18ac0f941 (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
/* -*- C++ -*- */
// @(#)Event_Comm.idl	1.1	10/18/96


// ============================================================================
//
// = LIBRARY
//    EventComm
// 
// = FILENAME
//    Event_Comm.idl
//
// = DESCRIPTION 
//    The CORBA IDL module for distributed event notification. 
//
// = AUTHOR
//    Douglas C. Schmidt (schmidt@cs.wustl.edu)
// 
// ============================================================================

#ifndef _EVENT_COMM_IDL
#define _EVENT_COMM_IDL

module Event_Comm
  // = TITLE
  //   The CORBA IDL module for distributed event notification. 
  //
  // = DESCRIPTION
{
  struct Notification
    // = TITLE
    //   Defines the interface for an event <Notification>.
    //
    // = This is the type passed by the Notifier to the Notification_Receiver.
    //   Since it contains an <any>, it can hold any values.  Naturally,
    //   the consumer must understand how to interpret this!
  {
    string tag_;
    // Tag for the notification.

    // any value_;
    // A notification can contain anything.

//    Object object_ref_;
    // Object reference for callbacks.
  };

  interface Notification_Receiver
    // = TITLE
    //   Defines the interface for a <Notification_Receiver> of events.
    //   Note that all operations are <oneway> to avoid blocking.
    //
    // = DESCRIPTION
  {
    oneway void receive_notification (in Notification notification);
    // Inform the <Notification_Receiver> that <event> has occurred.

    oneway void disconnect (in string reason);
    // Disconnect the <Notification_Receiver> from the <Notifier>,
    // giving it the <reason>.
  };

  interface Notifier
    // = TITLE
    //   Defines the interface for a <Notifier> of events.
    //
    // = DESCRIPTION
  {
    oneway void send_disconnect (in string reason);
    // Disconnect all the receivers, giving them the <reason>.

    oneway void send_notification (in Notification notification);
    // Send the <Notification> to all the consumers who
    // have subscribed and who match the filtering criteria.

    oneway void subscribe (in Notification_Receiver notification_receiver,
			   in string filtering_criteria);
    // Subscribe the <Notification_Receiver> to receive events that
    // match the regular expresssion <filtering_criteria> applied by 
    // the <Notifier>.  If <filtering_criteria> is "" then all events 
    // are matched.

    oneway void unsubscribe (in Notification_Receiver notification_receiver,
			     in string filtering_criteria);
    // Unsubscribe the <Notification_Receiver> that matches the 
    // filtering criteria.  If <filtering_criteria> is "" then
    // all <Notification_Receivers> with the matching object reference
    // are removed.
  };
};

#endif /* _EVENT_COMM_IDL */