Skip navigation links

Netty API Reference (4.1.70.Final)

Low-level data representation 
Package Description
io.netty.buffer
Benchmarks for io.netty.buffer.
io.netty.buffer.jmh_generated  
io.netty.buffer.search
Utility classes for performing efficient substring search within ByteBuf.
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.internal
Internal utilities for channel implementations.
io.netty.channel.kqueue
BSD specific transport.
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.
io.netty.channel.unix.tests
Unix specific transport tests.
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.address
Package to dynamically replace local / remote SocketAddress.
io.netty.handler.codec
Benchmarks for io.netty.handler.codec.
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
Benchmarks for io.netty.handler.codec.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.jmh_generated  
io.netty.handler.codec.http.multipart
Benchmarks for io.netty.handler.codec.http.multipart.
io.netty.handler.codec.http.multipart.jmh_generated  
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
Benchmarks for io.netty.handler.codec.http2.
io.netty.handler.codec.http2.jmh_generated  
io.netty.handler.codec.jmh_generated  
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
Benchmarks for io.netty.handler.codec.mqtt.
io.netty.handler.codec.mqtt.jmh_generated  
io.netty.handler.codec.protobuf
Encoder and decoder which transform a Google Protocol Buffers Message and 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 codec provides asynchronous and non-blocking XML parser based on the Aalto XML parser.
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.pcap
Capture data and write into Pcap format which helps in troubleshooting.
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.ocsp
OCSP stapling, formally known as the TLS Certificate Status Request extension, is an alternative approach to the Online Certificate Status Protocol (OCSP) for checking the revocation status of X.509 digital certificates.
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.
DNS / Host resolvers 
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.
io.netty.resolver.dns.macos
MacOS specific nameserver resolution.
Utils 
Package Description
io.netty.util
Benchmarks for io.netty.util.
io.netty.util.collection  
io.netty.util.concurrent
Benchmarks for io.netty.util.concurrent.
io.netty.util.concurrent.jmh_generated  
io.netty.util.internal
Internal-use-only utilities which is not allowed to be used outside Netty.
io.netty.util.internal.logging
Internal-use-only logging API which is not allowed to be used outside Netty.
io.netty.util.jmh_generated  
Skip navigation links

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