Netty

Socket level networking using TCP or UDP with Netty 4.x.

Metadata

Property	Value
Scheme	`netty`
Support Level	Stable
Labels	networking
Version	4.20.0 (CEQ 3.36.0)

Maven Dependency

<dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-netty</artifactId>
    <version>4.20.0 (CEQ 3.36.0)</version>
</dependency>

Endpoint Properties

Name	Type	Required	Default	Description
`protocol`	enum	✓		The protocol to use which can be tcp or udp
`host`	string	✓		The hostname. For the consumer the hostname is localhost or 0.0.0.0. For the producer the hostname is the remote host to connect to.
`port`	integer	✓		The host port number
`disconnect`	boolean		`false`	Whether or not to disconnect(close) from Netty Channel right after use.
`keepAlive`	boolean		`true`	Setting to ensure socket is not closed due to inactivity
`reuseAddress`	boolean		`true`	Setting to facilitate socket multiplexing
`reuseChannel`	boolean		`false`	This option allows producers and consumers (in client mode) to reuse the same Netty Channel for the lifecycle of processing the Exchange. This is useful if you need to call a server multiple times in a Camel route and want to use the same network connection. When using this, the channel is not returned to the connection pool until the Exchange is done; or disconnected if the disconnect option is set to true. The reused Channel is stored on the Exchange as an exchange property with the key CamelNettyChannel which allows you to obtain the channel during routing and use it as well.
`sync`	boolean		`true`	Setting to set endpoint as one-way (false) or request-response (true)
`tcpNoDelay`	boolean		`true`	Setting to improve TCP protocol performance
`networkInterface`	string			When using UDP then this option can be used to specify a network interface by its name, such as eth0 to join a multicast group.
`clientMode`	boolean		`false`	If the clientMode is true, netty consumer will connect the address as a TCP client.
`reconnect`	boolean		`true`	Used only in clientMode in consumer, the consumer will attempt to reconnect on disconnection if this is enabled
`reconnectInterval`	integer		`10000`	Used if reconnect and clientMode is enabled. The interval in milli seconds to attempt reconnection
`backlog`	integer			Allows to configure a backlog for netty consumer (server). Note the backlog is just a best effort depending on the OS. Setting this option to a value such as 200, 500 or 1000, tells the TCP stack how long the accept queue can be If this option is not configured, then the backlog depends on OS setting.
`bossCount`	integer		`1`	When netty works on nio mode, it uses default bossCount parameter from Netty, which is 1. User can use this option to override the default bossCount from Netty
`bossGroup`	object			Set the BossGroup which could be used for handling the new connection of the server side across the NettyEndpoint
`bridgeErrorHandler`	boolean		`false`	Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored.
`broadcast`	boolean		`false`	Setting to choose Multicast over UDP
`disconnectOnNoReply`	boolean		`true`	If sync is enabled then this option dictates NettyConsumer if it should disconnect where there is no reply to send back.
`exceptionHandler`	object			To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored.
`exchangePattern`	enum			Sets the exchange pattern when the consumer creates an exchange.
`nettyServerBootstrapFactory`	object			To use a custom NettyServerBootstrapFactory
`noReplyLogLevel`	enum		`WARN`	If sync is enabled this option dictates NettyConsumer which logging level to use when logging a there is no reply to send back.
`serverClosedChannelExceptionCaughtLogLevel`	enum		`DEBUG`	If the server (NettyConsumer) catches an java.nio.channels.ClosedChannelException then its logged using this logging level. This is used to avoid logging the closed channel exceptions, as clients can disconnect abruptly and then cause a flood of closed exceptions in the Netty server.
`serverExceptionCaughtLogLevel`	enum		`WARN`	If the server (NettyConsumer) catches an exception then its logged using this logging level.
`serverInitializerFactory`	object			To use a custom ServerInitializerFactory
`usingExecutorService`	boolean		`true`	Whether to use ordered thread pool, to ensure events are processed orderly on the same channel.
`connectTimeout`	integer		`10000`	Time to wait for a socket connection to be available. Value is in milliseconds.
`requestTimeout`	integer			Allows to use a timeout for the Netty producer when calling a remote server. By default no timeout is in use. The value is in milli seconds, so eg 30000 is 30 seconds. The requestTimeout is using Netty's ReadTimeoutHandler to trigger the timeout.
`clientInitializerFactory`	object			To use a custom ClientInitializerFactory
`correlationManager`	object			To use a custom correlation manager to manage how request and reply messages are mapped when using request/reply with the netty producer. This should only be used if you have a way to map requests together with replies such as if there is correlation ids in both the request and reply messages. This can be used if you want to multiplex concurrent messages on the same channel (aka connection) in netty. When doing this you must have a way to correlate the request and reply messages so you can store the right reply on the inflight Camel Exchange before its continued routed. We recommend extending the TimeoutCorrelationManagerSupport when you build custom correlation managers. This provides support for timeout and other complexities you otherwise would need to implement as well. See also the producerPoolEnabled option for more details.
`lazyChannelCreation`	boolean		`true`	Channels can be lazily created to avoid exceptions, if the remote server is not up and running when the Camel producer is started.
`lazyStartProducer`	boolean		`false`	Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel's routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.
`producerPoolBlockWhenExhausted`	boolean		`true`	Sets the value for the blockWhenExhausted configuration attribute. It determines whether to block when the borrowObject() method is invoked when the pool is exhausted (the maximum number of active objects has been reached).
`producerPoolEnabled`	boolean		`true`	Whether producer pool is enabled or not. Important: If you turn this off then a single shared connection is used for the producer, also if you are doing request/reply. That means there is a potential issue with interleaved responses if replies comes back out-of-order. Therefore you need to have a correlation id in both the request and reply messages so you can properly correlate the replies to the Camel callback that is responsible for continue processing the message in Camel. To do this you need to implement NettyCamelStateCorrelationManager as correlation manager and configure it via the correlationManager option. See also the correlationManager option for more details.
`producerPoolMaxIdle`	integer		`100`	Sets the cap on the number of idle instances in the pool.
`producerPoolMaxTotal`	integer		`-1`	Sets the cap on the number of objects that can be allocated by the pool (checked out to clients, or idle awaiting checkout) at a given time. Use a negative value for no limit. Be careful to not set this value too low (such as 1) as the pool must have space to create a producer such as when performing retries. Be mindful that the option producerPoolBlockWhenExhausted is default true, and the pool will then block when there is no space, which can lead to the application to hang.
`producerPoolMaxWait`	integer		`-1`	Sets the maximum duration (value in millis) the borrowObject() method should block before throwing an exception when the pool is exhausted and producerPoolBlockWhenExhausted is true. When less than 0, the borrowObject() method may block indefinitely.
`producerPoolMinEvictableIdle`	integer		`300000`	Sets the minimum amount of time (value in millis) an object may sit idle in the pool before it is eligible for eviction by the idle object evictor.
`producerPoolMinIdle`	integer			Sets the minimum number of instances allowed in the producer pool before the evictor thread (if active) spawns new objects.
`udpConnectionlessSending`	boolean		`false`	This option supports connection less udp sending which is a real fire and forget. A connected udp send receive the PortUnreachableException if no one is listen on the receiving port.
`useByteBuf`	boolean		`false`	If the useByteBuf is true, netty producer will turn the message body into ByteBuf before sending it out.
`allowSerializedHeaders`	boolean		`false`	Only used for TCP when transferExchange is true. When set to true, serializable objects in headers and properties will be added to the exchange. Otherwise Camel will exclude any non-serializable objects and log it at WARN level.
`channelGroup`	object			To use an explicit ChannelGroup.
`nativeTransport`	boolean		`false`	Whether to use native transport instead of NIO. Native transport takes advantage of the host operating system and is only supported on some platforms. You need to add the netty JAR for the host operating system you are using. See more details at: http://netty.io/wiki/native-transports.html
`options`	object			Allows to configure additional netty options using option. as prefix. For example option.child.keepAlive=false. See the Netty documentation for possible options that can be used. This is a multi-value option with prefix: option.
`receiveBufferSize`	integer		`65536`	The TCP/UDP buffer sizes to be used during inbound communication. Size is bytes.
`receiveBufferSizePredictor`	integer			Configures the buffer size predictor. See details at Jetty documentation and this mail thread.
`sendBufferSize`	integer		`65536`	The TCP/UDP buffer sizes to be used during outbound communication. Size is bytes.
`shutdownTimeout`	integer		`100`	Shutdown await timeout in milliseconds
`synchronous`	boolean		`false`	Sets whether synchronous processing should be strictly used
`transferExchange`	boolean		`false`	Only used for TCP. You can transfer the exchange over the wire instead of just the body. The following fields are transferred: In body, Out body, fault body, In headers, Out headers, fault headers, exchange properties, exchange exception. This requires that the objects are serializable. Camel will exclude any non-serializable objects and log it at WARN level.
`udpByteArrayCodec`	boolean		`false`	For UDP only. If enabled the using byte array codec instead of Java serialization protocol.
`unixDomainSocketPath`	string			Path to unix domain socket to use instead of inet socket. Host and port parameters will not be used, however required. It is ok to set dummy values for them. Must be used with nativeTransport=true and clientMode=false.
`workerCount`	integer			When netty works on nio mode, it uses default workerCount parameter from Netty (which is cpu_core_threads x 2). User can use this option to override the default workerCount from Netty.
`workerGroup`	object			To use a explicit EventLoopGroup as the boss thread pool. For example to share a thread pool with multiple consumers or producers. By default each consumer or producer has their own worker pool with 2 x cpu count core threads.
`allowDefaultCodec`	boolean		`true`	The netty component installs a default codec if both, encoder/decoder is null and textline is false. Setting allowDefaultCodec to false prevents the netty component from installing a default codec as the first element in the filter chain.
`autoAppendDelimiter`	boolean		`true`	Whether or not to auto append missing end delimiter when sending using the textline codec.
`decoderMaxLineLength`	integer		`1024`	The max line length to use for the textline codec.
`decoders`	string			A list of decoders 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.
`delimiter`	enum		`LINE`	The delimiter to use for the textline codec. Possible values are LINE and NULL.
`encoders`	string			A list of encoders 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.
`encoding`	string			The encoding (a charset name) to use for the textline codec. If not provided, Camel will use the JVM default Charset.
`textline`	boolean		`false`	Only used for TCP. If no codec is specified, you can use this flag to indicate a text line based codec; if not specified or the value is false, then Object Serialization is assumed over TCP - however only Strings are allowed to be serialized by default.
`enabledProtocols`	string		`TLSv1.2,TLSv1.3`	Which protocols to enable when using SSL
`hostnameVerification`	boolean		`false`	To enable/disable hostname verification on SSLEngine
`keyStoreFormat`	string			Keystore format to be used for payload encryption. Defaults to JKS if not set
`keyStoreResource`	string			Client side certificate keystore to be used for encryption. Is loaded by default from classpath, but you can prefix with classpath:, file:, or http: to load the resource from different systems.
`needClientAuth`	boolean		`false`	Configures whether the server needs client authentication when using SSL.
`passphrase`	string			Password to use for the keyStore and trustStore. The same password must be configured for both resources.
`securityProvider`	string			Security provider to be used for payload encryption. Defaults to SunX509 if not set.
`ssl`	boolean		`false`	Setting to specify whether SSL encryption is applied to this endpoint
`sslClientCertHeaders`	boolean		`false`	When enabled and in SSL mode, then the Netty consumer will enrich the Camel Message with headers having information about the client certificate such as subject name, issuer name, serial number, and the valid date range.
`sslContextParameters`	object			To configure security using SSLContextParameters
`sslHandler`	object			Reference to a class that could be used to return an SSL Handler
`trustStoreResource`	string			Server side certificate keystore to be used for encryption. Is loaded by default from classpath, but you can prefix with classpath:, file:, or http: to load the resource from different systems.