Module io.helidon.common.socket

Package io.helidon.common.socket

Class SocketOptions.BuilderBase.SocketOptionsImpl

java.lang.Object

io.helidon.common.socket.SocketOptions.BuilderBase.SocketOptionsImpl

All Implemented Interfaces:

Prototype.Api, SocketOptions

Enclosing class:

SocketOptions.BuilderBase<BUILDER extends SocketOptions.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends SocketOptions>

protected static class SocketOptions.BuilderBase.SocketOptionsImpl
extends Object
implements SocketOptions

Generated implementation of the prototype, can be extended by descendant prototype implementations.

Nested Class Summary

Nested classes/interfaces inherited from interface io.helidon.common.socket.SocketOptions

SocketOptions.Builder, SocketOptions.BuilderBase<BUILDER extends SocketOptions.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends SocketOptions>

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SocketOptionsImpl(SocketOptions.BuilderBase<?,?> builder)	Create an instance providing a builder.

Method Summary

Modifier and Type	Method	Description
default void	configureSocket(Socket socket)	Configure socket with defined socket options.
Duration	connectTimeout()	Socket connect timeout.
boolean	equals(Object o)
int	hashCode()
Duration	readTimeout()	Socket read timeout.
boolean	socketKeepAlive()	Configure socket keep alive.
Map<SocketOption<?>,Object>	socketOptions()	Arbitrary socket options.
Optional<Integer>	socketReceiveBufferSize()	Socket receive buffer size.
boolean	socketReuseAddress()	Socket reuse address.
Optional<Integer>	socketSendBufferSize()	Socket send buffer size.
boolean	tcpNoDelay()	This option may improve performance on some systems.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

SocketOptionsImpl

protected SocketOptionsImpl(SocketOptions.BuilderBase<?,?> builder)

Create an instance providing a builder.

Parameters:

builder - extending builder base of this prototype

Method Details

socketOptions

public Map<SocketOption<?>,Object> socketOptions()

Description copied from interface: SocketOptions

Arbitrary socket options. Socket options that have dedicated methods in this type will be ignored if configured within the map.

Specified by:

socketOptions in interface SocketOptions

Returns:

custom socket options

connectTimeout

public Duration connectTimeout()

Description copied from interface: SocketOptions

Socket connect timeout. Default is 10 seconds.

Specified by:

connectTimeout in interface SocketOptions

Returns:

connect timeout duration

readTimeout

public Duration readTimeout()

Description copied from interface: SocketOptions

Socket read timeout. Default is 30 seconds.

Specified by:

readTimeout in interface SocketOptions

Returns:

read timeout duration

socketReceiveBufferSize

public Optional<Integer> socketReceiveBufferSize()

Description copied from interface: SocketOptions

Socket receive buffer size.

Specified by:

socketReceiveBufferSize in interface SocketOptions

Returns:

buffer size, in bytes

See Also:

• StandardSocketOptions.SO_RCVBUF

socketSendBufferSize

public Optional<Integer> socketSendBufferSize()

Description copied from interface: SocketOptions

Socket send buffer size.

Specified by:

socketSendBufferSize in interface SocketOptions

Returns:

buffer size, in bytes

See Also:

• StandardSocketOptions.SO_SNDBUF

socketReuseAddress

public boolean socketReuseAddress()

Description copied from interface: SocketOptions

Socket reuse address. Default is true.

Specified by:

socketReuseAddress in interface SocketOptions

Returns:

whether to reuse address

See Also:

• StandardSocketOptions.SO_REUSEADDR

socketKeepAlive

public boolean socketKeepAlive()

Description copied from interface: SocketOptions

Configure socket keep alive. Default is true.

Specified by:

socketKeepAlive in interface SocketOptions

Returns:

keep alive

See Also:

• StandardSocketOptions.SO_KEEPALIVE

tcpNoDelay

public boolean tcpNoDelay()

Description copied from interface: SocketOptions

This option may improve performance on some systems. Default is false.

Specified by:

tcpNoDelay in interface SocketOptions

Returns:

whether to use TCP_NODELAY, defaults to false

See Also:

• StandardSocketOptions.TCP_NODELAY

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

configureSocket

default void configureSocket(Socket socket)

Configure socket with defined socket options.

Parameters:

socket - socket to update