Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | File Members | Related Pages

alma::acs::nc::Receiver Interface Reference

Inheritance diagram for alma::acs::nc::Receiver:

Inheritance graph
[legend]
List of all members.

Public Member Functions

void attach (String eventTypeName, Object receiver)
void detach (String eventTypeName, Object receiver)
void begin ()
void end ()

Detailed Description

The Receiver interface allows one to attach and detach objects to a notification channel that receive events published on that channel. No events are actually processed until the "begin()" method is called. Likewise, the "end()" methods stops all events from being processed by those objects.

Version:
1.00 Apr 10, 2003
Author:
Allen Farris


Member Function Documentation

void alma::acs::nc::Receiver::attach String  eventTypeName,
Object  receiver
 

Attach an event receiver object to this notification channel. The receiver is required to have a public method called "receive(EventType)", that receives and processes the event. The EventType parameter in the method signature is the name of an IDL structure that defines the event.

Parameters:
eventTypeName The full path name of the event type that this receiver wishes to receive.
receiver An object that receives and processes this event. It must have a public method of the form "receive(EventType)", where the EventType parameter in the method signature is the name of an IDL structure that defines the event.

Implemented in alma::acs::nc::CorbaNotificationChannel, and alma::acs::nc::CorbaReceiver.

void alma::acs::nc::Receiver::begin  ) 
 

The begin() method must be called to initiate the process of receiving events. At this point the objects that have been attached begin receiving events. This method must be called or no events will be recieved.

Implemented in alma::acs::nc::CorbaNotificationChannel, and alma::acs::nc::CorbaReceiver.

void alma::acs::nc::Receiver::detach String  eventTypeName,
Object  receiver
 

Detach an eventType/Receiver from this notification channel. Only the specified event type is detached for the specified receiver.

Parameters:
eventTypeName The name of the event type that this receiver receives.
receiver The object that receives and processes this event.

Implemented in alma::acs::nc::CorbaNotificationChannel, and alma::acs::nc::CorbaReceiver.

void alma::acs::nc::Receiver::end  ) 
 

Stop all events from being processed by the attached Receiver objects. All objects that have been recieving events are removed and no further events are received.

Implemented in alma::acs::nc::CorbaNotificationChannel, and alma::acs::nc::CorbaReceiver.


The documentation for this interface was generated from the following file:
Generated on Thu Apr 30 02:54:30 2009 for ACS Java API by doxygen 1.3.8