Please get started with the user guide and the API reference below. Also, please feel free to join the community to get more information.
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.
| Fundamental |
Echo - the very basic client and server Discard - prevent OutOfMemoryError which is caused by writing too fast |
|---|---|
| Text protocols |
Telnet - a classic line-based network application Quote of the Moment - broadcast UDP/IP client and server SecureChat - an SSL chat server derived from the Telnet example |
| Binary protocols |
ObjectEcho - exchange serializable Java objects Factorial - write a stateful client / server based on custom binary protocol |
| Standard protocols |
HTTP (Snoop) - build your own extremely light-weight HTTP client and server HTTP (File Server) - asynchronous large file streaming in HTTP |
| Cool stuff | LocalTime - rapid protocol prototyping with Google Protocol Buffers integration |
| Advanced | Proxy Server - write a highly efficient NIO proxy server |
Do you need more real world examples, tutorials, and blog posts? Please visit our wiki space to browse a collection of user contributed resources. You can also leave comments on them and add more wiki pages to contribute to and interact with the community. Please note that you need to login with your JBoss.org account (register here to get one.)
Netty distribution file contains a full set of source code and Maven project (pom.xml) so that you can build and run all the examples above in your favorite IDE.
NetBeans and IntelliJ support Maven out of the box, so you should not have a problem importing the project into your IDE.
Eclipse does not support Maven out of the box yet, and therefore you need to use Eclipse IAM (update site) or m2eclipse, or generate the Eclipse project files in the command line as follows:
$ tar zxvf netty-X.Y.Z.QQ-dist.tar.gz $ cd netty-X.Y.Z.QQ $ mvn eclipse:eclipse compile # .project and .classpath files are generated.