From 63ec6e1849f9f6b77e8d7e63d70efa6742588173 Mon Sep 17 00:00:00 2001 From: Gary Russell Date: Thu, 18 Nov 2010 16:40:21 -0500 Subject: [PATCH] INT-1552 Add error-channel to IP endpoint docs --- docs/src/reference/docbook/ip.xml | 265 ++++++++++++++++-------------- 1 file changed, 146 insertions(+), 119 deletions(-) diff --git a/docs/src/reference/docbook/ip.xml b/docs/src/reference/docbook/ip.xml index ebca4d775a..f8a5f7c8f5 100644 --- a/docs/src/reference/docbook/ip.xml +++ b/docs/src/reference/docbook/ip.xml @@ -13,14 +13,14 @@
Introduction - Two flavors each of UDP inbound and outbound adapters are provided UnicastSendingMessageHandler + Two flavors each of UDP inbound and outbound channel adapters are provided UnicastSendingMessageHandler sends a datagram packet to a single destination. UnicastReceivingChannelAdapter receives incoming datagram packets. MulticastSendingMessageHandler sends (broadcasts) datagram packets to a multicast address. MulticastReceivingChannelAdapter receives incoming datagram packets by joining to a multicast address. - TCP inbound and outbound adapters are provided TcpSendingMessageHandler + TCP inbound and outbound channel adapters are provided TcpSendingMessageHandler sends messages over TCP. TcpReceivingChannelAdapter receives messages over TCP. @@ -36,6 +36,10 @@ the calling thread blocks on the connection until either a response is received or a timeout or I/O error occurs. + + The TCP and UDP inbound channel adapters, and the TCP inbound gateway, support the "error-channel" attribute. + This provides the same basic functionality as described in . +
UDP Adapters @@ -715,123 +719,6 @@ - - UDP Outbound Channel Adapter Attributes - - - - - - - - Attribute Name - Allowed Values - Attribute Description - - - - - host - - The host name or ip address of the destination. For multicast udp - adapters, the multicast address. - - - port - - The port on the destination. - - - multicast - true, false - Whether or not the udp adapter uses multicast. - - - acknowledge - true, false - Whether or not a udp adapter requires an acknowledgment from the destination. - when enabled, requires setting the following 4 attributes. - - - ack-host - - When acknowledge is true, indicates the host or ip address to which the - acknowledgment should be sent. Usually the current host, but may be - different, for example when Network Address Transation (NAT) is - being used. - - - ack-port - - When acknowledge is true, indicates the port to which the - acknowledgment should be sent. The adapter listens on this port for - acknowledgments. - - - ack-timeout - - When acknowledge is true, indicates the time in milliseconds that the - adapter will wait for an acknowlegment. If an acknowlegment is not - received in time, the adapter will throw an exception. - - - min-acks-for- success - - Defaults to 1. For multicast adapters, you can set this to a larger - value, requiring acknowlegments from multiple destinations. - - - check-length - true, false - Whether or not a udp adapter includes a data length field in the - packet sent to the destination. - - - time-to-live - - For multicast adapters, specifies the time to live attribute for - the MulticastSocket; controls the scope - of the multicasts. Refer to the Java API - documentation for more information. - - - so-timeout - - See java.net.DatagramSocket - setSoTimeout() methods for more information. - - - so-send-buffer-size - - See java.net.DatagramSocket - setSendBufferSize() methods for more information. - - - so-receive-buffer- size - - Used for udp acknowlegment packets. See java.net.DatagramSocket - setReceiveBufferSize() methods for more information. - - - local-address - - On a multi-homed system, for the UDP adapter, specifies an IP address - for the interface to which the socket will be bound for reply messages. - For a multicast adapter it is also used to determine which interface - the multicast packets will be sent over. - - - task-executor - - - Specifies a specific Executor to be used for acknowledgment handling. If not supplied, an internal - single threaded executor will be used. Needed on some platforms that require the use of specific - task executors such as a WorkManagerTaskExecutor. One thread will be dedicated to handling - acknowledgments (if the acknowledge option is true). - - - -
UDP Inbound Channel Adapter Attributes @@ -918,6 +805,130 @@ On a multi-homed system, specifies an IP address for the interface to which the socket will be bound. + + error-channel + + If a synchronous Exception is thrown by a downstream + component, the MessagingException message containing the exception + and failed message is sent to this channel. + + + +
+ + UDP Outbound Channel Adapter Attributes + + + + + + + + Attribute Name + Allowed Values + Attribute Description + + + + + host + + The host name or ip address of the destination. For multicast udp + adapters, the multicast address. + + + port + + The port on the destination. + + + multicast + true, false + Whether or not the udp adapter uses multicast. + + + acknowledge + true, false + Whether or not a udp adapter requires an acknowledgment from the destination. + when enabled, requires setting the following 4 attributes. + + + ack-host + + When acknowledge is true, indicates the host or ip address to which the + acknowledgment should be sent. Usually the current host, but may be + different, for example when Network Address Transation (NAT) is + being used. + + + ack-port + + When acknowledge is true, indicates the port to which the + acknowledgment should be sent. The adapter listens on this port for + acknowledgments. + + + ack-timeout + + When acknowledge is true, indicates the time in milliseconds that the + adapter will wait for an acknowlegment. If an acknowlegment is not + received in time, the adapter will throw an exception. + + + min-acks-for- success + + Defaults to 1. For multicast adapters, you can set this to a larger + value, requiring acknowlegments from multiple destinations. + + + check-length + true, false + Whether or not a udp adapter includes a data length field in the + packet sent to the destination. + + + time-to-live + + For multicast adapters, specifies the time to live attribute for + the MulticastSocket; controls the scope + of the multicasts. Refer to the Java API + documentation for more information. + + + so-timeout + + See java.net.DatagramSocket + setSoTimeout() methods for more information. + + + so-send-buffer-size + + See java.net.DatagramSocket + setSendBufferSize() methods for more information. + + + so-receive-buffer- size + + Used for udp acknowlegment packets. See java.net.DatagramSocket + setReceiveBufferSize() methods for more information. + + + local-address + + On a multi-homed system, for the UDP adapter, specifies an IP address + for the interface to which the socket will be bound for reply messages. + For a multicast adapter it is also used to determine which interface + the multicast packets will be sent over. + + + task-executor + + + Specifies a specific Executor to be used for acknowledgment handling. If not supplied, an internal + single threaded executor will be used. Needed on some platforms that require the use of specific + task executors such as a WorkManagerTaskExecutor. One thread will be dedicated to handling + acknowledgments (if the acknowledge option is true). +
@@ -950,6 +961,13 @@ incoming messages on the connection created by the outbound adapter. + + error-channel + + If a synchronous Exception is thrown by a downstream + component, the MessagingException message containing the exception + and failed message is sent to this channel. + @@ -1022,6 +1040,15 @@ The time in milliseconds for which the gateway will wait for a reply. + + error-channel + + If a synchronous Exception is thrown by a downstream + component, the MessagingException message containing the exception + and failed message is sent to this channel; + any reply from that flow will then be returned as a response by + the gateway. +