## Uses of Interface
org.jboss.netty.channel.ChannelHandler

Packages that use ChannelHandler
org.jboss.netty.bootstrap: IoC/DI friendly helper classes which enable an easy implementation of typical client side and server side channel initialization.
org.jboss.netty.channel: The core channel API which is asynchronous and event-driven abstraction of various transports such as a NIO Channel.
org.jboss.netty.handler.codec.base64: Encoder and decoder which transform a Base64-encoded `String` or `ChannelBuffer` into a decoded `ChannelBuffer` and vice versa.
org.jboss.netty.handler.codec.compression: Encoder and decoder which compresses and decompresses `ChannelBuffer`s in a compression format such as zlib and gzip.
org.jboss.netty.handler.codec.frame: Extensible decoder and its common implementations which deal with the packet fragmentation and reassembly issue found in a stream-based transport such as TCP/IP.
org.jboss.netty.handler.codec.http: Encoder, decoder and their related message types for HTTP.
org.jboss.netty.handler.codec.http.websocket: Encoder, decoder and their related message types for Web Socket data frames.
org.jboss.netty.handler.codec.oneone: Simplistic abstract classes which help implement encoder and decoder that transform an object into another object and vice versa.
org.jboss.netty.handler.codec.protobuf: Encoder and decoder which transform a Google Protocol Buffers `Message` into a `ChannelBuffer` and vice versa.
org.jboss.netty.handler.codec.replay: Specialized variation of `FrameDecoder` which enables implementation of a non-blocking decoder in the blocking I/O paradigm.
org.jboss.netty.handler.codec.rtsp: An RTSP extension based on the HTTP codec.
org.jboss.netty.handler.codec.serialization: Encoder, decoder and their compatibility stream implementations which transform a `Serializable` object into a byte buffer and vice versa.
org.jboss.netty.handler.codec.string: Encoder and decoder which transform a `String` into a `ChannelBuffer` and vice versa.
org.jboss.netty.handler.execution: `Executor`-based implementation of various thread models that separate business logic from I/O threads
org.jboss.netty.handler.logging: Logs a `ChannelEvent` for debugging purpose using an `InternalLogger`.
org.jboss.netty.handler.queue: The special-purpose handlers that store an event into an internal queue instead of propagating the event immediately.
org.jboss.netty.handler.ssl: SSL · TLS implementation based on `SSLEngine`
org.jboss.netty.handler.stream: Writes very large data stream asynchronously neither spending a lot of memory nor getting `OutOfMemoryError`.
org.jboss.netty.handler.timeout: Adds support for read and write timeout and idle connection notification using a `Timer`.

Uses of ChannelHandler in org.jboss.netty.bootstrap

Methods in org.jboss.netty.bootstrap that return ChannelHandler
`ChannelHandler` `ServerBootstrap.getParentHandler()` Returns an optional `ChannelHandler` which intercepts an event of a newly bound server-side channel which accepts incoming connections.

Methods in org.jboss.netty.bootstrap that return types with arguments of type ChannelHandler
`Map<String,ChannelHandler>` `Bootstrap.getPipelineAsMap()` Dependency injection friendly convenience method for `Bootstrap.getPipeline()` which returns the default pipeline of this bootstrap as an ordered map.

Methods in org.jboss.netty.bootstrap with parameters of type ChannelHandler
`void` `ServerBootstrap.setParentHandler(ChannelHandler parentHandler)` Sets an optional `ChannelHandler` which intercepts an event of a newly bound server-side channel which accepts incoming connections.

Method parameters in org.jboss.netty.bootstrap with type arguments of type ChannelHandler
`void` `Bootstrap.setPipelineAsMap(Map<String,ChannelHandler> pipelineMap)` Dependency injection friendly convenience method for `Bootstrap.setPipeline(ChannelPipeline)` which sets the default pipeline of this bootstrap from an ordered map.

Uses of ChannelHandler in org.jboss.netty.channel

Subinterfaces of ChannelHandler in org.jboss.netty.channel
`interface` `ChannelDownstreamHandler` Handles or intercepts a downstream `ChannelEvent`, and sends a `ChannelEvent` to the next handler in a `ChannelPipeline`.
`interface` `ChannelUpstreamHandler` Handles or intercepts an upstream `ChannelEvent`, and sends a `ChannelEvent` to the next handler in a `ChannelPipeline`.
`interface` `LifeCycleAwareChannelHandler` A `ChannelHandler` that is notified when it is added to or removed from a `ChannelPipeline`.

Classes in org.jboss.netty.channel that implement ChannelHandler
`class` `SimpleChannelDownstreamHandler` A `ChannelDownstreamHandler` which provides an individual handler method for each event type.
`class` `SimpleChannelHandler` A `ChannelHandler` which provides an individual handler method for each event type.
`class` `SimpleChannelUpstreamHandler` A `ChannelUpstreamHandler` which provides an individual handler method for each event type.

Methods in org.jboss.netty.channel with type parameters of type ChannelHandler

`

`<T extends ChannelHandler> T`

`

`ChannelPipeline.get(Class<T> handlerType)`
Returns the `ChannelHandler` of the specified type in this pipeline.

`

`<T extends ChannelHandler> T`

`

`StaticChannelPipeline.get(Class<T> handlerType)`

`

`<T extends ChannelHandler> T`

`

`DefaultChannelPipeline.get(Class<T> handlerType)`

`

`<T extends ChannelHandler> T`

`

`ChannelPipeline.remove(Class<T> handlerType)`
Removes the `ChannelHandler` of the specified type from this pipeline

`

`<T extends ChannelHandler> T`

`

`StaticChannelPipeline.remove(Class<T> handlerType)`

`

`<T extends ChannelHandler> T`

`

`DefaultChannelPipeline.remove(Class<T> handlerType)`

`

`<T extends ChannelHandler> T`

`

`ChannelPipeline.replace(Class<T> oldHandlerType, String newName, ChannelHandler newHandler)`
Replaces the `ChannelHandler` of the specified type with a new handler in this pipeline.

`

`<T extends ChannelHandler> T`

`

`StaticChannelPipeline.replace(Class<T> oldHandlerType, String newName, ChannelHandler newHandler)`

`

`<T extends ChannelHandler> T`

`

`DefaultChannelPipeline.replace(Class<T> oldHandlerType, String newName, ChannelHandler newHandler)`

Methods in org.jboss.netty.channel that return ChannelHandler
`ChannelHandler` `ChannelPipeline.get(String name)` Returns the `ChannelHandler` with the specified name in this pipeline.
`ChannelHandler` `StaticChannelPipeline.get(String name)`
`ChannelHandler` `DefaultChannelPipeline.get(String name)`
`ChannelHandler` `ChannelPipeline.getFirst()` Returns the first `ChannelHandler` in this pipeline.
`ChannelHandler` `StaticChannelPipeline.getFirst()`
`ChannelHandler` `DefaultChannelPipeline.getFirst()`
`ChannelHandler` `ChannelHandlerContext.getHandler()` Returns the `ChannelHandler` that this context object is serving.
`ChannelHandler` `ChannelPipeline.getLast()` Returns the last `ChannelHandler` in this pipeline.
`ChannelHandler` `StaticChannelPipeline.getLast()`
`ChannelHandler` `DefaultChannelPipeline.getLast()`
`ChannelHandler` `ChannelPipeline.remove(String name)` Removes the `ChannelHandler` with the specified name from this pipeline.
`ChannelHandler` `StaticChannelPipeline.remove(String name)`
`ChannelHandler` `DefaultChannelPipeline.remove(String name)`
`ChannelHandler` `ChannelPipeline.removeFirst()` Removes the first `ChannelHandler` in this pipeline.
`ChannelHandler` `StaticChannelPipeline.removeFirst()`
`ChannelHandler` `DefaultChannelPipeline.removeFirst()`
`ChannelHandler` `ChannelPipeline.removeLast()` Removes the last `ChannelHandler` in this pipeline.
`ChannelHandler` `StaticChannelPipeline.removeLast()`
`ChannelHandler` `DefaultChannelPipeline.removeLast()`
`ChannelHandler` `ChannelPipeline.replace(String oldName, String newName, ChannelHandler newHandler)` Replaces the `ChannelHandler` of the specified name with a new handler in this pipeline.
`ChannelHandler` `StaticChannelPipeline.replace(String oldName, String newName, ChannelHandler newHandler)`
`ChannelHandler` `DefaultChannelPipeline.replace(String oldName, String newName, ChannelHandler newHandler)`

Methods in org.jboss.netty.channel that return types with arguments of type ChannelHandler
`Map<String,ChannelHandler>` `ChannelPipeline.toMap()` Converts this pipeline into an ordered `Map` whose keys are handler names and whose values are handlers.
`Map<String,ChannelHandler>` `StaticChannelPipeline.toMap()`
`Map<String,ChannelHandler>` `DefaultChannelPipeline.toMap()`

Methods in org.jboss.netty.channel with parameters of type ChannelHandler
`void` `ChannelPipeline.addAfter(String baseName, String name, ChannelHandler handler)` Inserts a `ChannelHandler` after an existing handler of this pipeline.
`void` `StaticChannelPipeline.addAfter(String baseName, String name, ChannelHandler handler)`
`void` `DefaultChannelPipeline.addAfter(String baseName, String name, ChannelHandler handler)`
`void` `ChannelPipeline.addBefore(String baseName, String name, ChannelHandler handler)` Inserts a `ChannelHandler` before an existing handler of this pipeline.
`void` `StaticChannelPipeline.addBefore(String baseName, String name, ChannelHandler handler)`
`void` `DefaultChannelPipeline.addBefore(String baseName, String name, ChannelHandler handler)`
`void` `ChannelPipeline.addFirst(String name, ChannelHandler handler)` Inserts a `ChannelHandler` at the first position of this pipeline.
`void` `StaticChannelPipeline.addFirst(String name, ChannelHandler handler)`
`void` `DefaultChannelPipeline.addFirst(String name, ChannelHandler handler)`
`void` `ChannelPipeline.addLast(String name, ChannelHandler handler)` Appends a `ChannelHandler` at the last position of this pipeline.
`void` `StaticChannelPipeline.addLast(String name, ChannelHandler handler)`
`void` `DefaultChannelPipeline.addLast(String name, ChannelHandler handler)`
`ChannelHandlerContext` `ChannelPipeline.getContext(ChannelHandler handler)` Returns the context object of the specified `ChannelHandler` in this pipeline.
`ChannelHandlerContext` `StaticChannelPipeline.getContext(ChannelHandler handler)`
`ChannelHandlerContext` `DefaultChannelPipeline.getContext(ChannelHandler handler)`
`static ChannelPipeline` `Channels.pipeline(ChannelHandler... handlers)` Creates a new `ChannelPipeline` which contains the specified `ChannelHandler`s.
`void` `ChannelPipeline.remove(ChannelHandler handler)` Removes the specified `ChannelHandler` from this pipeline.
`void` `StaticChannelPipeline.remove(ChannelHandler handler)`
`void` `DefaultChannelPipeline.remove(ChannelHandler handler)`
`void` `ChannelPipeline.replace(ChannelHandler oldHandler, String newName, ChannelHandler newHandler)` Replaces the specified `ChannelHandler` with a new handler in this pipeline.
`void` `StaticChannelPipeline.replace(ChannelHandler oldHandler, String newName, ChannelHandler newHandler)`
`void` `DefaultChannelPipeline.replace(ChannelHandler oldHandler, String newName, ChannelHandler newHandler)`

`

`<T extends ChannelHandler> T`

`

`ChannelPipeline.replace(Class<T> oldHandlerType, String newName, ChannelHandler newHandler)`
Replaces the `ChannelHandler` of the specified type with a new handler in this pipeline.

`

`<T extends ChannelHandler> T`

`

`StaticChannelPipeline.replace(Class<T> oldHandlerType, String newName, ChannelHandler newHandler)`

`

`<T extends ChannelHandler> T`

`

`DefaultChannelPipeline.replace(Class<T> oldHandlerType, String newName, ChannelHandler newHandler)`

`ChannelHandler` `ChannelPipeline.replace(String oldName, String newName, ChannelHandler newHandler)` Replaces the `ChannelHandler` of the specified name with a new handler in this pipeline.
`ChannelHandler` `StaticChannelPipeline.replace(String oldName, String newName, ChannelHandler newHandler)`
`ChannelHandler` `DefaultChannelPipeline.replace(String oldName, String newName, ChannelHandler newHandler)`

Method parameters in org.jboss.netty.channel with type arguments of type ChannelHandler
`ChannelHandlerContext` `ChannelPipeline.getContext(Class<? extends ChannelHandler> handlerType)` Returns the context object of the `ChannelHandler` of the specified type in this pipeline.
`ChannelHandlerContext` `StaticChannelPipeline.getContext(Class<? extends ChannelHandler> handlerType)`
`ChannelHandlerContext` `DefaultChannelPipeline.getContext(Class<? extends ChannelHandler> handlerType)`

Constructors in org.jboss.netty.channel with parameters of type ChannelHandler
`StaticChannelPipeline(ChannelHandler... handlers)` Creates a new pipeline from the specified handlers.

Uses of ChannelHandler in org.jboss.netty.handler.codec.base64

Classes in org.jboss.netty.handler.codec.base64 that implement ChannelHandler
`class` `Base64Decoder` Decodes a Base64-encoded `ChannelBuffer` or US-ASCII `String` into a `ChannelBuffer`.
`class` `Base64Encoder` Encodes a `ChannelBuffer` into a Base64-encoded `ChannelBuffer`.

Uses of ChannelHandler in org.jboss.netty.handler.codec.compression

Classes in org.jboss.netty.handler.codec.compression that implement ChannelHandler
`class` `ZlibDecoder` Decompresses a `ChannelBuffer` using the deflate algorithm.
`class` `ZlibEncoder` Compresses a `ChannelBuffer` using the deflate algorithm.

Uses of ChannelHandler in org.jboss.netty.handler.codec.frame

Classes in org.jboss.netty.handler.codec.frame that implement ChannelHandler
`class` `DelimiterBasedFrameDecoder` A decoder that splits the received `ChannelBuffer`s by one or more delimiters.
`class` `FixedLengthFrameDecoder` A decoder that splits the received `ChannelBuffer`s by the fixed number of bytes.
`class` `FrameDecoder` Decodes the received `ChannelBuffer`s into a meaningful frame object.
`class` `LengthFieldBasedFrameDecoder` A decoder that splits the received `ChannelBuffer`s dynamically by the value of the length field in the message.
`class` `LengthFieldPrepender` An encoder that prepends the length of the message.

Uses of ChannelHandler in org.jboss.netty.handler.codec.http

Classes in org.jboss.netty.handler.codec.http that implement ChannelHandler
`class` `HttpChunkAggregator` A `ChannelHandler` that aggregates an `HttpMessage` and its following `HttpChunk`s into a single `HttpMessage` with no following `HttpChunk`s.
`class` `HttpClientCodec` A combination of `HttpRequestEncoder` and `HttpResponseDecoder` which enables easier client side HTTP implementation.
`class` `HttpContentCompressor` Compresses an `HttpMessage` and an `HttpChunk` in `gzip` or `deflate` encoding while respecting the `"Accept-Encoding"` header.
`class` `HttpContentDecoder` Decodes the content of the received `HttpRequest` and `HttpChunk`.
`class` `HttpContentDecompressor` Decompresses an `HttpMessage` and an `HttpChunk` compressed in `gzip` or `deflate` encoding.
`class` `HttpContentEncoder` Encodes the content of the outbound `HttpResponse` and `HttpChunk`.
`class` `HttpMessageDecoder` Decodes `ChannelBuffer`s into `HttpMessage`s and `HttpChunk`s.
`class` `HttpMessageEncoder` Encodes an `HttpMessage` or an `HttpChunk` into a `ChannelBuffer`.
`class` `HttpRequestDecoder` Decodes `ChannelBuffer`s into `HttpRequest`s and `HttpChunk`s.
`class` `HttpRequestEncoder` Encodes an `HttpRequest` or an `HttpChunk` into a `ChannelBuffer`.
`class` `HttpResponseDecoder` Decodes `ChannelBuffer`s into `HttpResponse`s and `HttpChunk`s.
`class` `HttpResponseEncoder` Encodes an `HttpResponse` or an `HttpChunk` into a `ChannelBuffer`.
`class` `HttpServerCodec` A combination of `HttpRequestDecoder` and `HttpResponseEncoder` which enables easier server side HTTP implementation.

Uses of ChannelHandler in org.jboss.netty.handler.codec.http.websocket

Classes in org.jboss.netty.handler.codec.http.websocket that implement ChannelHandler
`class` `WebSocketFrameDecoder` Decodes `ChannelBuffer`s into `WebSocketFrame`s.
`class` `WebSocketFrameEncoder` Encodes a `WebSocketFrame` into a `ChannelBuffer`.

Uses of ChannelHandler in org.jboss.netty.handler.codec.oneone

Classes in org.jboss.netty.handler.codec.oneone that implement ChannelHandler
`class` `OneToOneDecoder` Transforms a received message into another message.
`class` `OneToOneEncoder` Transforms a write request into another write request.

Uses of ChannelHandler in org.jboss.netty.handler.codec.protobuf

Classes in org.jboss.netty.handler.codec.protobuf that implement ChannelHandler
`class` `ProtobufDecoder` Decodes a received `ChannelBuffer` into a Google Protocol Buffers `Message` and `MessageLite`.
`class` `ProtobufEncoder` Encodes the requested Google Protocol Buffers `Message` and `MessageLite` into a `ChannelBuffer`.
`class` `ProtobufVarint32FrameDecoder` A decoder that splits the received `ChannelBuffer`s dynamically by the value of the Google Protocol Buffers Base 128 Varints integer length field in the message.
`class` `ProtobufVarint32LengthFieldPrepender` An encoder that prepends the the Google Protocol Buffers Base 128 Varints integer length field.

Uses of ChannelHandler in org.jboss.netty.handler.codec.replay

Classes in org.jboss.netty.handler.codec.replay that implement ChannelHandler
`class` `ReplayingDecoder<T extends Enum<T>>` A specialized variation of `FrameDecoder` which enables implementation of a non-blocking decoder in the blocking I/O paradigm.

Uses of ChannelHandler in org.jboss.netty.handler.codec.rtsp

Classes in org.jboss.netty.handler.codec.rtsp that implement ChannelHandler
`class` `RtspMessageDecoder` Decodes `ChannelBuffer`s into RTSP messages represented in `HttpMessage`s.
`class` `RtspMessageEncoder` Encodes an RTSP message represented in `HttpMessage` into a `ChannelBuffer`.
`class` `RtspRequestDecoder` Decodes `ChannelBuffer`s into RTSP requests represented in `HttpRequest`s.
`class` `RtspRequestEncoder` Encodes an RTSP request represented in `HttpRequest` into a `ChannelBuffer`.
`class` `RtspResponseDecoder` Decodes `ChannelBuffer`s into RTSP responses represented in `HttpResponse`s.
`class` `RtspResponseEncoder` Encodes an RTSP response represented in `HttpResponse` into a `ChannelBuffer`.

Uses of ChannelHandler in org.jboss.netty.handler.codec.serialization

Classes in org.jboss.netty.handler.codec.serialization that implement ChannelHandler

`class`

`CompatibleObjectDecoder`
Deprecated. This decoder has a known critical bug which fails to decode and raises a random exception in some circumstances. Avoid to use it whenever you can. The only workaround is to replace `CompatibleObjectEncoder`, `CompatibleObjectDecoder`, `ObjectInputStream`, and `ObjectOutputStream` with `ObjectEncoder`, `ObjectDecoder`, `ObjectEncoderOutputStream`, and `ObjectDecoderInputStream` respectively. This workaround requires both a client and a server to be modified.

`class` `CompatibleObjectEncoder` An encoder which serializes a Java object into a `ChannelBuffer` (interoperability version).
`class` `ObjectDecoder` A decoder which deserializes the received `ChannelBuffer`s into Java objects.
`class` `ObjectEncoder` An encoder which serializes a Java object into a `ChannelBuffer`.

Uses of ChannelHandler in org.jboss.netty.handler.codec.string

Classes in org.jboss.netty.handler.codec.string that implement ChannelHandler
`class` `StringDecoder` Decodes a received `ChannelBuffer` into a `String`.
`class` `StringEncoder` Encodes the requested `String` into a `ChannelBuffer`.

Uses of ChannelHandler in org.jboss.netty.handler.execution

Classes in org.jboss.netty.handler.execution that implement ChannelHandler
`class` `ExecutionHandler` Forwards an upstream `ChannelEvent` to an `Executor`.

Uses of ChannelHandler in org.jboss.netty.handler.logging

Classes in org.jboss.netty.handler.logging that implement ChannelHandler
`class` `LoggingHandler` A `ChannelHandler` that logs all events via `InternalLogger`.

Uses of ChannelHandler in org.jboss.netty.handler.queue

Classes in org.jboss.netty.handler.queue that implement ChannelHandler
`class` `BlockingReadHandler<E>` Emulates blocking read operation.
`class` `BufferedWriteHandler` Emulates buffered write operation.

Uses of ChannelHandler in org.jboss.netty.handler.ssl

Classes in org.jboss.netty.handler.ssl that implement ChannelHandler
`class` `SslHandler` Adds SSL · TLS and StartTLS support to a `Channel`.

Uses of ChannelHandler in org.jboss.netty.handler.stream

Classes in org.jboss.netty.handler.stream that implement ChannelHandler
`class` `ChunkedWriteHandler` A `ChannelHandler` that adds support for writing a large data stream asynchronously neither spending a lot of memory nor getting `OutOfMemoryError`.

Uses of ChannelHandler in org.jboss.netty.handler.timeout

Classes in org.jboss.netty.handler.timeout that implement ChannelHandler
`class` `IdleStateAwareChannelHandler` An extended `SimpleChannelHandler` that adds the handler method for an `IdleStateEvent`.
`class` `IdleStateAwareChannelUpstreamHandler` An extended `SimpleChannelUpstreamHandler` that adds the handler method for an `IdleStateEvent`.
`class` `IdleStateHandler` Triggers an `IdleStateEvent` when a `Channel` has not performed read, write, or both operation for a while.
`class` `ReadTimeoutHandler` Raises a `ReadTimeoutException` when no data was read within a certain period of time.
`class` `WriteTimeoutHandler` Raises a `WriteTimeoutException` when no data was written within a certain period of time.

Copyright © 2008-2010 JBoss, a division of Red Hat, Inc.. All Rights Reserved.