diff --git a/spring-integration-reference/src/ip.xml b/spring-integration-reference/src/ip.xml index 496f59e340..af5287cf0e 100644 --- a/spring-integration-reference/src/ip.xml +++ b/spring-integration-reference/src/ip.xml @@ -170,8 +170,7 @@ To use a java.net.Socket, set using-nio to false and using-direct-buffers is not relevant. - - + using-nio to false and using-direct-buffers is not relevant. - \ No newline at end of file + +
+ IP Adapter Attributes + + + IP Outbound Channel Adapter Attributes + + + + + + + + + + Attribute Name + TCP? + UDP? + Allowed Values + Attribute Description + + + + + protocol + Y + Y + tcp, udp + Determines whether the adapter uses TCP or UDP, over IP. + + + host + Y + Y + + The host name or ip address of the destination. For multicast udp + adapters, the multicast address. + + + port + Y + Y + + The port on the destination. + + + multicast + N + Y + true, false + Whether or not the udp adapter uses multicast. + + + acknowledge + N + Y + true, false + Whether or not a udp adapter requires an acknowledment from the destination. + when enabled, requires setting the following 4 attributes. + + + ack-host + N + Y + + 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 Netword Address Transation (NAT) is + being used. + + + ack-port + N + Y + + When acknowledge is true, indicates the port to which the + acknowledgment should be sent. The adapter listens on this port for + acknowledgments. + + + ack-timeout + N + Y + + 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 + N + Y + + Defaults to 1. For multicast adapters, you can set this to a larger + value, requiring acknowlegments from multiple destinations. + + + check-length + N + Y + true, false + Whether or not a udp adapter includes a data length field in the + packet sent to the destination. + + + time-to-live + N + Y + + 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. + + + using-nio + Y + N + true, false + Whether or not the tcp adapter is using NIO. Refer to the java.nio + package for more information. + + + using-direct-buffers + Y + N + true, false + When using NIO, whether or not the tcp adapter uses direct buffers. + Refer to java.nio.ByteBuffer documentation for more information. + + + message-format + Y + N + length-header, stx-etx, crlf, custom + The formatting that the tcp adapter uses so the receiver can demarcate + messages. Defaults to length-header. + See the discussion above for details on each format. + + + custom-socket- writer-class-name + Y + N + Subclass of TcpNetSocketWriter or TcpNioSocketWriter + When message-format is 'custom' the name of the class that + implements the custom format. Must be a subclass of the TcpNxxSocketWriter, + depending on whether using-nio is false or true. + + + so-timeout + Y + Y + + See java.net.Socket and java.net.DatagramSocket + setSoTimeout() methods for more information. + + + so-send-buffer-size + Y + Y + + See java.net.Socket and java.net.DatagramSocket + setSendBufferSize() methods for more information. + + + so-receive-buffer- size + N + Y + + Used for udp acknowlegment packets. See java.net.DatagramSocket + setReceiveBufferSize() methods for more information. + + + so-keep-alive + Y + N + true, false + See java.net.Socket. setKeepAlive(). + + + so-linger + Y + N + + Sets linger to true with supplied value. + See java.net.Socket. setSoLinger(). + + + so-tcp-no-delay + Y + N + true, false + See java.net.Socket. setTcpNoDelay(). + + + so-traffic-class + Y + N + + See java.net.Socket. setTrafficClass(). + + + +
+ + IP Inbound Channel Adapter Attributes + + + + + + + + + + Attribute Name + TCP? + UDP? + Allowed Values + Attribute Description + + + + + protocol + Y + Y + tcp, udp + Determines whether the adapter uses TCP or UDP, over IP. + + + port + Y + Y + + The port on which the adapter listens. + + + multicast + N + Y + true, false + Whether or not the udp adapter uses multicast. + + + multicast-address + N + Y + + When multicast is true, the multicast address to which the adapter + joins. + + + pool-size + Y + Y + + Specifies the concurrency. For udp, specifies how many packets can + be handled concurrently. For tcp, not using nio, specifies the + number of concurrent connections supported by the adapter. For tcp, + using nio, specifies the number of tcp fragments that are concurrently + reassembled into complete messages. + + + receive-buffer-size + N + Y + + For udp, the size of the buffer used to receive DatagramPackets. + Usually set to the MTU size. If a smaller buffer is used than the + size of the sent packet, truncation can occur. This can be detected + by means of the check-length attribute. + + + check-length + N + Y + true, false + Whether or not a udp adapter expects a data length field in the + packet received. Used to detect packet truncation. + + + using-nio + Y + N + true, false + Whether or not the tcp adapter is using NIO. Refer to the java.nio + package for more information. + + + using-direct-buffers + Y + N + true, false + When using NIO, whether or not the tcp adapter uses direct buffers. + Refer to java.nio.ByteBuffer documentation for more information. + + + message-format + Y + N + length-header, stx-etx, crlf, custom + The formatting that the tcp adapter uses so the adapter can demarcate + messages. Defaults to length-header. + See the discussion above for details on each format. + + + custom-socket- reader-class-name + Y + N + Subclass of TcpNetSocketReader or TcpNioSocketReader + When message-format is 'custom' the name of the class that + implements the custom format. Must be a subclass of the TcpNxxSocketReader, + depending on whether using-nio is false or true. + + + so-timeout + Y + Y + + See java.net.Socket and java.net.DatagramSocket + setSoTimeout() methods for more information. + + + so-send-buffer-size + N + Y + + Used for udp acknowlegment packets. See java.net.DatagramSocket + setSendBufferSize() methods for more information. + + + so-receive-buffer- size + Y + Y + + See java.net.Socket and java.net.DatagramSocket + setReceiveBufferSize() methods for more information. + + + so-keep-alive + Y + N + true, false + See java.net.Socket. setKeepAlive(). + + + +
+ +
+