org.mule.runtime.http.api.tcp

Class TcpClientSocketPropertiesBuilder

java.lang.Object

org.mule.runtime.http.api.tcp.TcpClientSocketPropertiesBuilder

public final class TcpClientSocketPropertiesBuilder
extends Object

Builder of TcpClientSocketProperties. Instances can only be obtained using TcpClientSocketProperties.builder(). Default values will be used unless specified.

Since:

4.0

Field Summary

Fields

Modifier and Type	Field and Description
protected Integer	clientTimeout
protected Boolean	keepAlive
protected Integer	linger
protected Integer	receiveBufferSize
protected Integer	sendBufferSize
protected Boolean	sendTcpNoDelay

Method Summary

Modifier and Type	Method and Description
TcpClientSocketProperties	build()
TcpClientSocketPropertiesBuilder	clientTimeout(Integer clientTimeout) Defines the SO_TIMEOUT value for client sockets.
TcpClientSocketPropertiesBuilder	connectionTimeout(Integer connectionTimeout) Defines how long to wait for the outbound connection to be created.
TcpClientSocketPropertiesBuilder	keepAlive(Boolean keepAlive) Defines the SO_KEEPALIVE behaviour for open sockets.
TcpClientSocketPropertiesBuilder	linger(Integer linger) Defines the SO_LINGER value, related to how long the socket will take to close.
TcpClientSocketPropertiesBuilder	receiveBufferSize(Integer receiveBufferSize) Defines the size of the buffer to use when receiving data.
TcpClientSocketPropertiesBuilder	sendBufferSize(Integer sendBufferSize) Defines the size of the buffer to use when sending data.
TcpClientSocketPropertiesBuilder	sendTcpNoDelay(Boolean sendTcpNoDelay) Defines whether data should be collected or not before sending.

Methods inherited from class java.lang.Object

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

Field Detail

sendBufferSize

protected Integer sendBufferSize

receiveBufferSize

protected Integer receiveBufferSize

clientTimeout

protected Integer clientTimeout

sendTcpNoDelay

protected Boolean sendTcpNoDelay

linger

protected Integer linger

keepAlive

protected Boolean keepAlive

Method Detail

sendBufferSize

public TcpClientSocketPropertiesBuilder sendBufferSize(Integer sendBufferSize)

Defines the size of the buffer to use when sending data. See TcpSocketProperties.getSendBufferSize(). If not set, transport defaults will be used.

Parameters:

sendBufferSize - size of the buffer (in bytes).

Returns:

this builder

receiveBufferSize

public TcpClientSocketPropertiesBuilder receiveBufferSize(Integer receiveBufferSize)

Defines the size of the buffer to use when receiving data. See TcpSocketProperties.getReceiveBufferSize(). If not set, transport defaults will be used.

Parameters:

receiveBufferSize - size of the buffer (in bytes).

Returns:

this builder

clientTimeout

public TcpClientSocketPropertiesBuilder clientTimeout(Integer clientTimeout)

Defines the SO_TIMEOUT value for client sockets. See TcpSocketProperties.getClientTimeout(). If not set, transport defaults will be used.

Parameters:

clientTimeout - the timeout (in milliseconds).

Returns:

this builder

sendTcpNoDelay

public TcpClientSocketPropertiesBuilder sendTcpNoDelay(Boolean sendTcpNoDelay)

Defines whether data should be collected or not before sending. See TcpSocketProperties.getSendTcpNoDelay(). Default value is true.

Parameters:

sendTcpNoDelay - whether to send everything or collect data

Returns:

this builder

linger

public TcpClientSocketPropertiesBuilder linger(Integer linger)

Defines the SO_LINGER value, related to how long the socket will take to close. See TcpSocketProperties.getLinger(). If not set, transport defaults will be used.

Parameters:

linger - timeout (in milliseconds)

Returns:

this builder

keepAlive

public TcpClientSocketPropertiesBuilder keepAlive(Boolean keepAlive)

Defines the SO_KEEPALIVE behaviour for open sockets. See TcpSocketProperties.getKeepAlive(). Default value is true.

Parameters:

keepAlive -

Returns:

connectionTimeout

public TcpClientSocketPropertiesBuilder connectionTimeout(Integer connectionTimeout)

Defines how long to wait for the outbound connection to be created. See TcpClientSocketProperties.getConnectionTimeout(). Default value is 30000.

Parameters:

connectionTimeout - timeout (in milliseconds)

Returns:

this builder

build

public TcpClientSocketProperties build()

Returns:

a TcpClientSocketProperties instance as specified.