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

Class AbstractTcpSocketProperties

java.lang.Object

org.mule.extension.socket.api.socket.AbstractSocketProperties

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

All Implemented Interfaces:

SocketProperties, TcpSocketProperties

Direct Known Subclasses:

TcpClientSocketProperties, TcpServerSocketProperties

public abstract class AbstractTcpSocketProperties
extends AbstractSocketProperties
implements TcpSocketProperties

Common configuration fields for TCP Socket

Since:

4.0

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	failOnUnresolvedHost Whether the socket should fail during its creation if the host set on the endpoint cannot be resolved.
protected boolean	keepAlive Enables SO_KEEPALIVE behavior on open sockets.
protected Integer	linger This sets the SO_LINGER value.
protected boolean	sendTcpNoDelay If set, transmitted data is not collected together for greater efficiency but sent immediately.

Fields inherited from class org.mule.extension.socket.api.socket.AbstractSocketProperties

clientTimeout, name, receiveBufferSize, sendBufferSize, TIMEOUT_CONFIGURATION

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

GROUP_NAME

Constructor Summary

Constructors

Constructor and Description
AbstractTcpSocketProperties()

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 class org.mule.extension.socket.api.socket.AbstractSocketProperties

getClientTimeout, getName, getReceiveBufferSize, getReuseAddress, getSendBufferSize, setName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

getClientTimeout, getReceiveBufferSize, getReuseAddress, getSendBufferSize

Field Detail

sendTcpNoDelay

@Parameter
 @Optional(defaultValue="true")
 @Summary(value="Indicates whether the transmitted data should not be collected together for greater efficiency, and sent immediately")
 @DisplayName(value="Send TCP With No Delay")
protected boolean sendTcpNoDelay

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.

linger

@Parameter
 @Optional
 @Summary(value="This indicates for how long, in milliseconds, the socket will take to close so any remaining data istransmitted correctly")
protected Integer linger

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.

keepAlive

@Parameter
 @Optional(defaultValue="false")
 @Summary(value="Indicates whether the open socket connections unused for a long period and with an unavailable connection should be closed")
protected boolean keepAlive

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.

failOnUnresolvedHost

@Parameter
 @Optional(defaultValue="true")
 @Summary(value="Whether the socket should fail during its creation if the host set on the endpoint cannot be resolved")
protected boolean failOnUnresolvedHost

Whether the socket should fail during its creation if the host set on the endpoint cannot be resolved. However, it can be set to false to allow unresolved hosts (useful when connecting through a proxy).

Constructor Detail

AbstractTcpSocketProperties

public AbstractTcpSocketProperties()

Method Detail

getLinger

public 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.

Specified by:

getLinger in interface TcpSocketProperties

getKeepAlive

public 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.

Specified by:

getKeepAlive in interface TcpSocketProperties

getSendTcpNoDelay

public 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.

Specified by:

getSendTcpNoDelay in interface TcpSocketProperties

getFailOnUnresolvedHost

public 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).

Specified by:

getFailOnUnresolvedHost in interface TcpSocketProperties