org.mule.extension.socket.api.socket.tcp

Interface TcpSocketProperties

All Superinterfaces:

SocketProperties

All Known Implementing Classes:

AbstractTcpSocketProperties, TcpClientSocketProperties, TcpServerSocketProperties

public interface TcpSocketProperties
extends SocketProperties

Interface for objects that provide common TCP configuration that applies for both client and server sockets.

null values can be returned by any of the methods, meaning that there is no value defined for the property.

Since:

4.0

Field Summary

Fields inherited from interface org.mule.extension.socket.api.socket.SocketProperties

GROUP_NAME

Method Summary

Modifier and Type	Method and Description
boolean	getFailOnUnresolvedHost() Will fail during sending if the remote host address cannot be resolved.
Boolean	getKeepAlive() Enables SO_KEEPALIVE behavior on open sockets.
Integer	getLinger() This sets the SO_LINGER value.
boolean	getSendTcpNoDelay() If set, transmitted data is not collected together for greater efficiency but sent immediately.

Methods inherited from interface org.mule.extension.socket.api.socket.SocketProperties

getClientTimeout, getReceiveBufferSize, getReuseAddress, getSendBufferSize

Method Detail

getSendTcpNoDelay

boolean getSendTcpNoDelay()

If set, transmitted data is not collected together for greater efficiency but sent immediately.

Defaults to true even though Socket default is false because optimizing to reduce amount of network traffic over latency is hardly ever a concern today.

getLinger

Integer getLinger()

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. Enabling this option with a non-zero Integer clientSocketTimeout means that a close() will block pending the transmission and acknowledgement of all data written to the peer, at which point the socket is closed gracefully. Upon reaching the linger clientSocketTimeout, the socket is closed forcefully, with a TCP RST. Enabling the option with a clientSocketTimeout of zero does a forceful close immediately. If the specified clientSocketTimeout value exceeds 65,535 it will be reduced to 65,535.

A value of null (default) disables linger on the socket.

getKeepAlive

Boolean getKeepAlive()

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.

getFailOnUnresolvedHost

boolean getFailOnUnresolvedHost()

Will fail during sending if the remote host address 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).