Page History

h2. Netty Component

*Available as of Camel 2.3*

The *netty* component in Camel is a socket communication component, based on the 
JBoss Netty community offering (available under an Apache 2.0 license). Netty is a 
NIO client server framework which enables quick and easy development of network applications 
such as protocol servers and clients. Netty greatly simplifies and streamlines network 
programming such as TCP and UDP socket server.

This camel component supports both producer and consumer endpoints.

The netty component has several options and allows fine-grained control of a number of 
TCP/UDP communication parameters (buffer sizes, keepAlives, tcpNoDelay etc) and facilitates 
both In-Only and In-Out communication on a Camel route.

Maven users will need to add the following dependency to their {{pom.xml}} for this component:
{code:xml}
<dependency>
    <groupId>org.apache.camel</groupId>
    <artifactId>camel-netty</artifactId>
    <version>x.x.x</version>
    <!-- use the same version as your Camel core version -->
</dependency>
{code}

h3. URI format

The URI scheme for a netty component is as follows

{code}
netty:tcp://localhost:99999[?options]
netty:udp://remotehost:99999/[?options]
{code}

This component supports producer and consumer endpoints for both TCP and UDP.

You can append query options to the URI in the following format, {{?option=value&option=value&...}}

h3. Options
{div:class=confluenceTableSmall}
|| Name || Default Value || Description ||
| {{keepAlive}} | {{true}} | boolean setting to ensure socket is not closed due to inactivity |
| {{tcpNoDelay}} | {{true}} | boolean setting to improve TCP protocol performance |
| {{broadcast}} | {{false}} | boolean setting to choose Multicast over UDP |
| {{connectTimeoutMillis}} | {{10 seconds}} | time to wait for a socket connection to be available |
| {{receiveTimeoutMillis}} | {{10 seconds}} | time to wait for a response to be received on a connection |
| {{reuseAddress}} | {{true}} | boolean setting to facilitate socket multiplexing |
| {{sync}} | {{false}} | boolean setting to set endpoint as one-way or request-response |
| {{ssl}} | {{false}} | boolean setting to specify whether SSL encryption is applied to this endpoint |
| {{sendBufferSize}} | {{65536 bytes}} | the TCP/UDP buffer sizes to be used during outbound communication |
| {{receiveBufferSize}} | {{65536 bytes}} | tthe TCP/UDP buffer sizes to be used during inbound communication |
| {{corePoolSize}} | {{10 threads}} | the number of allocated threads at component startup. Defaults to 10 |
| {{maxPoolSize}} | {{100 threads}} | the maximum number of threads that may be allocated to this endpoint. Defaults to 100 |
{div}

h3. Registry based Options

Codec Handlers and SSL Keystores can be setenlisted viain athe JNDI [Registry], thatsuch isas associatedin withthe theSpring CamelXML Contextfile.
The values that could be passed in, are the following:

{div:class=confluenceTableSmall}
|| Name || Description ||
| {{passphrase}} | password setting to use in order to encrypt/decrypt payloads sent using SSH |
| {{keyStoreFormat}} | keystore format to be used for payload encryption. Defaults to "JKS" if not set |
| {{securityProvider}} | Security provider to be used for payload encryption. Defaults to "SunX509" if not set. |
| {{keyStoreFile}} | Client side certificate keystore to be used for encryption |
| {{trustStoreFile}} | Server side certificate keystore to be used for encryption |
| {{sslHandler}} | Reference to a class that could be used to return an SSL Handler |
| {{encoder}} | A custom Handler class that can be used to perform special marshalling of outbound payloads. Must override {{org.jboss.netty.channel.ChannelDownStreamHandler}}. |
| {{encorders}} | A list of encoder to be used. You can use a String which have values separated by comma, and have the values be looked up in the [Registry]. Just remember to prefix the value with # so Camel knows it should lookup. |
| {{decoder}} | A custom Handler class that can be used to perform special marshalling of inbound payloads. Must override {{org.jboss.netty.channel.ChannelUpStreamHandler}}. |
| {{decoders}} | A list of decorder to be used. You can use a String which have values separated by comma, and have the values be looked up in the [Registry]. Just remember to prefix the value with # so Camel knows it should lookup. |
| {{handler}} | A custom Handler class that can be used to perform custom processing of Netty events triggered 
during communication. Must override {{org.jboss.netty.channel.SimpleChannelHandler}}. |
{div}

h3. Sending Messages to/from a Netty endpoint

h4.  Netty Producer 
In Producer mode, the component provides the ability to send payloads to a socket endpoint 
using either TCP or UDP protocols (with optional SSL support).

The producer mode supports both one-way and request-response based operations.

h4.  Netty Consumer
In Consumer mode, the component provides the ability to:
- listen on a specified socket using either TCP or UDP protocols (with optional SSL support),
- receive requests on the socket using text/xml, binary and serialized object based payloads and 
- send them along on a route as message exchanges.

The consumer mode supports both one-way and request-response based operations.

h3. Usage Samples

h4. A UDP Netty endpoint using Request-Reply and serialized object payload
{code}
RouteBuilder builder = new RouteBuilder() {
  public void configure() {
    from("netty:udp://localhost:5155?sync=true")
      .process(new Processor() {
         public void process(Exchange exchange) throws Exception {
           Poetry poetry = (Poetry) exchange.getIn().getBody();
           poetry.setPoet("Dr. Sarojini Naidu");
           exchange.getOut().setBody(poetry);
         }
       }
    }
};
{code}

h4. A TCP based Netty consumer endpoint using One-way communication
{code}
RouteBuilder builder = new RouteBuilder() {
  public void configure() {
       from("netty:tcp://localhost:5150")
           .to("mock:result"); 
  }
};
{code}

h4. An SSL/TCP based Netty consumer endpoint using Request-Reply communication 
{code}
JndiRegistry registry = new JndiRegistry(createJndiContext());
registry.bind("password", "changeit");
registry.bind("ksf", new File("src/test/resources/keystore.jks"));
registry.bind("tsf", new File("src/test/resources/keystore.jks"));

context.createRegistry(registry);
context.addRoutes(new RouteBuilder() {
  public void configure() {
      String netty_ssl_endpoint = 
         "netty:tcp://localhost:5150sync=true&ssl=true&passphrase=#password"
         + "&keyStoreFile=#ksf&trustStoreFile=#tsf";
      String return_string =
         "When You Go Home, Tell Them Of Us And Say,"
         + "For Your Tomorrow, We Gave Our Today.";
      
      from(netty_ssl_endpoint)
       .process(new Processor() {
          public void process(Exchange exchange) throws Exception {
            exchange.getOut().setBody(return_string);                           
          }
       }
  }
});
{code}

{include:Endpoint See Also}
 - [Mina]