io.netty.channel

Class DefaultChannelPipeline

java.lang.Object

io.netty.channel.DefaultChannelPipeline

All Implemented Interfaces:

ChannelInboundInvoker, ChannelOutboundInvoker, ChannelPipeline

public class DefaultChannelPipeline
extends Object
implements ChannelPipeline

The default ChannelPipeline implementation. It is usually created by a Channel implementation when the Channel is created.

Constructor Summary

Constructors

Constructor and Description
DefaultChannelPipeline(Channel channel)

Method Summary

Methods

Modifier and Type	Method and Description
ChannelPipeline	addAfter(EventExecutorGroup group, String baseName, String name, ChannelHandler handler) Inserts a ChannelHandler after an existing handler of this pipeline.
ChannelPipeline	addAfter(String baseName, String name, ChannelHandler handler) Inserts a ChannelHandler after an existing handler of this pipeline.
ChannelPipeline	addBefore(EventExecutorGroup group, String baseName, String name, ChannelHandler handler) Inserts a ChannelHandler before an existing handler of this pipeline.
ChannelPipeline	addBefore(String baseName, String name, ChannelHandler handler) Inserts a ChannelHandler before an existing handler of this pipeline.
ChannelPipeline	addFirst(ChannelHandler... handlers)
ChannelPipeline	addFirst(EventExecutorGroup executor, ChannelHandler... handlers)
ChannelPipeline	addFirst(EventExecutorGroup group, String name, ChannelHandler handler) Inserts a ChannelHandler at the first position of this pipeline.
ChannelPipeline	addFirst(String name, ChannelHandler handler) Inserts a ChannelHandler at the first position of this pipeline.
ChannelPipeline	addLast(ChannelHandler... handlers)
ChannelPipeline	addLast(EventExecutorGroup executor, ChannelHandler... handlers)
ChannelPipeline	addLast(EventExecutorGroup group, String name, ChannelHandler handler) Appends a ChannelHandler at the last position of this pipeline.
ChannelPipeline	addLast(String name, ChannelHandler handler) Appends a ChannelHandler at the last position of this pipeline.
ChannelFuture	bind(SocketAddress localAddress)
ChannelFuture	bind(SocketAddress localAddress, ChannelFuture future)
Channel	channel() Returns the Channel that this pipeline is attached to.
ChannelFuture	close()
ChannelFuture	close(ChannelFuture future)
ChannelFuture	connect(SocketAddress remoteAddress)
ChannelFuture	connect(SocketAddress remoteAddress, ChannelFuture future)
ChannelFuture	connect(SocketAddress remoteAddress, SocketAddress localAddress)
ChannelFuture	connect(SocketAddress remoteAddress, SocketAddress localAddress, ChannelFuture future)
ChannelHandlerContext	context(ChannelHandler handler) Returns the context object of the specified ChannelHandler in this pipeline.
ChannelHandlerContext	context(Class<? extends ChannelHandler> handlerType) Returns the context object of the ChannelHandler of the specified type in this pipeline.
ChannelHandlerContext	context(String name) Returns the context object of the ChannelHandler with the specified name in this pipeline.
ChannelFuture	deregister()
ChannelFuture	deregister(ChannelFuture future)
ChannelFuture	disconnect()
ChannelFuture	disconnect(ChannelFuture future)
void	fireChannelActive()
void	fireChannelInactive()
void	fireChannelRegistered()
void	fireChannelUnregistered()
void	fireExceptionCaught(Throwable cause)
void	fireInboundBufferUpdated()
void	fireUserEventTriggered(Object event)
ChannelHandler	first() Returns the first ChannelHandler in this pipeline.
ChannelHandlerContext	firstContext() Returns the context of the first ChannelHandler in this pipeline.
ChannelFuture	flush()
ChannelFuture	flush(ChannelFuture future)
<T extends ChannelHandler> T	get(Class<T> handlerType) Returns the ChannelHandler of the specified type in this pipeline.
ChannelHandler	get(String name) Returns the ChannelHandler with the specified name in this pipeline.
io.netty.buffer.ByteBuf	inboundByteBuffer()
io.netty.buffer.MessageBuf<Object>	inboundMessageBuffer()
ChannelHandler	last() Returns the last ChannelHandler in this pipeline.
ChannelHandlerContext	lastContext() Returns the context of the last ChannelHandler in this pipeline.
List<String>	names() Returns the List of the handler names.
protected void	notifyHandlerException(Throwable cause)
io.netty.buffer.ByteBuf	outboundByteBuffer()
io.netty.buffer.MessageBuf<Object>	outboundMessageBuffer()
void	remove(ChannelHandler handler) Removes the specified ChannelHandler from this pipeline.
<T extends ChannelHandler> T	remove(Class<T> handlerType) Removes the ChannelHandler of the specified type from this pipeline
ChannelHandler	remove(String name) Removes the ChannelHandler with the specified name from this pipeline.
ChannelHandler	removeFirst() Removes the first ChannelHandler in this pipeline.
ChannelHandler	removeLast() Removes the last ChannelHandler in this pipeline.
void	replace(ChannelHandler oldHandler, String newName, ChannelHandler newHandler) Replaces the specified ChannelHandler with a new handler in this pipeline.
<T extends ChannelHandler> T	replace(Class<T> oldHandlerType, String newName, ChannelHandler newHandler) Replaces the ChannelHandler of the specified type with a new handler in this pipeline.
ChannelHandler	replace(String oldName, String newName, ChannelHandler newHandler) Replaces the ChannelHandler of the specified name with a new handler in this pipeline.
Map<String,ChannelHandler>	toMap() Converts this pipeline into an ordered Map whose keys are handler names and whose values are handlers.
String	toString() Returns the String representation of this pipeline.
ChannelFuture	write(Object message)
ChannelFuture	write(Object message, ChannelFuture future)

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultChannelPipeline

public DefaultChannelPipeline(Channel channel)

Method Detail

channel

public Channel channel()

Description copied from interface: ChannelPipeline

Returns the Channel that this pipeline is attached to.

Specified by:

channel in interface ChannelPipeline

Returns:

the channel. null if this pipeline is not attached yet.

addFirst

public ChannelPipeline addFirst(String name,
                       ChannelHandler handler)

Description copied from interface: ChannelPipeline

Inserts a ChannelHandler at the first position of this pipeline.

Specified by:

addFirst in interface ChannelPipeline

Parameters:

name - the name of the handler to insert first

handler - the handler to insert first

addFirst

public ChannelPipeline addFirst(EventExecutorGroup group,
                       String name,
                       ChannelHandler handler)

Description copied from interface: ChannelPipeline

Inserts a ChannelHandler at the first position of this pipeline.

Specified by:

addFirst in interface ChannelPipeline

name - the name of the handler to insert first

handler - the handler to insert first

addLast

public ChannelPipeline addLast(String name,
                      ChannelHandler handler)

Description copied from interface: ChannelPipeline

Appends a ChannelHandler at the last position of this pipeline.

Specified by:

addLast in interface ChannelPipeline

Parameters:

name - the name of the handler to append

handler - the handler to append

addLast

public ChannelPipeline addLast(EventExecutorGroup group,
                      String name,
                      ChannelHandler handler)

Description copied from interface: ChannelPipeline

Appends a ChannelHandler at the last position of this pipeline.

Specified by:

addLast in interface ChannelPipeline

name - the name of the handler to append

handler - the handler to append

addBefore

public ChannelPipeline addBefore(String baseName,
                        String name,
                        ChannelHandler handler)

Description copied from interface: ChannelPipeline

Inserts a ChannelHandler before an existing handler of this pipeline.

Specified by:

addBefore in interface ChannelPipeline

Parameters:

baseName - the name of the existing handler

name - the name of the handler to insert before

handler - the handler to insert before

addBefore

public ChannelPipeline addBefore(EventExecutorGroup group,
                        String baseName,
                        String name,
                        ChannelHandler handler)

Description copied from interface: ChannelPipeline

Inserts a ChannelHandler before an existing handler of this pipeline.

Specified by:

addBefore in interface ChannelPipeline

baseName - the name of the existing handler

name - the name of the handler to insert before

handler - the handler to insert before

addAfter

public ChannelPipeline addAfter(String baseName,
                       String name,
                       ChannelHandler handler)

Description copied from interface: ChannelPipeline

Inserts a ChannelHandler after an existing handler of this pipeline.

Specified by:

addAfter in interface ChannelPipeline

Parameters:

baseName - the name of the existing handler

name - the name of the handler to insert after

handler - the handler to insert after

addAfter

public ChannelPipeline addAfter(EventExecutorGroup group,
                       String baseName,
                       String name,
                       ChannelHandler handler)

Description copied from interface: ChannelPipeline

Inserts a ChannelHandler after an existing handler of this pipeline.

Specified by:

addAfter in interface ChannelPipeline

baseName - the name of the existing handler

name - the name of the handler to insert after

handler - the handler to insert after

addFirst

public ChannelPipeline addFirst(ChannelHandler... handlers)

Specified by:

addFirst in interface ChannelPipeline

addFirst

public ChannelPipeline addFirst(EventExecutorGroup executor,
                       ChannelHandler... handlers)

Specified by:

addFirst in interface ChannelPipeline

addLast

public ChannelPipeline addLast(ChannelHandler... handlers)

Specified by:

addLast in interface ChannelPipeline

addLast

public ChannelPipeline addLast(EventExecutorGroup executor,
                      ChannelHandler... handlers)

Specified by:

addLast in interface ChannelPipeline

remove

public void remove(ChannelHandler handler)

Description copied from interface: ChannelPipeline

Removes the specified ChannelHandler from this pipeline.

Specified by:

remove in interface ChannelPipeline

remove

public ChannelHandler remove(String name)

Description copied from interface: ChannelPipeline

Removes the ChannelHandler with the specified name from this pipeline.

Specified by:

remove in interface ChannelPipeline

Returns:

the removed handler

remove

public <T extends ChannelHandler> T remove(Class<T> handlerType)

Description copied from interface: ChannelPipeline

Removes the ChannelHandler of the specified type from this pipeline

Specified by:

remove in interface ChannelPipeline

Type Parameters:

T - the type of the handler

Parameters:

handlerType - the type of the handler

Returns:

the removed handler

removeFirst

public ChannelHandler removeFirst()

Description copied from interface: ChannelPipeline

Removes the first ChannelHandler in this pipeline.

Specified by:

removeFirst in interface ChannelPipeline

Returns:

the removed handler

removeLast

public ChannelHandler removeLast()

Description copied from interface: ChannelPipeline

Removes the last ChannelHandler in this pipeline.

Specified by:

removeLast in interface ChannelPipeline

Returns:

the removed handler

replace

public void replace(ChannelHandler oldHandler,
           String newName,
           ChannelHandler newHandler)

Description copied from interface: ChannelPipeline

Replaces the specified ChannelHandler with a new handler in this pipeline.

Specified by:

replace in interface ChannelPipeline

replace

public ChannelHandler replace(String oldName,
                     String newName,
                     ChannelHandler newHandler)

Description copied from interface: ChannelPipeline

Replaces the ChannelHandler of the specified name with a new handler in this pipeline.

Specified by:

replace in interface ChannelPipeline

Returns:

the removed handler

replace

public <T extends ChannelHandler> T replace(Class<T> oldHandlerType,
                                   String newName,
                                   ChannelHandler newHandler)

Description copied from interface: ChannelPipeline

Replaces the ChannelHandler of the specified type with a new handler in this pipeline.

Specified by:

replace in interface ChannelPipeline

Returns:

the removed handler

first

public ChannelHandler first()

Description copied from interface: ChannelPipeline

Returns the first ChannelHandler in this pipeline.

Specified by:

first in interface ChannelPipeline

Returns:

the first handler. null if this pipeline is empty.

firstContext

public ChannelHandlerContext firstContext()

Description copied from interface: ChannelPipeline

Returns the context of the first ChannelHandler in this pipeline.

Specified by:

firstContext in interface ChannelPipeline

Returns:

the context of the first handler. null if this pipeline is empty.

last

public ChannelHandler last()

Description copied from interface: ChannelPipeline

Returns the last ChannelHandler in this pipeline.

Specified by:

last in interface ChannelPipeline

Returns:

the last handler. null if this pipeline is empty.

lastContext

public ChannelHandlerContext lastContext()

Description copied from interface: ChannelPipeline

Returns the context of the last ChannelHandler in this pipeline.

Specified by:

lastContext in interface ChannelPipeline

Returns:

the context of the last handler. null if this pipeline is empty.

get

public ChannelHandler get(String name)

Description copied from interface: ChannelPipeline

Returns the ChannelHandler with the specified name in this pipeline.

Specified by:

get in interface ChannelPipeline

Returns:

the handler with the specified name. null if there's no such handler in this pipeline.

get

public <T extends ChannelHandler> T get(Class<T> handlerType)

Description copied from interface: ChannelPipeline

Returns the ChannelHandler of the specified type in this pipeline.

Specified by:

get in interface ChannelPipeline

Returns:

the handler of the specified handler type. null if there's no such handler in this pipeline.

context

public ChannelHandlerContext context(String name)

Description copied from interface: ChannelPipeline

Returns the context object of the ChannelHandler with the specified name in this pipeline.

Specified by:

context in interface ChannelPipeline

Returns:

the context object of the handler with the specified name. null if there's no such handler in this pipeline.

context

public ChannelHandlerContext context(ChannelHandler handler)

Description copied from interface: ChannelPipeline

Returns the context object of the specified ChannelHandler in this pipeline.

Specified by:

context in interface ChannelPipeline

Returns:

the context object of the specified handler. null if there's no such handler in this pipeline.

context

public ChannelHandlerContext context(Class<? extends ChannelHandler> handlerType)

Description copied from interface: ChannelPipeline

Returns the context object of the ChannelHandler of the specified type in this pipeline.

Specified by:

context in interface ChannelPipeline

Returns:

the context object of the handler of the specified type. null if there's no such handler in this pipeline.

names

public List<String> names()

Description copied from interface: ChannelPipeline

Returns the List of the handler names.

Specified by:

names in interface ChannelPipeline

toMap

public Map<String,ChannelHandler> toMap()

Description copied from interface: ChannelPipeline

Converts this pipeline into an ordered Map whose keys are handler names and whose values are handlers.

Specified by:

toMap in interface ChannelPipeline

toString

public String toString()

Returns the String representation of this pipeline.

Overrides:

toString in class Object

inboundMessageBuffer

public io.netty.buffer.MessageBuf<Object> inboundMessageBuffer()

Specified by:

inboundMessageBuffer in interface ChannelPipeline

inboundByteBuffer

public io.netty.buffer.ByteBuf inboundByteBuffer()

Specified by:

inboundByteBuffer in interface ChannelPipeline

outboundMessageBuffer

public io.netty.buffer.MessageBuf<Object> outboundMessageBuffer()

Specified by:

outboundMessageBuffer in interface ChannelPipeline

outboundByteBuffer

public io.netty.buffer.ByteBuf outboundByteBuffer()

Specified by:

outboundByteBuffer in interface ChannelPipeline

fireChannelRegistered

public void fireChannelRegistered()

Specified by:

fireChannelRegistered in interface ChannelInboundInvoker

fireChannelUnregistered

public void fireChannelUnregistered()

Specified by:

fireChannelUnregistered in interface ChannelInboundInvoker

fireChannelActive

public void fireChannelActive()

Specified by:

fireChannelActive in interface ChannelInboundInvoker

fireChannelInactive

public void fireChannelInactive()

Specified by:

fireChannelInactive in interface ChannelInboundInvoker

fireExceptionCaught

public void fireExceptionCaught(Throwable cause)

Specified by:

fireExceptionCaught in interface ChannelInboundInvoker

fireUserEventTriggered

public void fireUserEventTriggered(Object event)

Specified by:

fireUserEventTriggered in interface ChannelInboundInvoker

fireInboundBufferUpdated

public void fireInboundBufferUpdated()

Specified by:

fireInboundBufferUpdated in interface ChannelInboundInvoker

bind

public ChannelFuture bind(SocketAddress localAddress)

Specified by:

bind in interface ChannelOutboundInvoker

connect

public ChannelFuture connect(SocketAddress remoteAddress)

Specified by:

connect in interface ChannelOutboundInvoker

connect

public ChannelFuture connect(SocketAddress remoteAddress,
                    SocketAddress localAddress)

Specified by:

connect in interface ChannelOutboundInvoker

disconnect

public ChannelFuture disconnect()

Specified by:

disconnect in interface ChannelOutboundInvoker

close

public ChannelFuture close()

Specified by:

close in interface ChannelOutboundInvoker

deregister

public ChannelFuture deregister()

Specified by:

deregister in interface ChannelOutboundInvoker

flush

public ChannelFuture flush()

Specified by:

flush in interface ChannelOutboundInvoker

write

public ChannelFuture write(Object message)

Specified by:

write in interface ChannelOutboundInvoker

bind

public ChannelFuture bind(SocketAddress localAddress,
                 ChannelFuture future)

Specified by:

bind in interface ChannelOutboundInvoker

connect

public ChannelFuture connect(SocketAddress remoteAddress,
                    ChannelFuture future)

Specified by:

connect in interface ChannelOutboundInvoker

connect

public ChannelFuture connect(SocketAddress remoteAddress,
                    SocketAddress localAddress,
                    ChannelFuture future)

Specified by:

connect in interface ChannelOutboundInvoker

disconnect

public ChannelFuture disconnect(ChannelFuture future)

Specified by:

disconnect in interface ChannelOutboundInvoker

close

public ChannelFuture close(ChannelFuture future)

Specified by:

close in interface ChannelOutboundInvoker

deregister

public ChannelFuture deregister(ChannelFuture future)

Specified by:

deregister in interface ChannelOutboundInvoker

flush

public ChannelFuture flush(ChannelFuture future)

Specified by:

flush in interface ChannelOutboundInvoker

write

public ChannelFuture write(Object message,
                  ChannelFuture future)

Specified by:

write in interface ChannelOutboundInvoker

notifyHandlerException

protected void notifyHandlerException(Throwable cause)