reactor.io.net.config

Class CommonSocketOptions<SO extends CommonSocketOptions<? super SO>>

java.lang.Object

reactor.io.net.config.CommonSocketOptions<SO>

Type Parameters:

SO - A CommonSocketOptions subclass

Direct Known Subclasses:

ClientSocketOptions, ServerSocketOptions

public abstract class CommonSocketOptions<SO extends CommonSocketOptions<? super SO>>
extends java.lang.Object

Encapsulates common socket options.

Constructor Summary

Constructors

Constructor and Description
CommonSocketOptions()

Method Summary

Modifier and Type	Method and Description
boolean	keepAlive() Returns a boolean indicating whether or not SO_KEEPALIVE is enabled
SO	keepAlive(boolean keepAlive) Enables or disables SO_KEEPALIVE.
int	linger() Returns the configuration of SO_LINGER.
SO	linger(int linger) Configures SO_LINGER
long	prefetch() Gets the prefetch maximum in-flight value
SO	prefetch(long prefetch) Set the Consuming capacity along with eventual flushing strategy each given prefetch iteration.
int	rcvbuf() Gets the configured SO_RCVBUF (receive buffer) size
SO	rcvbuf(int rcvbuf) Sets the SO_RCVBUF (receive buffer) size
int	sndbuf() Gets the configured SO_SNDBUF (send buffer) size
SO	sndbuf(int sndbuf) Sets the SO_SNDBUF (send buffer) size
boolean	tcpNoDelay() Returns a boolean indicating whether or not TCP_NODELAY is enabled
SO	tcpNoDelay(boolean tcpNoDelay) Enables or disables TCP_NODELAY
int	timeout() Gets the SO_TIMEOUT value
SO	timeout(int timeout) Set the SO_TIMEOUT value.

Methods inherited from class java.lang.Object

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

Constructor Detail

CommonSocketOptions

public CommonSocketOptions()

Method Detail

timeout

public int timeout()

Gets the SO_TIMEOUT value

Returns:

the timeout value

timeout

public SO timeout(int timeout)

Set the SO_TIMEOUT value.

Parameters:

timeout - The SO_TIMEOUT value.

Returns:

this

prefetch

public long prefetch()

Gets the prefetch maximum in-flight value

Returns:

the prefetch value, Long.MAX if undefined

prefetch

public SO prefetch(long prefetch)

Set the Consuming capacity along with eventual flushing strategy each given prefetch iteration. Long.MAX will instruct the channels to be unbounded (e.g. limited by the dispatcher capacity if any or a slow consumer). When unbounded the system will take a maximum of data off the channel incoming connection. Setting a value of 10 will however pause the channel after 10 successful reads until the next request from the consumer.

Parameters:

prefetch - The prefetch in-flight data over this channel (Long.MAX_VALUE for unbounded).

Returns:

this

keepAlive

public boolean keepAlive()

Returns a boolean indicating whether or not SO_KEEPALIVE is enabled

Returns:

true if keep alive is enabled, false otherwise

keepAlive

public SO keepAlive(boolean keepAlive)

Enables or disables SO_KEEPALIVE.

Parameters:

keepAlive - true to enable keepalive, false to disable keepalive

Returns:

this

linger

public int linger()

Returns the configuration of SO_LINGER.

Returns:

the value of SO_LINGER in seconds

linger

public SO linger(int linger)

Configures SO_LINGER

Parameters:

linger - The linger period in seconds

Returns:

this

tcpNoDelay

public boolean tcpNoDelay()

Returns a boolean indicating whether or not TCP_NODELAY is enabled

Returns:

true if TCP_NODELAY is enabled, false if it is not

tcpNoDelay

public SO tcpNoDelay(boolean tcpNoDelay)

Enables or disables TCP_NODELAY

Parameters:

tcpNoDelay - true to enable TCP_NODELAY, false to disable it

Returns:

this

rcvbuf

public int rcvbuf()

Gets the configured SO_RCVBUF (receive buffer) size

Returns:

The configured receive buffer size

rcvbuf

public SO rcvbuf(int rcvbuf)

Sets the SO_RCVBUF (receive buffer) size

Parameters:

rcvbuf - The size of the receive buffer

Returns:

this

sndbuf

public int sndbuf()

Gets the configured SO_SNDBUF (send buffer) size

Returns:

The configured send buffer size

sndbuf

public SO sndbuf(int sndbuf)

Sets the SO_SNDBUF (send buffer) size

Parameters:

sndbuf - The size of the send buffer

Returns:

this