org.jboss.netty.channel

Class DefaultChannelPipeline.DefaultChannelHandlerContext

java.lang.Object

org.jboss.netty.channel.DefaultChannelPipeline.DefaultChannelHandlerContext

All Implemented Interfaces:

ChannelHandlerContext

Enclosing class:

DefaultChannelPipeline

private final class DefaultChannelPipeline.DefaultChannelHandlerContext
extends java.lang.Object
implements ChannelHandlerContext

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.Object	attachment
private boolean	canHandleDownstream
private boolean	canHandleUpstream
private ChannelHandler	handler
private java.lang.String	name
(package private) DefaultChannelPipeline.DefaultChannelHandlerContext	next
(package private) DefaultChannelPipeline.DefaultChannelHandlerContext	prev

Constructor Summary

Constructors

Constructor and Description
DefaultChannelHandlerContext(DefaultChannelPipeline.DefaultChannelHandlerContext prev, DefaultChannelPipeline.DefaultChannelHandlerContext next, java.lang.String name, ChannelHandler handler)

Method Summary

Modifier and Type	Method and Description
boolean	canHandleDownstream() Returns true if and only if the ChannelHandler is an instance of ChannelDownstreamHandler.
boolean	canHandleUpstream() Returns true if and only if the ChannelHandler is an instance of ChannelUpstreamHandler.
java.lang.Object	getAttachment() Retrieves an object which is attached to this context.
Channel	getChannel() Returns the Channel that the ChannelPipeline belongs to.
ChannelHandler	getHandler() Returns the ChannelHandler that this context object is serving.
java.lang.String	getName() Returns the name of the ChannelHandler in the ChannelPipeline.
ChannelPipeline	getPipeline() Returns the ChannelPipeline that the ChannelHandler belongs to.
void	sendDownstream(ChannelEvent e) Sends the specified ChannelEvent to the ChannelDownstreamHandler which is placed in the closest downstream from the handler associated with this context.
void	sendUpstream(ChannelEvent e) Sends the specified ChannelEvent to the ChannelUpstreamHandler which is placed in the closest upstream from the handler associated with this context.
void	setAttachment(java.lang.Object attachment) Attaches an object to this context to store a stateful information specific to the ChannelHandler which is associated with this context.

Methods inherited from class java.lang.Object

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

Field Detail

next

volatile DefaultChannelPipeline.DefaultChannelHandlerContext next

prev

volatile DefaultChannelPipeline.DefaultChannelHandlerContext prev

name

private final java.lang.String name

handler

private final ChannelHandler handler

canHandleUpstream

private final boolean canHandleUpstream

canHandleDownstream

private final boolean canHandleDownstream

attachment

private volatile java.lang.Object attachment

Constructor Detail

DefaultChannelHandlerContext

DefaultChannelHandlerContext(DefaultChannelPipeline.DefaultChannelHandlerContext prev,
                             DefaultChannelPipeline.DefaultChannelHandlerContext next,
                             java.lang.String name,
                             ChannelHandler handler)

Method Detail

getChannel

public Channel getChannel()

Description copied from interface: ChannelHandlerContext

Returns the Channel that the ChannelPipeline belongs to. This method is a shortcut to getPipeline().getChannel().

Specified by:

getChannel in interface ChannelHandlerContext

getPipeline

public ChannelPipeline getPipeline()

Description copied from interface: ChannelHandlerContext

Returns the ChannelPipeline that the ChannelHandler belongs to.

Specified by:

getPipeline in interface ChannelHandlerContext

canHandleDownstream

public boolean canHandleDownstream()

Description copied from interface: ChannelHandlerContext

Returns true if and only if the ChannelHandler is an instance of ChannelDownstreamHandler.

Specified by:

canHandleDownstream in interface ChannelHandlerContext

canHandleUpstream

public boolean canHandleUpstream()

Description copied from interface: ChannelHandlerContext

Returns true if and only if the ChannelHandler is an instance of ChannelUpstreamHandler.

Specified by:

canHandleUpstream in interface ChannelHandlerContext

getHandler

public ChannelHandler getHandler()

Description copied from interface: ChannelHandlerContext

Returns the ChannelHandler that this context object is serving.

Specified by:

getHandler in interface ChannelHandlerContext

getName

public java.lang.String getName()

Description copied from interface: ChannelHandlerContext

Returns the name of the ChannelHandler in the ChannelPipeline.

Specified by:

getName in interface ChannelHandlerContext

getAttachment

public java.lang.Object getAttachment()

Description copied from interface: ChannelHandlerContext

Retrieves an object which is attached to this context.

Specified by:

getAttachment in interface ChannelHandlerContext

Returns:

null if no object was attached or null was attached

setAttachment

public void setAttachment(java.lang.Object attachment)

Description copied from interface: ChannelHandlerContext

Attaches an object to this context to store a stateful information specific to the ChannelHandler which is associated with this context.

Specified by:

setAttachment in interface ChannelHandlerContext

sendDownstream

public void sendDownstream(ChannelEvent e)

Description copied from interface: ChannelHandlerContext

Sends the specified ChannelEvent to the ChannelDownstreamHandler which is placed in the closest downstream from the handler associated with this context. It is recommended to use the shortcut methods in Channels rather than calling this method directly.

Specified by:

sendDownstream in interface ChannelHandlerContext

sendUpstream

public void sendUpstream(ChannelEvent e)

Description copied from interface: ChannelHandlerContext

Sends the specified ChannelEvent to the ChannelUpstreamHandler which is placed in the closest upstream from the handler associated with this context. It is recommended to use the shortcut methods in Channels rather than calling this method directly.

Specified by:

sendUpstream in interface ChannelHandlerContext