Netty API Reference (4.1.7.Final)

Low-level data representation 
Package Description
io.netty.buffer
Abstraction of a byte buffer - the fundamental data structure to represent a low-level binary and text message.
Central interface for all I/O operations 
Package Description
io.netty.channel
The core channel API which is asynchronous and event-driven abstraction of various transports such as a NIO Channel.
io.netty.channel.embedded
A virtual Channel that helps wrapping a series of handlers to unit test the handlers or use them in non-I/O context.
io.netty.channel.epoll
Optimized transport for linux which uses EPOLL Edge-Triggered Mode for maximal performance.
io.netty.channel.group
A channel registry which helps a user maintain the list of open Channels and perform bulk operations on them.
io.netty.channel.local
A virtual transport that enables the communication between the two parties in the same virtual machine.
io.netty.channel.nio
NIO-based channel API implementation - recommended for a large number of connections (>= 1000).
io.netty.channel.oio
Old blocking I/O based channel API implementation - recommended for a small number of connections (< 1000).
io.netty.channel.pool
Implementations and API for Channel pools.
io.netty.channel.rxtx
A serial and parallel port communication transport based on RXTX.
io.netty.channel.sctp
Abstract SCTP socket interfaces which extend the core channel API.
io.netty.channel.sctp.nio
NIO-based SCTP Channel API implementation - recommended for a large number of connections (>= 1000).
io.netty.channel.sctp.oio
Old blocking I/O based SCTP channel API implementation - recommended for a small number of connections (< 1000).
io.netty.channel.socket
Abstract TCP and UDP socket interfaces which extend the core channel API.
io.netty.channel.socket.nio
NIO-based socket channel API implementation - recommended for a large number of connections (>= 1000).
io.netty.channel.socket.oio
Old blocking I/O based socket channel API implementation - recommended for a small number of connections (< 1000).
io.netty.channel.udt
UDT Transport.
io.netty.channel.udt.nio
UDT Transport for NIO Channels.
io.netty.channel.unix
Unix specific transport.
Client & Server bootstrapping utilities 
Package Description
io.netty.bootstrap
The helper classes with fluent API which enable an easy implementation of typical client side and server side channel initialization.
Reusable I/O event interceptors 
Package Description
io.netty.handler.codec
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.
io.netty.handler.codec.base64
Encoder and decoder which transform a Base64-encoded String or ByteBuf into a decoded ByteBuf and vice versa.
io.netty.handler.codec.bytes
Encoder and decoder which transform an array of bytes into a ByteBuf and vice versa.
io.netty.handler.codec.compression
Encoder and decoder which compresses and decompresses ByteBufs in a compression format such as zlib, gzip, and Snappy.
io.netty.handler.codec.dns
DNS codec.
io.netty.handler.codec.haproxy
Decodes an HAProxy proxy protocol header
io.netty.handler.codec.http
Encoder, decoder and their related message types for HTTP.
io.netty.handler.codec.http.cookie
This package contains Cookie related classes.
io.netty.handler.codec.http.cors
This package contains Cross Origin Resource Sharing (CORS) related classes.
io.netty.handler.codec.http.multipart
HTTP multipart support.
io.netty.handler.codec.http.websocketx
Encoder, decoder, handshakers and their related message types for Web Socket data frames.
io.netty.handler.codec.http.websocketx.extensions
Encoder, decoder, handshakers to handle WebSocket Extensions.
io.netty.handler.codec.http.websocketx.extensions.compression
Encoder, decoder, handshakers to handle most common WebSocket Compression Extensions.
io.netty.handler.codec.http2
Handlers for sending and receiving HTTP/2 frames.
io.netty.handler.codec.json
JSON specific codecs.
io.netty.handler.codec.marshalling
Decoder and Encoder which uses JBoss Marshalling.
io.netty.handler.codec.memcache
Common superset of ascii and binary classes.
io.netty.handler.codec.memcache.binary
Implementations and Interfaces for the Memcache Binary protocol.
io.netty.handler.codec.mqtt
Encoder, decoder and different Message Types for MQTT.
io.netty.handler.codec.protobuf
Encoder and decoder which transform a Google Protocol Buffers Message and com.google.protobuf.nano.MessageNano into a ByteBuf and vice versa.
io.netty.handler.codec.redis
Encoder, decoder for Redis.
io.netty.handler.codec.rtsp
An RTSP extension based on the HTTP codec.
io.netty.handler.codec.sctp
Decoder and encoders to manage message completion and multi-streaming codec in SCTP/IP.
io.netty.handler.codec.serialization
Encoder, decoder and their compatibility stream implementations which transform a Serializable object into a byte buffer and vice versa.
io.netty.handler.codec.smtp
SMTP codec.
io.netty.handler.codec.socks
Encoder, decoder and their related message types for Socks.
io.netty.handler.codec.socksx
Encoder, decoder and their related message types for SOCKS protocol.
io.netty.handler.codec.socksx.v4
Encoder, decoder and their related message types for SOCKSv4 protocol.
io.netty.handler.codec.socksx.v5
Encoder, decoder and their related message types for SOCKSv5 protocol.
io.netty.handler.codec.spdy
Encoder, decoder, session handler and their related message types for the SPDY protocol.
io.netty.handler.codec.stomp
STOMP codec
io.netty.handler.codec.string
Encoder and decoder which transform a String into a ByteBuf and vice versa.
io.netty.handler.codec.xml
Xml specific codecs.
io.netty.handler.flow
Package to control the flow of messages.
io.netty.handler.flush
Package to control flush behavior.
io.netty.handler.ipfilter
Package to filter IP addresses (allow/deny).
io.netty.handler.logging
Logs the I/O events for debugging purpose.
io.netty.handler.proxy
Adds support for client connections via proxy protocols such as SOCKS and HTTP CONNECT tunneling
io.netty.handler.ssl
SSL · TLS implementation based on SSLEngine
io.netty.handler.ssl.util
Utility classes that helps easier development of TLS/SSL applications.
io.netty.handler.stream
Writes very large data stream asynchronously neither spending a lot of memory nor getting OutOfMemoryError.
io.netty.handler.timeout
Adds support for read and write timeout and idle connection notification using a Timer.
io.netty.handler.traffic
Implementation of a Traffic Shaping Handler and Dynamic Statistics.
Miscellaneous 
Package Description
io.netty.util
Utility classes used across multiple packages.
io.netty.util.collection  
io.netty.util.concurrent
Utility classes for concurrent / async tasks.
Other Packages 
Package Description
io.netty.resolver
Resolves an arbitrary string that represents the name of an endpoint into an address.
io.netty.resolver.dns
An alternative to Java's built-in domain name lookup mechanism that resolves a domain name asynchronously, which supports the queries of an arbitrary DNS record type as well.

Copyright © 2008–2017 The Netty Project. All rights reserved.