| Package | Description | 
|---|---|
| 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  
ChannelBuffers
 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.websocketx | 
 Encoder, decoder, handshakers and their related message types for
 Web Socket data frames. 
 | 
| org.jboss.netty.handler.codec.marshalling | 
 Decoder and Encoder which uses JBoss Marshalling. 
 | 
| 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.socks | 
 Encoder, decoder and their related message types for Socks. 
 | 
| org.jboss.netty.handler.codec.spdy | 
 Encoder, decoder, session handler and their related message types for the SPDY protocol. 
 | 
| 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.ipfilter | 
 Implementation of a Ip based Filter handlers. 
 | 
| 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 | |
| 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. | 
| org.jboss.netty.handler.traffic | 
 Implementation of a Traffic Shaping Handler and Dynamic Statistics. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
ChannelHandler | 
ServerBootstrap.getParentHandler()
Returns an optional  
ChannelHandler which intercepts an event
 of a newly bound server-side channel which accepts incoming connections. | 
| Modifier and Type | Method and Description | 
|---|---|
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. | 
| Modifier and Type | Method and Description | 
|---|---|
void | 
ServerBootstrap.setParentHandler(ChannelHandler parentHandler)
Sets an optional  
ChannelHandler which intercepts an event of
 a newly bound server-side channel which accepts incoming connections. | 
| Modifier and Type | Method and Description | 
|---|---|
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. | 
| Modifier and Type | Interface and Description | 
|---|---|
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. | 
| Modifier and Type | Class and Description | 
|---|---|
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. | 
| Modifier and Type | Method and Description | 
|---|---|
<T extends ChannelHandler>  | 
DefaultChannelPipeline.get(Class<T> handlerType)  | 
<T extends ChannelHandler>  | 
ChannelPipeline.get(Class<T> handlerType)
Returns the  
ChannelHandler of the specified type in this
 pipeline. | 
<T extends ChannelHandler>  | 
DefaultChannelPipeline.remove(Class<T> handlerType)  | 
<T extends ChannelHandler>  | 
ChannelPipeline.remove(Class<T> handlerType)
Removes the  
ChannelHandler of the specified type from this
 pipeline | 
<T extends ChannelHandler>  | 
DefaultChannelPipeline.replace(Class<T> oldHandlerType,
       String newName,
       ChannelHandler newHandler)  | 
<T extends ChannelHandler>  | 
ChannelPipeline.replace(Class<T> oldHandlerType,
       String newName,
       ChannelHandler newHandler)
Replaces the  
ChannelHandler of the specified type with a new
 handler in this pipeline. | 
| Modifier and Type | Method and Description | 
|---|---|
ChannelHandler | 
DefaultChannelPipeline.get(String name)  | 
ChannelHandler | 
ChannelPipeline.get(String name)
Returns the  
ChannelHandler with the specified name in this
 pipeline. | 
ChannelHandler | 
DefaultChannelPipeline.getFirst()  | 
ChannelHandler | 
ChannelPipeline.getFirst()
Returns the first  
ChannelHandler in this pipeline. | 
ChannelHandler | 
ChannelHandlerContext.getHandler()
Returns the  
ChannelHandler that this context object is
 serving. | 
ChannelHandler | 
DefaultChannelPipeline.getLast()  | 
ChannelHandler | 
ChannelPipeline.getLast()
Returns the last  
ChannelHandler in this pipeline. | 
ChannelHandler | 
DefaultChannelPipeline.remove(String name)  | 
ChannelHandler | 
ChannelPipeline.remove(String name)
Removes the  
ChannelHandler with the specified name from this
 pipeline. | 
ChannelHandler | 
DefaultChannelPipeline.removeFirst()  | 
ChannelHandler | 
ChannelPipeline.removeFirst()
Removes the first  
ChannelHandler in this pipeline. | 
ChannelHandler | 
DefaultChannelPipeline.removeLast()  | 
ChannelHandler | 
ChannelPipeline.removeLast()
Removes the last  
ChannelHandler in this pipeline. | 
ChannelHandler | 
DefaultChannelPipeline.replace(String oldName,
       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. | 
| Modifier and Type | Method and Description | 
|---|---|
Map<String,ChannelHandler> | 
DefaultChannelPipeline.toMap()  | 
Map<String,ChannelHandler> | 
ChannelPipeline.toMap()
Converts this pipeline into an ordered  
Map whose keys are
 handler names and whose values are handlers. | 
| Modifier and Type | Method and Description | 
|---|---|
void | 
DefaultChannelPipeline.addAfter(String baseName,
        String name,
        ChannelHandler handler)  | 
void | 
ChannelPipeline.addAfter(String baseName,
        String name,
        ChannelHandler handler)
Inserts a  
ChannelHandler after an existing handler of this
 pipeline. | 
void | 
DefaultChannelPipeline.addBefore(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 | 
DefaultChannelPipeline.addFirst(String name,
        ChannelHandler handler)  | 
void | 
ChannelPipeline.addFirst(String name,
        ChannelHandler handler)
Inserts a  
ChannelHandler at the first position of this pipeline. | 
void | 
DefaultChannelPipeline.addLast(String name,
       ChannelHandler handler)  | 
void | 
ChannelPipeline.addLast(String name,
       ChannelHandler handler)
Appends a  
ChannelHandler at the last position of this pipeline. | 
ChannelHandlerContext | 
DefaultChannelPipeline.getContext(ChannelHandler handler)  | 
ChannelHandlerContext | 
ChannelPipeline.getContext(ChannelHandler handler)
Returns the context object of the specified  
ChannelHandler in
 this pipeline. | 
static ChannelPipeline | 
Channels.pipeline(ChannelHandler... handlers)
Creates a new  
ChannelPipeline which contains the specified
 ChannelHandlers. | 
void | 
DefaultChannelPipeline.remove(ChannelHandler handler)  | 
void | 
ChannelPipeline.remove(ChannelHandler handler)
Removes the specified  
ChannelHandler from this pipeline. | 
void | 
DefaultChannelPipeline.replace(ChannelHandler oldHandler,
       String newName,
       ChannelHandler newHandler)  | 
void | 
ChannelPipeline.replace(ChannelHandler oldHandler,
       String newName,
       ChannelHandler newHandler)
Replaces the specified  
ChannelHandler with a new handler in
 this pipeline. | 
<T extends ChannelHandler>  | 
DefaultChannelPipeline.replace(Class<T> oldHandlerType,
       String newName,
       ChannelHandler newHandler)  | 
<T extends ChannelHandler>  | 
ChannelPipeline.replace(Class<T> oldHandlerType,
       String newName,
       ChannelHandler newHandler)
Replaces the  
ChannelHandler of the specified type with a new
 handler in this pipeline. | 
ChannelHandler | 
DefaultChannelPipeline.replace(String oldName,
       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. | 
| Modifier and Type | Method and Description | 
|---|---|
ChannelHandlerContext | 
DefaultChannelPipeline.getContext(Class<? extends ChannelHandler> handlerType)  | 
ChannelHandlerContext | 
ChannelPipeline.getContext(Class<? extends ChannelHandler> handlerType)
Returns the context object of the  
ChannelHandler of the
 specified type in this pipeline. | 
| Modifier and Type | Class and Description | 
|---|---|
class  | 
Base64Decoder
 | 
class  | 
Base64Encoder
Encodes a  
ChannelBuffer into a Base64-encoded ChannelBuffer. | 
| Modifier and Type | Class and Description | 
|---|---|
class  | 
JdkZlibEncoder
Compresses a  
ChannelBuffer using the deflate algorithm. | 
class  | 
ZlibDecoder
Decompresses a  
ChannelBuffer using the deflate algorithm. | 
class  | 
ZlibEncoder
Compresses a  
ChannelBuffer using the deflate algorithm. | 
| Modifier and Type | Class and Description | 
|---|---|
class  | 
DelimiterBasedFrameDecoder
A decoder that splits the received  
ChannelBuffers by one or more
 delimiters. | 
class  | 
FixedLengthFrameDecoder
A decoder that splits the received  
ChannelBuffers by the fixed number
 of bytes. | 
class  | 
FrameDecoder
Decodes the received  
ChannelBuffers into a meaningful frame object. | 
class  | 
LengthFieldBasedFrameDecoder
A decoder that splits the received  
ChannelBuffers dynamically by the
 value of the length field in the message. | 
class  | 
LengthFieldPrepender
An encoder that prepends the length of the message. 
 | 
class  | 
LineBasedFrameDecoder
A decoder that splits the received  
ChannelBuffers on line endings. | 
| Modifier and Type | Method and Description | 
|---|---|
void | 
FrameDecoder.replace(String handlerName,
       ChannelHandler handler)
 | 
| Modifier and Type | Class and Description | 
|---|---|
class  | 
HttpChunkAggregator
A  
ChannelHandler that aggregates an HttpMessage
 and its following HttpChunks into a single HttpMessage with
 no following HttpChunks. | 
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
 | 
class  | 
HttpContentEncoder
Encodes the content of the outbound  
HttpResponse and HttpChunk. | 
class  | 
HttpMessageDecoder
 | 
class  | 
HttpMessageEncoder
 | 
class  | 
HttpRequestDecoder
 | 
class  | 
HttpRequestEncoder
 | 
class  | 
HttpResponseDecoder
 | 
class  | 
HttpResponseEncoder
 | 
class  | 
HttpServerCodec
A combination of  
HttpRequestDecoder and HttpResponseEncoder
 which enables easier server side HTTP implementation. | 
| Modifier and Type | Class and Description | 
|---|---|
class  | 
WebSocket00FrameDecoder
Decodes  
ChannelBuffers into WebSocketFrames. | 
class  | 
WebSocket00FrameEncoder
Encodes a  
WebSocketFrame into a ChannelBuffer. | 
class  | 
WebSocket07FrameDecoder
Decodes a web socket frame from wire protocol version 7 format. 
 | 
class  | 
WebSocket07FrameEncoder
 Encodes a web socket frame into wire protocol version 7 format. 
 | 
class  | 
WebSocket08FrameDecoder
Decodes a web socket frame from wire protocol version 8 format. 
 | 
class  | 
WebSocket08FrameEncoder
 Encodes a web socket frame into wire protocol version 8 format. 
 | 
class  | 
WebSocket13FrameDecoder
Decodes a web socket frame from wire protocol version 13 format. 
 | 
class  | 
WebSocket13FrameEncoder
 Encodes a web socket frame into wire protocol version 13 format. 
 | 
class  | 
WebSocketFrameAggregator
Handler that aggregate fragmented WebSocketFrame's. 
 | 
class  | 
WebSocketServerProtocolHandler
Handles WebSocket control frames (Close, Ping, Pong) and data frames (Text and Binary) are passed
 to the next handler in the pipeline. 
 | 
class  | 
WebSocketServerProtocolHandshakeHandler
Handles the HTTP handshake (the HTTP Upgrade request) 
 | 
| Modifier and Type | Method and Description | 
|---|---|
protected ChannelFuture | 
WebSocketServerHandshaker.writeHandshakeResponse(Channel channel,
                      HttpResponse res,
                      ChannelHandler encoder,
                      ChannelHandler decoder)
Upgrades the connection and send the handshake response. 
 | 
| Modifier and Type | Class and Description | 
|---|---|
class  | 
CompatibleMarshallingDecoder
 | 
class  | 
CompatibleMarshallingEncoder
OneToOneEncoder implementation which uses JBoss Marshalling to marshal
 an Object. | 
class  | 
MarshallingDecoder
Decoder which MUST be used with  
MarshallingEncoder. | 
class  | 
MarshallingEncoder
OneToOneEncoder implementation which uses JBoss Marshalling to marshal
 an Object. | 
| Modifier and Type | Class and Description | 
|---|---|
class  | 
OneToOneDecoder
Transforms a received message into another message. 
 | 
class  | 
OneToOneEncoder
Transforms a write request into another write request. 
 | 
class  | 
OneToOneStrictEncoder
Special  
OneToOneEncoder which enforce strict ordering of encoding and writing. | 
| Modifier and Type | Class and Description | 
|---|---|
class  | 
ProtobufDecoder
 | 
class  | 
ProtobufEncoder
 | 
class  | 
ProtobufVarint32FrameDecoder
A decoder that splits the received  
ChannelBuffers 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. 
 | 
| Modifier and Type | Class and Description | 
|---|---|
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. | 
| Modifier and Type | Class and Description | 
|---|---|
class  | 
RtspMessageDecoder
Decodes  
ChannelBuffers into RTSP messages represented in
 HttpMessages. | 
class  | 
RtspMessageEncoder
Encodes an RTSP message represented in  
HttpMessage into
 a ChannelBuffer. | 
class  | 
RtspRequestDecoder
Decodes  
ChannelBuffers into RTSP requests represented in
 HttpRequests. | 
class  | 
RtspRequestEncoder
Encodes an RTSP request represented in  
HttpRequest into
 a ChannelBuffer. | 
class  | 
RtspResponseDecoder
Decodes  
ChannelBuffers into RTSP responses represented in
 HttpResponses. | 
class  | 
RtspResponseEncoder
Encodes an RTSP response represented in  
HttpResponse into
 a ChannelBuffer. | 
| Modifier and Type | Class and Description | 
|---|---|
class  | 
CompatibleObjectEncoder
An encoder which serializes a Java object into a  
ChannelBuffer
 (interoperability version). | 
class  | 
ObjectDecoder
A decoder which deserializes the received  
ChannelBuffers into Java
 objects. | 
class  | 
ObjectEncoder
An encoder which serializes a Java object into a  
ChannelBuffer. | 
| Modifier and Type | Class and Description | 
|---|---|
class  | 
SocksAuthRequestDecoder
Decodes  
ChannelBuffers into SocksAuthRequest. | 
class  | 
SocksAuthResponseDecoder
Decodes  
ChannelBuffers into SocksAuthResponse. | 
class  | 
SocksCmdRequestDecoder
Decodes  
ChannelBuffers into SocksCmdRequest. | 
class  | 
SocksCmdResponseDecoder
Decodes  
ChannelBuffers into SocksCmdResponse. | 
class  | 
SocksInitRequestDecoder
Decodes  
ChannelBuffers into SocksInitRequest. | 
class  | 
SocksInitResponseDecoder
Decodes  
ChannelBuffers into SocksInitResponse. | 
class  | 
SocksMessageEncoder
Encodes an  
SocksMessage into a ChannelBuffer. | 
| Modifier and Type | Class and Description | 
|---|---|
class  | 
SpdyFrameCodec
A  
ChannelHandler that encodes and decodes SPDY Frames. | 
class  | 
SpdyHttpCodec
A combination of  
SpdyHttpDecoder and SpdyHttpEncoder | 
class  | 
SpdyHttpDecoder
Decodes  
SpdySynStreamFrames, SpdySynReplyFrames,
 and SpdyDataFrames into HttpRequests and HttpResponses. | 
class  | 
SpdyHttpEncoder
Encodes  
HttpRequests, HttpResponses, and HttpChunks
 into SpdySynStreamFrames and SpdySynReplyFrames. | 
class  | 
SpdyHttpResponseStreamIdHandler
SimpleChannelHandler that takes care of adding the right streamId to the
 HttpResponse if one is not present. | 
class  | 
SpdyOrHttpChooser
ChannelUpstreamHandler which is responsible to setup the ChannelPipeline either for
 HTTP or SPDY. | 
class  | 
SpdySessionHandler
Manages streams within a SPDY session. 
 | 
| Modifier and Type | Class and Description | 
|---|---|
class  | 
StringDecoder
Decodes a received  
ChannelBuffer into a String. | 
class  | 
StringEncoder
Encodes the requested  
String into a ChannelBuffer. | 
| Modifier and Type | Class and Description | 
|---|---|
class  | 
ExecutionHandler
Forwards an upstream  
ChannelEvent to an Executor. | 
| Modifier and Type | Class and Description | 
|---|---|
class  | 
IpFilteringHandlerImpl
General class that handle Ip Filtering. 
 | 
class  | 
IpFilterRuleHandler
Implementation of Filter of IP based on ALLOW and DENY rules. 
 | 
class  | 
OneIpFilterHandler
Handler that block any new connection if there are already a currently active
 channel connected with the same InetAddress (IP). 
 | 
| Modifier and Type | Class and Description | 
|---|---|
class  | 
LoggingHandler
A  
ChannelHandler that logs all events via InternalLogger. | 
| Modifier and Type | Class and Description | 
|---|---|
class  | 
BlockingReadHandler<E>
Emulates blocking read operation. 
 | 
class  | 
BufferedWriteHandler
Emulates buffered write operation. 
 | 
| Modifier and Type | Class and Description | 
|---|---|
class  | 
SslHandler
 | 
| Modifier and Type | Class and Description | 
|---|---|
class  | 
ChunkedWriteHandler
A  
ChannelHandler that adds support for writing a large data stream
 asynchronously neither spending a lot of memory nor getting
 OutOfMemoryError. | 
| Modifier and Type | Class and Description | 
|---|---|
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. | 
| Modifier and Type | Class and Description | 
|---|---|
class  | 
AbstractTrafficShapingHandler
AbstractTrafficShapingHandler allows to limit the global bandwidth
 (see  
GlobalTrafficShapingHandler) or per session
 bandwidth (see ChannelTrafficShapingHandler), as traffic shaping. | 
class  | 
ChannelTrafficShapingHandler
This implementation of the  
AbstractTrafficShapingHandler is for channel
 traffic shaping, that is to say a per channel limitation of the bandwidth. | 
class  | 
GlobalChannelTrafficShapingHandler
This implementation of the  
AbstractTrafficShapingHandler is for global
 and per channel traffic shaping, that is to say a global limitation of the bandwidth, whatever
 the number of opened channels and a per channel limitation of the bandwidth. | 
class  | 
GlobalTrafficShapingHandler
This implementation of the  
AbstractTrafficShapingHandler is for global
 traffic shaping, that is to say a global limitation of the bandwidth, whatever
 the number of opened channels. | 
Copyright © 2008-2016 The Netty Project. All Rights Reserved.