org.mule.extension.socket.api.socket

Interface SocketProperties

All Known Subinterfaces:

TcpSocketProperties

All Known Implementing Classes:

AbstractSocketProperties, AbstractTcpSocketProperties, TcpClientSocketProperties, TcpServerSocketProperties, UdpSocketProperties

public interface SocketProperties

Interface for objects that provide common configuration for generic sockets.

Since:

4.0

Field Summary

Fields

Modifier and Type	Field and Description
static String	GROUP_NAME

Method Summary

Modifier and Type	Method and Description
Integer	getClientTimeout() This sets the SO_TIMEOUT value on client sockets.
Integer	getReceiveBufferSize() The size of the buffer (in bytes) used when receiving data, set on the socket itself.
boolean	getReuseAddress() Enabling SO_REUSEADDR prior to binding the socket using bind(SocketAddress) allows the socket to be bound even though a previous connection is in a clientSocketTimeout state.
Integer	getSendBufferSize() The size of the buffer (in bytes) used when sending data, set on the socket itself.

Field Detail

GROUP_NAME

static final String GROUP_NAME

See Also:

Constant Field Values

Method Detail

getSendBufferSize

Integer getSendBufferSize()

The size of the buffer (in bytes) used when sending data, set on the socket itself.

getReceiveBufferSize

Integer getReceiveBufferSize()

The size of the buffer (in bytes) used when receiving data, set on the socket itself.

getClientTimeout

Integer getClientTimeout()

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 socket's default) causes the read to wait indefinitely (if no data arrives).

getReuseAddress

boolean getReuseAddress()

Enabling SO_REUSEADDR prior to binding the socket using bind(SocketAddress) allows the socket to be bound even though a previous connection is in a clientSocketTimeout state.

For UDP sockets it may be necessary to bind more than one socket to the same socket address. This is typically for the purpose of receiving multicast packets