fulmine.distribution.channel
Class ChannelReadyEvent

java.lang.Object
  fulmine.event.AbstractEvent
      fulmine.event.system.AbstractSystemEvent
          fulmine.distribution.channel.ChannelReadyEvent

All Implemented Interfaces:

IEvent, ISystemEvent, IAddressable, IDescriptor, Cloneable

public class ChannelReadyEvent
extends AbstractSystemEvent

Raised when an IChannel is ready - this means the channel can now be used. A channel can exist but not ready for use; only when it has synchronised readiness with the peer channel can it be considered available for use.

Author:

Ramon Servadei

Constructor Summary

ChannelReadyEvent(IEventManager context, IChannel channel)
Standard constructor

Method Summary

protected String	getAdditionalToString() Delegate method for subclasses to provide additional toString information.
IChannel	getChannel() Get the channel that has become ready

Methods inherited from class fulmine.event.system.AbstractSystemEvent

hideSourceFromToString

Methods inherited from class fulmine.event.AbstractEvent

clone, equals, getAddress, getDomain, getDrivingFrame, getFrame, getIdentity, getSource, getTriggerEvent, getType, hashCode, setAddress, setDrivingFrame, setFrame, setSource, setTriggerEvent, toDetailedString, toIdentityString, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface fulmine.event.IEvent

clone, getDrivingFrame, getFrame, getSource, getTriggerEvent, setTriggerEvent

Methods inherited from interface fulmine.IDescriptor

toDetailedString, toIdentityString

Methods inherited from interface fulmine.IAddressable

getAddress, getDomain, getIdentity, getType

Constructor Detail

ChannelReadyEvent

public ChannelReadyEvent(IEventManager context,
                         IChannel channel)

Standard constructor

Parameters:

context - the context for event operations

channel - the channel that has been created

Method Detail

getChannel

public IChannel getChannel()

Get the channel that has become ready

Returns:

the IChannel encapsulated by this event

getAdditionalToString

protected String getAdditionalToString()

Description copied from class: AbstractEvent

Delegate method for subclasses to provide additional toString information. This should be a comma separated string, e.g. "one, two, three"

Overrides:

getAdditionalToString in class AbstractSystemEvent

Returns:

the additional toString information in comma separated format