Documentation
Get started with the user guide and the API reference. Also, join the community to get more information.
-
Version 5.0
(Development)
- User guide
- API reference (Javadoc)
- Source code (Xref)
- New and Noteworthy
-
Version 4.2
(Development)
- User guide
- API reference (Javadoc)
- Source code (Xref)
- New and Noteworthy
-
Version 4.1
(Stable, Recommended)
- User guide
- API reference (Javadoc)
- Source code (Xref)
- New and Noteworthy
-
Version 4.0
(Development)
- User guide
- API reference (Javadoc)
- Source code (Xref)
- New and Noteworthy
-
Version 3.10
(Development)
- User guide
- API reference (Javadoc)
- Source code (Xref)
3rd-party articles
We often find there are people in the world who are much more talented in technical writing than we, and they kindly wrote great articles for the community.
Examples
There are several examples to help your experience with Netty. It is recommended to start from the first one and to finish to the last one. You also might want to browse the complete list of examples: 5.0, 4.2, 4.1, 4.0, and 3.10.
Fundamental
- Echo ‐ the very basic client and server
- Discard ‐ see how to send an infinite data stream asynchronously without flooding the write buffer
- Uptime ‐ implement automatic reconnection mechanism
Text protocols
- Telnet ‐ a classic line-based network application
- Quote of the Moment ‐ broadcast a UDP/IP packet
- SecureChat ‐ an TLS-based chat server, derived from the Telnet example
Binary protocols
- ObjectEcho ‐ exchange serializable Java objects
- Factorial ‐ write a stateful client and server with a custom binary protocol
- WorldClock ‐ rapid protocol prototyping with Google Protocol Buffers integration
HTTP
- Snoop ‐ build your own extremely light-weight HTTP client and server
- File server ‐ asynchronous large file streaming in HTTP
- Web Sockets (Client & Server) ‐ add a two-way full-duplex communication channel to HTTP using Web Sockets
- SPDY (Client & Server) ‐ implement SPDY protocol
- CORS demo ‐ implement cross-origin resource sharing
Advanced
- Proxy server ‐ write a highly efficient tunneling proxy server
- Port unification ‐ run services with different protocols on a single TCP/IP port
UDT
- Byte streams ‐ use UDT in TCP-like byte streaming mode
- Message flow ‐ use UDT in UDP-like message delivery mode
- Byte streams in symmetric peer-to-peer rendezvous connect mode
- Message flow in symmetric peer-to-peer rendezvous connect mode
Fundamental
- Echo ‐ the very basic client and server
- Discard ‐ see how to send an infinite data stream asynchronously without flooding the write buffer
- Uptime ‐ implement automatic reconnection mechanism
Text protocols
- Telnet ‐ a classic line-based network application
- Quote of the Moment ‐ broadcast a UDP/IP packet
- SecureChat ‐ an TLS-based chat server, derived from the Telnet example
Binary protocols
- ObjectEcho ‐ exchange serializable Java objects
- Factorial ‐ write a stateful client and server with a custom binary protocol
- WorldClock ‐ rapid protocol prototyping with Google Protocol Buffers integration
HTTP
- Snoop ‐ build your own extremely light-weight HTTP client and server
- File server ‐ asynchronous large file streaming in HTTP
- Web Sockets (Client & Server) ‐ add a two-way full-duplex communication channel to HTTP using Web Sockets
- SPDY (Client & Server) ‐ implement SPDY protocol
- CORS demo ‐ implement cross-origin resource sharing
Advanced
- Proxy server ‐ write a highly efficient tunneling proxy server
- Port unification ‐ run services with different protocols on a single TCP/IP port
UDT
- Byte streams ‐ use UDT in TCP-like byte streaming mode
- Message flow ‐ use UDT in UDP-like message delivery mode
- Byte streams in symmetric peer-to-peer rendezvous connect mode
- Message flow in symmetric peer-to-peer rendezvous connect mode
Fundamental
- Echo ‐ the very basic client and server
- Discard ‐ see how to send an infinite data stream asynchronously without flooding the write buffer
- Uptime ‐ implement automatic reconnection mechanism
Text protocols
- Telnet ‐ a classic line-based network application
- Quote of the Moment ‐ broadcast a UDP/IP packet
- SecureChat ‐ an TLS-based chat server, derived from the Telnet example
Binary protocols
- ObjectEcho ‐ exchange serializable Java objects
- Factorial ‐ write a stateful client and server with a custom binary protocol
- WorldClock ‐ rapid protocol prototyping with Google Protocol Buffers integration
HTTP
- Snoop ‐ build your own extremely light-weight HTTP client and server
- File server ‐ asynchronous large file streaming in HTTP
- Web Sockets (Client & Server) ‐ add a two-way full-duplex communication channel to HTTP using Web Sockets
- SPDY (Client & Server) ‐ implement SPDY protocol
- CORS demo ‐ implement cross-origin resource sharing
Advanced
- Proxy server ‐ write a highly efficient tunneling proxy server
- Port unification ‐ run services with different protocols on a single TCP/IP port
UDT
- Byte streams ‐ use UDT in TCP-like byte streaming mode
- Message flow ‐ use UDT in UDP-like message delivery mode
- Byte streams in symmetric peer-to-peer rendezvous connect mode
- Message flow in symmetric peer-to-peer rendezvous connect mode
Fundamental
- Echo ‐ the very basic client and server
- Discard ‐ see how to send an infinite data stream asynchronously without flooding the write buffer
- Uptime ‐ implement automatic reconnection mechanism
Text protocols
- Telnet ‐ a classic line-based network application
- Quote of the Moment ‐ broadcast a UDP/IP packet
- SecureChat ‐ an TLS-based chat server, derived from the Telnet example
Binary protocols
- ObjectEcho ‐ exchange serializable Java objects
- Factorial ‐ write a stateful client and server with a custom binary protocol
- WorldClock ‐ rapid protocol prototyping with Google Protocol Buffers integration
HTTP
- Snoop ‐ build your own extremely light-weight HTTP client and server
- File server ‐ asynchronous large file streaming in HTTP
- Web Sockets (Client & Server) ‐ add a two-way full-duplex communication channel to HTTP using Web Sockets
- SPDY (Client & Server) ‐ implement SPDY protocol
- CORS demo ‐ implement cross-origin resource sharing
Advanced
- Proxy server ‐ write a highly efficient tunneling proxy server
- Port unification ‐ run services with different protocols on a single TCP/IP port
UDT
- Byte streams ‐ use UDT in TCP-like byte streaming mode
- Message flow ‐ use UDT in UDP-like message delivery mode
- Byte streams in symmetric peer-to-peer rendezvous connect mode
- Message flow in symmetric peer-to-peer rendezvous connect mode
Fundamental
- Echo ‐ the very basic client and server
- Discard ‐ see how to send an infinite data stream asynchronously without flooding the write buffer
- Uptime ‐ implement automatic reconnection mechanism
Text protocols
- Telnet ‐ a classic line-based network application
- Quote of the Moment ‐ broadcast a UDP/IP packet
- SecureChat ‐ an TLS-based chat server, derived from the Telnet example
Binary protocols
- ObjectEcho ‐ exchange serializable Java objects
- Factorial ‐ write a stateful client and server with a custom binary protocol
- WorldClock ‐ rapid protocol prototyping with Google Protocol Buffers integration
HTTP
- Snoop ‐ build your own extremely light-weight HTTP client and server
- File server ‐ asynchronous large file streaming in HTTP
- Web Sockets (Client & Server) ‐ add a two-way full-duplex communication channel to HTTP using Web Sockets
Advanced
- Proxy server ‐ write a highly efficient tunneling proxy server
- Port unification ‐ run services with different protocols on a single TCP/IP port