[CONF] Apache ActiveMQ > TCP Transport Reference

[Paul Gale (Confluence)]

Title: Message Title

Paul Gale edited a page

Change comment: Added missing entries, sorted options alphabetically, introduced consistent formatting and reworded some definitions. TCP Transport Reference ... The TCP transport allows clients to connect to a remote ActiveMQ broker using a TCP socket. These configuration options are can be used to tune the underlying TCP transport , and can be configured on a on either the client-side using the JMS client's connection URI string or on a Brokers broker's transport bind connector URI. The options below should be prefixed with transport.* when used on the server-side; for example, on a broker's transport connector definition. On the client-side, however, the transport.* prefix must be omitted. Configuration Syntax tcp://hostname:port?key=value Transport Options minmumWireFormatVersion Tells the transport thread to run as a daemon or not. Useful to enable when embedding properly useLocalHost When . Ensures connections don't time out on TCP level. Not used by InactivityMonitor! client only) The preferred Differentiated Services traffic class to be set on outgoing packets, as described in RFC 2475. Valid integer values: [0,64). Valid string values: EF, AF[1-3][1-4] or CS[0-7]. With JDK 6, only works when the Java Runtime uses the IPv4 stack, which can be done by setting the java.net.preferIPv4Stack system property to be true. Cannot be used at the same time as the typeOfService option client Java Runtime uses , which can be done by setting the system property to be true. Cannot be used at the same time as the diffServ option When true, the TCP_NODELAY setting is enabled on the socket. Option Name Default Value Description backlog 0 The minimum version wireformat that is allowed trace false Causes all commands that are sent over the transport to be logged (to view use config of the form: log4j.logger.org.apache.activemq.transport.TransportLogger=DEBUG) daemon false 5000 Specifies the maximum number of connections waiting to be accepted by the transport server socket. closeAsync true If true the socket close call happens asynchronously. This parameter should be set to false for protocols like STOMP, that are commonly used in situations where a new connection is created for each read or write. Doing so ensures the socket close call happens synchronously. A synchronous close prevents the broker from running out of available sockets owing to the rapid cycling of connections.  connectionTimeout 30000 If >=1 the value sets the connection timeout in milliseconds. A value of zero denotes no timeout. Negative values are ignored. daemon false If true the transport thread will run in daemon mode. Set this parameter to true when embedding the broker in a Spring container or a web container to allow the container to shut down correctly. diffServ false When true, it causes the local machines name to resolve to "localhost". socketBufferSize 64 * 1024 Sets the socket buffer size in bytes keepAlive false 0 (Client only) The preferred Differentiated Services traffic class to be set on outgoing packets, as described in RFC 2475. Valid integer values: [0,64). Valid string values: EF, AF[1-3][1-4] or CS[0-7]. With JDK 6, only works when the JVM uses the IPv4 stack. To use the IPv4 stack set the system property java.net.preferIPv4Stack=true. It is invalid to specify both diffServ and typeOfService since they share the same position in the TCP/IP packet headers. dynamicManagement false If true the TransportLogger can be managed by JMX.  ioBufferSize 8 * 1024 Specifies the size of the buffer to be used between the TCP layer and the OpenWire layer where wireFormat based marshaling occurs. jmxPort 1099 Specifies the port that will be used by the JMX server to manage the TransportLoggers. This should only be set in an URI by a client (producer or consumer) since a broker will already create a JMX server. Specifying an alternate JMX port useful for developers that test a broker and client on the same machine and need to control both via JMX. In such cases a different JMX port is needed. keepAlive false If true, enables TCP KeepAlive on the broker connection useKeepAlive true Whether or not the InactivityMonitor should send KeepAliveInfo messages on idle connections. Enabled by default. to prevent connections from timing out at the TCP level. This should not be confused with KeepAliveInfo messages as used by the InactivityMonitor. logWriterName default Sets the name of the LogWriter implementation to use. Names are mapped to classes in the resources/META-INF/services/org/apache/activemq/transport/logwriters directory maximumConnections Integer.MAX_VALUE The maximum number of sockets allowed for this broker. minmumWireFormatVersion 0 The minimum remote wireFormat version that will be accepted (note the misspelling). A value of zero denotes no checking of the remote wireFormat version. If the remote wireFormat version is lower than the configured minimum acceptable version an exception is thrown and the connection attempt is refused. socketBufferSize 64 * 1024 Sets the size in bytes for the accepted socket's read and write buffers. soLinger Integer.MIN_VALUE Sets the socket's option soLinger when the value is > -1. When the value is -1 the soLinger socket option is disabled (since 5.6.0). soTimeout 0 Sets the socket's read timeout in milliseconds. A value of zero denotes no timeout. soWriteTimeout 0 Sets the socket's write timeout in milliseconds. If a socketWrite() the socket write operation does not succeed within complete before the specified timeout, the socket is will be closed. connectionTimeout 30000 A non-zero value specifies the connection timeout in milliseconds. A zero value means wait forever for the connection to be established. Negative values are ignored. wireFormat default The name of the WireFormat to use wireFormat.*   All the properties with this prefix are used to configure the wireFormat. See Configuring Wire Formats for more information closeAsync true The false value causes all sockets to be closed synchronously soLinger MIN_INTEGER When > -1 causes the socket soLinger option to be enabled with this value. When == -1, causes soLinger to be disabled. (from 5.6.0) maximumConnections Integer.MAX_VALUE The maximum number of sockets the broker is allowed to create diffServ 0 A value of zero denotes no timeout. stackSize 0 Set the stack size of the transport's background reading thread. Must be specified in multiples of 128K. A value of zero indicates that this parameter is ignored. startLogging true If true the TransportLogger object of the Transport stack will initially write messages to the log. This parameter is only used when trace == true. tcpNoDelay false If true the socket's option TCP_NODELAY is set. This disables Nagle's algorithm for small packet transmission. threadName N/A When this parameter is specified the name of the thread is modified during the invocation to a transport. The remote address is appended so that a call stuck in a transport method will have the destination information in the thread name. This is extremely useful for thread dumps when debugging. trace false Causes all commands that are sent over the transport to be logged. To view the logged output define the Log4j logger: log4j.logger.org.apache.activemq.transport.TransportLogger=DEBUG. trafficClass 0 The Traffic Class to be set on the socket. typeOfService 0 ( Client only) The preferred Type of Service value to be set on outgoing packets. Valid integer values: [0,256). With JDK 6, only works when the JVM is configured to use the IPv4 stack . To use the IPv4 stack set the system property java.net.preferIPv4Stack tcpNoDelay true =true. It is invalid to specify both diffServ and typeOfService since they share the same position in the TCP/IP packet headers. useInactivityMonitor true A value of false disables the InactivityMonitor completely and connections will never time out. useKeepAlive true If true KeepAliveInfo messages are sent on an idle connection to prevent it from timing out. If this parameter is false connections will still timeout if no data was received on the connection for the specified amount of time. useLocalHost false If true the value localhost will be instead of the actual local host name to make local connections. On some operating systems such as OS X it's not possible to connect as the local host name so localhost is better. useQueueForAccept true If true accepted sockets are placed onto a queue for asynchronous processing using a separate thread. wireFormat default The name of the WireFormat factory to use. wireFormat.* N/A Properties with this prefix are used to configure the wireFormat. See Configuring Wire Formats for more information. Example URI On Server side (in TransportConnector) No Format tcp://localhost:61616?transport.threadName&transport.trace=false&transport.soTimeout=60000 ... View page • Like

Stop watching space • Manage notifications This message was sent by Atlassian Confluence 5.8.4