META-INF.mule-tcp.xsd Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of mule-transport-tcp Show documentation
Show all versions of mule-transport-tcp Show documentation
A Mule transport for Tcp Connectivity. This transport supplies a tcp Server and client implementation.
The TCP transport enables events to be sent and received over TCP sockets.
TCP
TCP Transport
Connects Mule to a TCP socket to send or receive data via the network.
Connects Mule to a TCP socket to send or receive data via the network.
The timeout to wait in milliseconds for data to come from the server
The time in milliseconds to wait between each request to the TCP server.
The size of the buffer (in bytes) used when sending data, set on the socket itself.
The size of the buffer (in bytes) used when receiving data, set on the socket itself.
The maximum queue length for incoming connections.
If set, transmitted data is not collected together for greater efficiency but sent immediately.
If set (the default), SO_REUSEADDRESS is set on server sockets before binding. This helps reduce "address already in use" errors when a socket is re-used.
Number of milliseconds to wait until an outbound connection to a remote server is successfully created. No timeout is configured by default.
This sets the SO_TIMEOUT value when the socket is used as a client. Reading from the socket will block for up to this long (in milliseconds) before the read fails. A value of 0 (the default) causes the read to wait indefinitely (if no data arrives).
This sets the SO_TIMEOUT value when the socket is used as a server. Reading from the socket will block for up to this long (in milliseconds) before the read fails. A value of 0 (the default) causes the read to wait indefinitely (if no data arrives).
This sets the SO_LINGER value. This is related to how long (in milliseconds) the socket will take to close so that any remaining data is transmitted correctly.
If set, the socket is not closed after sending a message. This attribute only applies when sending data over a socket (Client).
Enables SO_KEEPALIVE behavior on open sockets. This automatically checks socket connections that are open but unused for long periods and closes them if the connection becomes unavailable. This is a property on the socket itself and is used by a server socket to control whether connections to the server are kept alive before they are recycled.
Sets the maximum amount of time (in milliseconds) the socket pool should block waiting for a socket before throwing an exception. When less than or equal to 0 it may block indefinitely (the default).
If set (the default), it will fail during socket creation if the host set on the endpoint cannot be resolved. However, it can be set to false to allow unresolved hosts (this is useful on some circumstances like connecting through a proxy).
The class name for the protocol handler. This controls how the raw data stream is converted into messages. By default, messages are constructed as dara is received, with no correction for multiple packets or fragmentation. Typically, change this value, or use a transport that includes a protocol like HTTP.
Allows to define a custom message dispatcher factory
Rethrow the exception if read fails
TCP does not guarantee that data written to a socket is transmitted in a single packet, so if you want to transmit entire Mule messages reliably, you must specify an additional protocol. However, this is not an issue with streaming, so the streaming-protocol element is an alias for the "direct" (null) protocol.
TCP does not guarantee that data written to a socket is transmitted in a single packet, so if you want to transmit entire Mule messages reliably, you must specify an additional protocol. The xml-protocol element configures the XML protocol, which uses XML syntax to isolate messages from the stream of bytes received, so it will only work with well-formed XML.
Similar to xml-protocol, the xml-eof-protocol element configures the XML protocol, but it will also use socket closure to terminate a message (even if the XML is not well-formed).
TCP does not guarantee that data written to a socket is transmitted in a single packet, so if you want to transmit entire Mule messages reliably, you must specify an additional protocol. The eof-protocol element configures a protocol that simply accumulates all data until the socket closes and places it in a single message.
TCP does not guarantee that data written to a socket is transmitted in a single packet. Using the direct-protocol element to configure the "null" protocol does not change the normal TCP behavior, so message fragmentation may occur. For example, a single sent message may be received in several pieces, each as a separate received message. Typically, it is not a good choice for messaging within Mule, but it may be necessary to interface with external TCP-based protocols.
Sends only the payload, not the entire Mule message object or its properties. This defaults to true when the protocol is not specified explicitly (when the safe protocol is used).
Similar to length-protocol, safe-protocol also includes a prefix. Verification of the prefix allows mis-matched protocols to be detected and avoids interpreting "random" data as a message length (which may give out-of-memory errors). This is the default protocol in Mule 2.x.
A length protocol that uses a specific class loader to load objects from streams
Allows Spring beans to be defined for class loading
The length-protocol element configures the length protocol, which precedes each message with the number of bytes sent so that an entire message can be constructed on the received.
An optional maximum length for the number of bytes in a single message. Messages larger than this will trigger an error in the receiver, but it give an assurance that no out-of-memory error will occur.
The custom-protocol element allows you to configure your own protocol implementation.
A class that implements the TcpProtocol interface.
Reference to a spring bean that implements the TcpProtocol interface.
The inbound-endpoint element configures the endpoint on which the messages are received.
The outbound-endpoint element configures the endpoint where the messages are sent.
The endpoint element configures a global TCP endpoint definition.
The host of the TCP socket.
The port of the TCP socket.
Configuration element for setting client socket properties.
Configuration element for setting server socket properties.
The name of this properties object, so that it can be referenced by config elements.
The size of the buffer (in bytes) used when sending data, set on the socket itself.
The size of the buffer (in bytes) used when receiving data, set on the socket itself.
If set, transmitted data is not collected together for greater efficiency but sent immediately.
This sets the SO_TIMEOUT value on client sockets. Reading from the socket will block for up to this long (in milliseconds) before the read fails. A value of 0 (the default) causes the read to wait indefinitely (if no data arrives).
This sets the SO_LINGER value. This is related to how long (in milliseconds) the socket will take to close so that any remaining data is transmitted correctly.
A value of -1 (default) disables linger on the socket.
Enables SO_KEEPALIVE behavior on open sockets. This automatically checks socket connections that are open but unused for long periods and closes them if the connection becomes unavailable. This is a property on the socket itself and is used by a server socket to control whether connections to the server are kept alive before they are recycled.
Number of milliseconds to wait until an outbound connection to a remote server is successfully created. No timeout is configured by default.
If set (the default), SO_REUSEADDRESS is set on server sockets before binding. This helps reduce "address already in use" errors when a socket is re-used.
The maximum queue length for incoming connections.
This sets the SO_TIMEOUT value when the socket is used as a server. This is the timeout that applies to the "accept" operation. A value of 0 (the default) causes the accept to wait indefinitely (if no connection arrives).