ChannelPipeline (Netty API Reference (4.0.56.Final)) (original) (raw)
Modifier and Type
Method and Description
[ChannelPipeline](../../../io/netty/channel/ChannelPipeline.html "interface in io.netty.channel")
[addAfter](../../../io/netty/channel/ChannelPipeline.html#addAfter-io.netty.util.concurrent.EventExecutorGroup-java.lang.String-java.lang.String-io.netty.channel.ChannelHandler-)([EventExecutorGroup](../../../io/netty/util/concurrent/EventExecutorGroup.html "interface in io.netty.util.concurrent") group, java.lang.String baseName, java.lang.String name,[ChannelHandler](../../../io/netty/channel/ChannelHandler.html "interface in io.netty.channel") handler)
Inserts a ChannelHandler after an existing handler of this pipeline.
[ChannelPipeline](../../../io/netty/channel/ChannelPipeline.html "interface in io.netty.channel")
[addAfter](../../../io/netty/channel/ChannelPipeline.html#addAfter-java.lang.String-java.lang.String-io.netty.channel.ChannelHandler-)(java.lang.String baseName, java.lang.String name,[ChannelHandler](../../../io/netty/channel/ChannelHandler.html "interface in io.netty.channel") handler)
Inserts a ChannelHandler after an existing handler of this pipeline.
[ChannelPipeline](../../../io/netty/channel/ChannelPipeline.html "interface in io.netty.channel")
[addBefore](../../../io/netty/channel/ChannelPipeline.html#addBefore-io.netty.util.concurrent.EventExecutorGroup-java.lang.String-java.lang.String-io.netty.channel.ChannelHandler-)([EventExecutorGroup](../../../io/netty/util/concurrent/EventExecutorGroup.html "interface in io.netty.util.concurrent") group, java.lang.String baseName, java.lang.String name,[ChannelHandler](../../../io/netty/channel/ChannelHandler.html "interface in io.netty.channel") handler)
Inserts a ChannelHandler before an existing handler of this pipeline.
[ChannelPipeline](../../../io/netty/channel/ChannelPipeline.html "interface in io.netty.channel")
[addBefore](../../../io/netty/channel/ChannelPipeline.html#addBefore-java.lang.String-java.lang.String-io.netty.channel.ChannelHandler-)(java.lang.String baseName, java.lang.String name,[ChannelHandler](../../../io/netty/channel/ChannelHandler.html "interface in io.netty.channel") handler)
Inserts a ChannelHandler before an existing handler of this pipeline.
[ChannelPipeline](../../../io/netty/channel/ChannelPipeline.html "interface in io.netty.channel")
[addFirst](../../../io/netty/channel/ChannelPipeline.html#addFirst-io.netty.channel.ChannelHandler...-)([ChannelHandler](../../../io/netty/channel/ChannelHandler.html "interface in io.netty.channel")... handlers)
Inserts ChannelHandlers at the first position of this pipeline.
[ChannelPipeline](../../../io/netty/channel/ChannelPipeline.html "interface in io.netty.channel")
[addFirst](../../../io/netty/channel/ChannelPipeline.html#addFirst-io.netty.util.concurrent.EventExecutorGroup-io.netty.channel.ChannelHandler...-)([EventExecutorGroup](../../../io/netty/util/concurrent/EventExecutorGroup.html "interface in io.netty.util.concurrent") group,[ChannelHandler](../../../io/netty/channel/ChannelHandler.html "interface in io.netty.channel")... handlers)
Inserts ChannelHandlers at the first position of this pipeline.
[ChannelPipeline](../../../io/netty/channel/ChannelPipeline.html "interface in io.netty.channel")
[addFirst](../../../io/netty/channel/ChannelPipeline.html#addFirst-io.netty.util.concurrent.EventExecutorGroup-java.lang.String-io.netty.channel.ChannelHandler-)([EventExecutorGroup](../../../io/netty/util/concurrent/EventExecutorGroup.html "interface in io.netty.util.concurrent") group, java.lang.String name,[ChannelHandler](../../../io/netty/channel/ChannelHandler.html "interface in io.netty.channel") handler)
Inserts a ChannelHandler at the first position of this pipeline.
[ChannelPipeline](../../../io/netty/channel/ChannelPipeline.html "interface in io.netty.channel")
[addFirst](../../../io/netty/channel/ChannelPipeline.html#addFirst-java.lang.String-io.netty.channel.ChannelHandler-)(java.lang.String name,[ChannelHandler](../../../io/netty/channel/ChannelHandler.html "interface in io.netty.channel") handler)
Inserts a ChannelHandler at the first position of this pipeline.
[ChannelPipeline](../../../io/netty/channel/ChannelPipeline.html "interface in io.netty.channel")
[addLast](../../../io/netty/channel/ChannelPipeline.html#addLast-io.netty.channel.ChannelHandler...-)([ChannelHandler](../../../io/netty/channel/ChannelHandler.html "interface in io.netty.channel")... handlers)
Inserts ChannelHandlers at the last position of this pipeline.
[ChannelPipeline](../../../io/netty/channel/ChannelPipeline.html "interface in io.netty.channel")
[addLast](../../../io/netty/channel/ChannelPipeline.html#addLast-io.netty.util.concurrent.EventExecutorGroup-io.netty.channel.ChannelHandler...-)([EventExecutorGroup](../../../io/netty/util/concurrent/EventExecutorGroup.html "interface in io.netty.util.concurrent") group,[ChannelHandler](../../../io/netty/channel/ChannelHandler.html "interface in io.netty.channel")... handlers)
Inserts ChannelHandlers at the last position of this pipeline.
[ChannelPipeline](../../../io/netty/channel/ChannelPipeline.html "interface in io.netty.channel")
[addLast](../../../io/netty/channel/ChannelPipeline.html#addLast-io.netty.util.concurrent.EventExecutorGroup-java.lang.String-io.netty.channel.ChannelHandler-)([EventExecutorGroup](../../../io/netty/util/concurrent/EventExecutorGroup.html "interface in io.netty.util.concurrent") group, java.lang.String name,[ChannelHandler](../../../io/netty/channel/ChannelHandler.html "interface in io.netty.channel") handler)
Appends a ChannelHandler at the last position of this pipeline.
[ChannelPipeline](../../../io/netty/channel/ChannelPipeline.html "interface in io.netty.channel")
[addLast](../../../io/netty/channel/ChannelPipeline.html#addLast-java.lang.String-io.netty.channel.ChannelHandler-)(java.lang.String name,[ChannelHandler](../../../io/netty/channel/ChannelHandler.html "interface in io.netty.channel") handler)
Appends a ChannelHandler at the last position of this pipeline.
[ChannelFuture](../../../io/netty/channel/ChannelFuture.html "interface in io.netty.channel")
[bind](../../../io/netty/channel/ChannelPipeline.html#bind-java.net.SocketAddress-)(java.net.SocketAddress localAddress)
Request to bind to the given SocketAddress and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error.
[ChannelFuture](../../../io/netty/channel/ChannelFuture.html "interface in io.netty.channel")
[bind](../../../io/netty/channel/ChannelPipeline.html#bind-java.net.SocketAddress-io.netty.channel.ChannelPromise-)(java.net.SocketAddress localAddress,[ChannelPromise](../../../io/netty/channel/ChannelPromise.html "interface in io.netty.channel") promise)
Request to bind to the given SocketAddress and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error.
[Channel](../../../io/netty/channel/Channel.html "interface in io.netty.channel")
[channel](../../../io/netty/channel/ChannelPipeline.html#channel--)()
Returns the Channel that this pipeline is attached to.
[ChannelFuture](../../../io/netty/channel/ChannelFuture.html "interface in io.netty.channel")
[close](../../../io/netty/channel/ChannelPipeline.html#close--)()
Request to close the Channel and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error.
[ChannelFuture](../../../io/netty/channel/ChannelFuture.html "interface in io.netty.channel")
[close](../../../io/netty/channel/ChannelPipeline.html#close-io.netty.channel.ChannelPromise-)([ChannelPromise](../../../io/netty/channel/ChannelPromise.html "interface in io.netty.channel") promise)
Request to close the Channel bound to this ChannelPipeline and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error.
[ChannelFuture](../../../io/netty/channel/ChannelFuture.html "interface in io.netty.channel")
[connect](../../../io/netty/channel/ChannelPipeline.html#connect-java.net.SocketAddress-)(java.net.SocketAddress remoteAddress)
Request to connect to the given SocketAddress and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error.
[ChannelFuture](../../../io/netty/channel/ChannelFuture.html "interface in io.netty.channel")
[connect](../../../io/netty/channel/ChannelPipeline.html#connect-java.net.SocketAddress-io.netty.channel.ChannelPromise-)(java.net.SocketAddress remoteAddress,[ChannelPromise](../../../io/netty/channel/ChannelPromise.html "interface in io.netty.channel") promise)
Request to connect to the given SocketAddress and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error.
[ChannelFuture](../../../io/netty/channel/ChannelFuture.html "interface in io.netty.channel")
[connect](../../../io/netty/channel/ChannelPipeline.html#connect-java.net.SocketAddress-java.net.SocketAddress-)(java.net.SocketAddress remoteAddress, java.net.SocketAddress localAddress)
Request to connect to the given SocketAddress while bind to the localAddress and notify theChannelFuture once the operation completes, either because the operation was successful or because of an error.
[ChannelFuture](../../../io/netty/channel/ChannelFuture.html "interface in io.netty.channel")
[connect](../../../io/netty/channel/ChannelPipeline.html#connect-java.net.SocketAddress-java.net.SocketAddress-io.netty.channel.ChannelPromise-)(java.net.SocketAddress remoteAddress, java.net.SocketAddress localAddress,[ChannelPromise](../../../io/netty/channel/ChannelPromise.html "interface in io.netty.channel") promise)
Request to connect to the given SocketAddress while bind to the localAddress and notify theChannelFuture once the operation completes, either because the operation was successful or because of an error.
[ChannelHandlerContext](../../../io/netty/channel/ChannelHandlerContext.html "interface in io.netty.channel")
[context](../../../io/netty/channel/ChannelPipeline.html#context-io.netty.channel.ChannelHandler-)([ChannelHandler](../../../io/netty/channel/ChannelHandler.html "interface in io.netty.channel") handler)
Returns the context object of the specified ChannelHandler in this pipeline.
[ChannelHandlerContext](../../../io/netty/channel/ChannelHandlerContext.html "interface in io.netty.channel")
[context](../../../io/netty/channel/ChannelPipeline.html#context-java.lang.Class-)(java.lang.Class<? extends [ChannelHandler](../../../io/netty/channel/ChannelHandler.html "interface in io.netty.channel")> handlerType)
Returns the context object of the ChannelHandler of the specified type in this pipeline.
[ChannelHandlerContext](../../../io/netty/channel/ChannelHandlerContext.html "interface in io.netty.channel")
[context](../../../io/netty/channel/ChannelPipeline.html#context-java.lang.String-)(java.lang.String name)
Returns the context object of the ChannelHandler with the specified name in this pipeline.
[ChannelFuture](../../../io/netty/channel/ChannelFuture.html "interface in io.netty.channel")
[deregister](../../../io/netty/channel/ChannelPipeline.html#deregister--)()
Request to deregister the Channel from the previous assigned EventExecutor and notify theChannelFuture once the operation completes, either because the operation was successful or because of an error.
[ChannelFuture](../../../io/netty/channel/ChannelFuture.html "interface in io.netty.channel")
[deregister](../../../io/netty/channel/ChannelPipeline.html#deregister-io.netty.channel.ChannelPromise-)([ChannelPromise](../../../io/netty/channel/ChannelPromise.html "interface in io.netty.channel") promise)
Request to deregister the Channel bound this ChannelPipeline from the previous assignedEventExecutor and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error.
[ChannelFuture](../../../io/netty/channel/ChannelFuture.html "interface in io.netty.channel")
[disconnect](../../../io/netty/channel/ChannelPipeline.html#disconnect--)()
Request to disconnect from the remote peer and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error.
[ChannelFuture](../../../io/netty/channel/ChannelFuture.html "interface in io.netty.channel")
[disconnect](../../../io/netty/channel/ChannelPipeline.html#disconnect-io.netty.channel.ChannelPromise-)([ChannelPromise](../../../io/netty/channel/ChannelPromise.html "interface in io.netty.channel") promise)
Request to disconnect from the remote peer and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error.
[ChannelPipeline](../../../io/netty/channel/ChannelPipeline.html "interface in io.netty.channel")
[fireChannelActive](../../../io/netty/channel/ChannelPipeline.html#fireChannelActive--)()
A Channel is active now, which means it is connected.
[ChannelPipeline](../../../io/netty/channel/ChannelPipeline.html "interface in io.netty.channel")
[fireChannelInactive](../../../io/netty/channel/ChannelPipeline.html#fireChannelInactive--)()
A Channel is inactive now, which means it is closed.
[ChannelPipeline](../../../io/netty/channel/ChannelPipeline.html "interface in io.netty.channel")
[fireChannelRead](../../../io/netty/channel/ChannelPipeline.html#fireChannelRead-java.lang.Object-)(java.lang.Object msg)
A Channel received a message.
[ChannelPipeline](../../../io/netty/channel/ChannelPipeline.html "interface in io.netty.channel")
[fireChannelReadComplete](../../../io/netty/channel/ChannelPipeline.html#fireChannelReadComplete--)()
[ChannelPipeline](../../../io/netty/channel/ChannelPipeline.html "interface in io.netty.channel")
[fireChannelRegistered](../../../io/netty/channel/ChannelPipeline.html#fireChannelRegistered--)()
[ChannelPipeline](../../../io/netty/channel/ChannelPipeline.html "interface in io.netty.channel")
[fireChannelUnregistered](../../../io/netty/channel/ChannelPipeline.html#fireChannelUnregistered--)()
[ChannelPipeline](../../../io/netty/channel/ChannelPipeline.html "interface in io.netty.channel")
[fireChannelWritabilityChanged](../../../io/netty/channel/ChannelPipeline.html#fireChannelWritabilityChanged--)()
[ChannelPipeline](../../../io/netty/channel/ChannelPipeline.html "interface in io.netty.channel")
[fireExceptionCaught](../../../io/netty/channel/ChannelPipeline.html#fireExceptionCaught-java.lang.Throwable-)(java.lang.Throwable cause)
A Channel received an Throwable in one of its inbound operations.
[ChannelPipeline](../../../io/netty/channel/ChannelPipeline.html "interface in io.netty.channel")
[fireUserEventTriggered](../../../io/netty/channel/ChannelPipeline.html#fireUserEventTriggered-java.lang.Object-)(java.lang.Object event)
A Channel received an user defined event.
[ChannelHandler](../../../io/netty/channel/ChannelHandler.html "interface in io.netty.channel")
[first](../../../io/netty/channel/ChannelPipeline.html#first--)()
[ChannelHandlerContext](../../../io/netty/channel/ChannelHandlerContext.html "interface in io.netty.channel")
[firstContext](../../../io/netty/channel/ChannelPipeline.html#firstContext--)()
Returns the context of the first ChannelHandler in this pipeline.
[ChannelPipeline](../../../io/netty/channel/ChannelPipeline.html "interface in io.netty.channel")
[flush](../../../io/netty/channel/ChannelPipeline.html#flush--)()
Request to flush all pending messages.
<T extends [ChannelHandler](../../../io/netty/channel/ChannelHandler.html "interface in io.netty.channel")> T
[get](../../../io/netty/channel/ChannelPipeline.html#get-java.lang.Class-)(java.lang.Class<T> handlerType)
Returns the ChannelHandler of the specified type in this pipeline.
[ChannelHandler](../../../io/netty/channel/ChannelHandler.html "interface in io.netty.channel")
[get](../../../io/netty/channel/ChannelPipeline.html#get-java.lang.String-)(java.lang.String name)
Returns the ChannelHandler with the specified name in this pipeline.
[ChannelHandler](../../../io/netty/channel/ChannelHandler.html "interface in io.netty.channel")
[last](../../../io/netty/channel/ChannelPipeline.html#last--)()
[ChannelHandlerContext](../../../io/netty/channel/ChannelHandlerContext.html "interface in io.netty.channel")
[lastContext](../../../io/netty/channel/ChannelPipeline.html#lastContext--)()
Returns the context of the last ChannelHandler in this pipeline.
java.util.List<java.lang.String>
[names](../../../io/netty/channel/ChannelPipeline.html#names--)()
Returns the List of the handler names.
[ChannelPipeline](../../../io/netty/channel/ChannelPipeline.html "interface in io.netty.channel")
[read](../../../io/netty/channel/ChannelPipeline.html#read--)()
[ChannelPipeline](../../../io/netty/channel/ChannelPipeline.html "interface in io.netty.channel")
[remove](../../../io/netty/channel/ChannelPipeline.html#remove-io.netty.channel.ChannelHandler-)([ChannelHandler](../../../io/netty/channel/ChannelHandler.html "interface in io.netty.channel") handler)
<T extends [ChannelHandler](../../../io/netty/channel/ChannelHandler.html "interface in io.netty.channel")> T
[remove](../../../io/netty/channel/ChannelPipeline.html#remove-java.lang.Class-)(java.lang.Class<T> handlerType)
Removes the ChannelHandler of the specified type from this pipeline.
[ChannelHandler](../../../io/netty/channel/ChannelHandler.html "interface in io.netty.channel")
[remove](../../../io/netty/channel/ChannelPipeline.html#remove-java.lang.String-)(java.lang.String name)
Removes the ChannelHandler with the specified name from this pipeline.
[ChannelHandler](../../../io/netty/channel/ChannelHandler.html "interface in io.netty.channel")
[removeFirst](../../../io/netty/channel/ChannelPipeline.html#removeFirst--)()
[ChannelHandler](../../../io/netty/channel/ChannelHandler.html "interface in io.netty.channel")
[removeLast](../../../io/netty/channel/ChannelPipeline.html#removeLast--)()
[ChannelPipeline](../../../io/netty/channel/ChannelPipeline.html "interface in io.netty.channel")
[replace](../../../io/netty/channel/ChannelPipeline.html#replace-io.netty.channel.ChannelHandler-java.lang.String-io.netty.channel.ChannelHandler-)([ChannelHandler](../../../io/netty/channel/ChannelHandler.html "interface in io.netty.channel") oldHandler, java.lang.String newName,[ChannelHandler](../../../io/netty/channel/ChannelHandler.html "interface in io.netty.channel") newHandler)
Replaces the specified ChannelHandler with a new handler in this pipeline.
<T extends [ChannelHandler](../../../io/netty/channel/ChannelHandler.html "interface in io.netty.channel")> T
[replace](../../../io/netty/channel/ChannelPipeline.html#replace-java.lang.Class-java.lang.String-io.netty.channel.ChannelHandler-)(java.lang.Class<T> oldHandlerType, java.lang.String newName,[ChannelHandler](../../../io/netty/channel/ChannelHandler.html "interface in io.netty.channel") newHandler)
Replaces the ChannelHandler of the specified type with a new handler in this pipeline.
[ChannelHandler](../../../io/netty/channel/ChannelHandler.html "interface in io.netty.channel")
[replace](../../../io/netty/channel/ChannelPipeline.html#replace-java.lang.String-java.lang.String-io.netty.channel.ChannelHandler-)(java.lang.String oldName, java.lang.String newName,[ChannelHandler](../../../io/netty/channel/ChannelHandler.html "interface in io.netty.channel") newHandler)
Replaces the ChannelHandler of the specified name with a new handler in this pipeline.
java.util.Map<java.lang.String,[ChannelHandler](../../../io/netty/channel/ChannelHandler.html "interface in io.netty.channel")>
[toMap](../../../io/netty/channel/ChannelPipeline.html#toMap--)()
Converts this pipeline into an ordered Map whose keys are handler names and whose values are handlers.
[ChannelFuture](../../../io/netty/channel/ChannelFuture.html "interface in io.netty.channel")
[write](../../../io/netty/channel/ChannelPipeline.html#write-java.lang.Object-)(java.lang.Object msg)
[ChannelFuture](../../../io/netty/channel/ChannelFuture.html "interface in io.netty.channel")
[write](../../../io/netty/channel/ChannelPipeline.html#write-java.lang.Object-io.netty.channel.ChannelPromise-)(java.lang.Object msg,[ChannelPromise](../../../io/netty/channel/ChannelPromise.html "interface in io.netty.channel") promise)
[ChannelFuture](../../../io/netty/channel/ChannelFuture.html "interface in io.netty.channel")
[writeAndFlush](../../../io/netty/channel/ChannelPipeline.html#writeAndFlush-java.lang.Object-)(java.lang.Object msg)
[ChannelFuture](../../../io/netty/channel/ChannelFuture.html "interface in io.netty.channel")
[writeAndFlush](../../../io/netty/channel/ChannelPipeline.html#writeAndFlush-java.lang.Object-io.netty.channel.ChannelPromise-)(java.lang.Object msg,[ChannelPromise](../../../io/netty/channel/ChannelPromise.html "interface in io.netty.channel") promise)