Main Page   Packages   Class Hierarchy   Compound List   File List   Compound Members  

EventChannel Interface Reference

Inheritance diagram for EventChannel:

Inheritance graph
[legend]
Collaboration diagram for EventChannel:

Collaboration graph
[legend]
List of all members.

Public Methods

void addConsumer (Object consumer) throws JonathanException
void removeConsumer (Object consumer) throws JonathanException
Object getConsumerProxy () throws JonathanException

Detailed Description

An EventChannel is a service that decouples the communication of events between suppliers and consumers of events. It is an intervening object that allows multiple suppliers to communicate with multiple suppliers asynchronously. The event channel itself is both a supplier and consumer of events. This service only offers a push model of communication for both consumers and suppliers of events. Particular implementations of this service will provide specific guarantees in terms of reliability, ordering (and possibly timeliness) of the event communication.

Definition at line 45 of file EventChannel.java.


Member Function Documentation

void EventChannel::addConsumer ( Object consumer )
 

Add a new consumer to the event channel. The consumer object should be of type compatible with that of the event channel

Parameters:
consumer   the consumer object to add
Exceptions:
JonathanException   thrown if the consumer object cannot be added

Reimplemented in EventChannelImpl.

Referenced by NewsConsumer::main().

Object EventChannel::getConsumerProxy ( )
 

Returns a consumer proxy object which can be used by producer to supply events to the channel

Returns:
a consumer proxy for the EventChannel
Exceptions:
JonathanException   thrown if the operation fails

Reimplemented in EventChannelImpl.

void EventChannel::removeConsumer ( Object consumer )
 

Remove an existing consumer object from the event channel. The consumer object specified will no longer receive events from the event channel

Parameters:
consumer   the consumer object to remove
Exceptions:
JonathanException   thrown of the specified consumer object cannot be removed

Reimplemented in EventChannelImpl.


The documentation for this interface was generated from the following file:
Generated at Fri May 31 19:24:06 2002 for Jonathan by doxygen1.2.6 written by Dimitri van Heesch, © 1997-2001