The Netty Project API Reference (3.8.2.Final)

The Netty project is an effort to provide an asynchronous event-driven network application framework and tools for rapid development of maintainable high performance and high scalability protocol servers and clients. In other words, Netty is a NIO client server framework which enables quick and easy development of network applications such as protocol servers and clients. It greatly simplifies and streamlines network programming such as TCP/IP socket server.

See: Description

Low-level data representation 
Package Description
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
The core channel API which is asynchronous and event-driven abstraction of various transports such as a NIO Channel.
A channel registry which helps a user maintain the list of open Channels and perform bulk operations on them.
A virtual transport that enables the communication between the two parties in the same virtual machine.
Abstract TCP and UDP socket interfaces which extend the core channel API.
An HTTP-based client-side SocketChannel and its corresponding server-side Servlet implementation that make your existing server application work in a firewalled network.
NIO-based socket channel API implementation - recommended for a large number of connections (>= 1000).
Old blocking I/O based socket channel API implementation - recommended for a small number of connections (< 1000).
Client & Server bootstrapping utilities 
Package Description
IoC/DI friendly helper classes which enable an easy implementation of typical client side and server side channel initialization.
Reusable I/O event interceptors 
Package Description
Base package for codecs
Encoder and decoder which transform a Base64-encoded String or ChannelBuffer into a decoded ChannelBuffer and vice versa.
Encoder and decoder which compresses and decompresses ChannelBuffers in a compression format such as zlib and gzip.
A helper that wraps an encoder or a decoder so that they can be used without doing actual I/O in unit tests or higher level codecs.
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.
Encoder, decoder and their related message types for HTTP.
HTTP multipart support.
Encoder, decoder, handshakers and their related message types for Web Socket data frames.
Decoder and Encoder which uses JBoss Marshalling.
Simplistic abstract classes which help implement encoder and decoder that transform an object into another object and vice versa.
Encoder and decoder which transform a Google Protocol Buffers Message into a ChannelBuffer and vice versa.
Specialized variation of FrameDecoder which enables implementation of a non-blocking decoder in the blocking I/O paradigm.
An RTSP extension based on the HTTP codec.
Encoder, decoder and their compatibility stream implementations which transform a Serializable object into a byte buffer and vice versa.
Encoder, decoder and their related message types for Socks.
Encoder, decoder, session handler and their related message types for the SPDY protocol.
Encoder and decoder which transform a String into a ChannelBuffer and vice versa.
Executor-based implementation of various thread models that separate business logic from I/O threads
Implementation of a Ip based Filter handlers.
Logs a ChannelEvent for debugging purpose using an InternalLogger.
The special-purpose handlers that store an event into an internal queue instead of propagating the event immediately.
SSL · TLS implementation based on SSLEngine
Writes very large data stream asynchronously neither spending a lot of memory nor getting OutOfMemoryError.
Adds support for read and write timeout and idle connection notification using a Timer.
Implementation of a Traffic Shaping Handler and Dynamic Statistics.
Package Description
Simplistic internal-use-only logging layer which allows a user to decide what logging framework Netty should use.
Utility classes used across multiple packages.

Copyright © 2008-2014 The Netty Project. All Rights Reserved.