org.mule.extension.socket.api.socket

Class AbstractSocketProperties

java.lang.Object

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

All Implemented Interfaces:

SocketProperties

Direct Known Subclasses:

AbstractTcpSocketProperties, UdpSocketProperties

public abstract class AbstractSocketProperties
extends Object
implements SocketProperties

Configuration fields common to all socket implementations

Since:

4.0

Field Summary

Fields

Modifier and Type	Field and Description
protected Integer	clientTimeout This sets the SO_TIMEOUT value on sockets.
protected String	name The name of this config object, so that it can be referenced by config elements.
protected Integer	receiveBufferSize The size of the buffer (in bytes) used when receiving data, set on the socket itself.
protected Integer	sendBufferSize The size of the buffer (in bytes) used when sending data, set on the socket itself.
protected static String	TIMEOUT_CONFIGURATION

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

GROUP_NAME

Constructor Summary

Constructors

Constructor and Description
AbstractSocketProperties()

Method Summary

Modifier and Type	Method and Description
Integer	getClientTimeout() This sets the SO_TIMEOUT value on client sockets.
String	getName()
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.
void	setName(String name)

Methods inherited from class java.lang.Object

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

Field Detail

TIMEOUT_CONFIGURATION

protected static final String TIMEOUT_CONFIGURATION

See Also:

Constant Field Values

name

@ConfigName
protected String name

The name of this config object, so that it can be referenced by config elements.

sendBufferSize

@Parameter
 @Optional
 @Placement(tab="Buffer Configuration")
protected Integer sendBufferSize

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

receiveBufferSize

@Parameter
 @Optional
 @Placement(tab="Buffer Configuration")
protected Integer receiveBufferSize

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

clientTimeout

@Parameter
 @Optional
 @Summary(value="Time, in milliseconds, that the socket will wait in a blocking operation before failing")
 @Placement(tab="Timeout Configuration")
protected Integer clientTimeout

This sets the SO_TIMEOUT value on sockets. Indicates the amount of time (in milliseconds) that the socket will wait in a blocking operation before failing.

A value of 0 (the default) means waiting indefinitely.

Constructor Detail

AbstractSocketProperties

public AbstractSocketProperties()

Method Detail

getName

public String getName()

setName

public void setName(String name)

getSendBufferSize

public Integer getSendBufferSize()

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

Specified by:

getSendBufferSize in interface SocketProperties

getReceiveBufferSize

public Integer getReceiveBufferSize()

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

Specified by:

getReceiveBufferSize in interface SocketProperties

getClientTimeout

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

Specified by:

getClientTimeout in interface SocketProperties

getReuseAddress

public 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

Specified by:

getReuseAddress in interface SocketProperties