gr.uoa.di.madgik.commons.channel.nozzle

Class ChannelOutlet

java.lang.Object

gr.uoa.di.madgik.commons.channel.nozzle.ChannelOutlet

All Implemented Interfaces:

Observer

public class ChannelOutlet
extends Object
implements Observer

This class represents one of the channel's nozzles. Each channel can have two types of nozzles. One that initiates the channel, publishes an IChannelLocator for it and acts a the central synchronization point which is the ChannelInlet, and the other receives an IChannelLocator to a previously created channel and can receive events emitted through it and can in turn emit events itself.

Author:

gpapanikos

Constructor Summary

Constructors

Constructor and Description
ChannelOutlet(IChannelLocator Locator) Instantiates a new channel outlet.

Method Summary

Methods

Modifier and Type	Method and Description
void	Dispose() Disposed the nozzle and all associated state.
IChannelLocator	GetLocator() Retrieves the locator that can be used by other nozzles to connect to the channel
Collection<ChannelStateEvent>	GetNozzleEvents() The nozzle exposes a set of events that are published through the rest of the connected nozzles.
String	GetNozzleID() Gets the nozzle id.
void	Push(ChannelPayloadStateEvent Event) Emits the provided event to all connected nozzles.
void	update(Observable o, Object arg)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ChannelOutlet

public ChannelOutlet(IChannelLocator Locator)

Instantiates a new channel outlet. Creates an identifier for the nozzle through which it can be distinguished among the rest of the nozzles, creates a new IChannelProxy depending on the type of IChannelLocator provided and registers itself to receive notifications from the underlying ChannelState

Parameters:

Locator - the locator

Method Detail

update

public void update(Observable o,
          Object arg)

Specified by:

update in interface Observer

GetNozzleID

public String GetNozzleID()

Gets the nozzle id.

Returns:

the nozzle identifier

GetNozzleEvents

public Collection<ChannelStateEvent> GetNozzleEvents()

The nozzle exposes a set of events that are published through the rest of the connected nozzles. The events exposed through the nozzle are only the ones that the rest of the connected nozzles emitted and not the ones this nozzle emitted

Returns:

The events the client can register for notifications

Dispose

public void Dispose()

Disposed the nozzle and all associated state. The nozzle is unregistered from all events, then the ChannelState publishing events that the client is registering for is disposed through ChannelState.Dispose() and finally the underlying ChannelState that is used to synchronize all connected nozzles id disposed through a call to ChannelState.Dispose()

Push

public void Push(ChannelPayloadStateEvent Event)

Emits the provided event to all connected nozzles. In case a nozzle is not yet connected, there is no guarantee that after the nozzle is connected the previously emitted events will be delivered.

Parameters:

Event - the event to emit

GetLocator

public IChannelLocator GetLocator()

Retrieves the locator that can be used by other nozzles to connect to the channel

Returns:

the channel locator