All Packages  Class Hierarchy  This Package  Previous  Next  Index

Interface edu.cmu.owl.so.notification.EventChannel

public interface interface EventChannel
This interface represents the event channel interface. Through this interface It is through this interface that all clients to the subsystem will talk to the subsystem

Version:
1.0

Method Index

o addPullConsumer()
This method adds a pull consumer to the channel
o addPullProducer(PullProducerHandle)
This method adds a pull producer to this channel
o addPushConsumer(PushConsumerHandle)
This method adds a push producer to this channel.
o addPushProducer()
This method adds a push producer to the channel
o getChannelName()
This method returns the channel name
o getNPullConsumers()
This method returns the number of pull consumers in the channel
o getNPullProducers()
This method returns the number of pull producers in the channel
o getNPushConsumers()
This method returns the number of push consumers in the channel
o getNPushProducers()
This method returns the number of push producers in the channel
o ping()
This method is used for testing purposes

Methods

o getChannelName 
 public abstract String getChannelName() throws RemoteException
This method returns the channel name

Returns:
the name of this channel
Throws: RemoteException
if anything went wrong in the communication
o getNPushProducers 
 public abstract int getNPushProducers() throws RemoteException
This method returns the number of push producers in the channel

Returns:
the number of push producers in the channel
Throws: RemoteException
if anything went wrong in the communication
o getNPushConsumers 
 public abstract int getNPushConsumers() throws RemoteException
This method returns the number of push consumers in the channel

Returns:
the number of push consumers in the channel
Throws: RemoteException
if anything went wrong in the communication
o getNPullProducers 
 public abstract int getNPullProducers() throws RemoteException
This method returns the number of pull producers in the channel

Returns:
the number of pull producers in the channel
Throws: RemoteException
if anything went wrong in the communication
o getNPullConsumers 
 public abstract int getNPullConsumers() throws RemoteException
This method returns the number of pull consumers in the channel

Returns:
the number of pull consumers in the channel
Throws: RemoteException
if anything went wrong in the communication
o addPushConsumer 
 public abstract void addPushConsumer(PushConsumerHandle consumerHandle) throws RemoteException
This method adds a push producer to this channel.

Parameters:
consumerHandle - a remote object implemented by the consumer that the channel will use to notify it
Throws: RemoteException
if anything went wrong in the communication
o addPullProducer 
 public abstract void addPullProducer(PullProducerHandle producerHandle) throws RemoteException
This method adds a pull producer to this channel

Parameters:
producerHandle - a remote object implemented by the producer that the channel will use to contact for "pulling" events
Throws: RemoteException
if anything went wrong in the communication
o addPushProducer 
 public abstract PushProducerHandle addPushProducer() throws RemoteException
This method adds a push producer to the channel

Returns:
a remote object implemented by the Notification System that will be used by the producer to "push" events
Throws: RemoteException
if anything went wrong in the communication
o addPullConsumer 
 public abstract PullConsumerHandle addPullConsumer() throws RemoteException
This method adds a pull consumer to the channel

Returns:
a remote object implemented by the Notification System that will be used by the consumer to "pull" for events
Throws: RemoteException
if anything went wrong in the communication
o ping 
 public abstract void ping() throws RemoteException
This method is used for testing purposes

Throws: RemoteException
if anything went wrong in the communication 
All Packages  Class Hierarchy  This Package  Previous  Next  Index