net.sf.beep4j.internal
Interface InternalChannel

All Superinterfaces:

Channel

public interface InternalChannel
extends Channel

Interface implemented by channels that contains methods only visible to the internal implementation.

Author:

Simon Raess

Method Summary

ChannelHandler	initChannel(ChannelHandler channelHandler) Initializes the channel and passes the channel handler in.
boolean	isAlive() Tests whether this channel is in the Alive state.
boolean	isDead() Tests whether this channel is in the Dead state.
boolean	isShuttingDown() Tests whether this channel is shutting down.

Methods inherited from interface net.sf.beep4j.Channel

close, createMessageBuilder, getProfile, getSession, sendMessage

Method Detail

initChannel

ChannelHandler initChannel(ChannelHandler channelHandler)

Initializes the channel and passes the channel handler in. The method can wrap the passed in channel handler to add additional responsibilities (Decorator pattern).

Parameters:

channelHandler - the ChannelHandler from the application

Returns:

the ChannelHandler to be used for that channel

isAlive

boolean isAlive()

Tests whether this channel is in the Alive state.

Returns:

true iff the channel is in the Alive state

isShuttingDown

boolean isShuttingDown()

Tests whether this channel is shutting down. This can be either caused by the application or the remote peer.

Returns:

true iff the channel is nor Alive nor Dead

isDead

boolean isDead()

Tests whether this channel is in the Dead state.

Returns:

true iff the channel is in the Dead state