Module io.helidon.common.socket

Package io.helidon.common.socket

Interface SocketOptions

All Superinterfaces:

Prototype.Api

All Known Implementing Classes:

SocketOptions.BuilderBase.SocketOptionsImpl

public interface SocketOptions
extends Prototype.Api

Socket options.

See Also:

• builder()
• create()

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	SocketOptions.Builder	Fluent API builder for SocketOptions.
static class	SocketOptions.BuilderBase<BUILDER extends SocketOptions.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends SocketOptions>	Fluent API builder base for SocketOptions.

Method Summary

Modifier and Type	Method	Description
static SocketOptions.Builder	builder()	Create a new fluent API builder to customize configuration.
static SocketOptions.Builder	builder(SocketOptions instance)	Create a new fluent API builder from an existing instance.
default void	configureSocket(Socket socket)	Configure socket with defined socket options.
Duration	connectTimeout()	Socket connect timeout.
static SocketOptions	create()	Create a new instance with default values.
static SocketOptions	create(Config config)	Create a new instance from configuration.
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.

Method Details

builder

static SocketOptions.Builder builder()

Create a new fluent API builder to customize configuration.

Returns:

a new builder

builder

static SocketOptions.Builder builder(SocketOptions instance)

Create a new fluent API builder from an existing instance.

Parameters:

instance - an existing instance used as a base for the builder

Returns:

a builder based on an instance

create

static SocketOptions create(Config config)

Create a new instance from configuration.

Parameters:

config - used to configure the new instance

Returns:

a new instance configured from configuration

create

static SocketOptions create()

Create a new instance with default values.

Returns:

a new instance

socketOptions

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

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

Returns:

custom socket options

connectTimeout

Duration connectTimeout()

Socket connect timeout. Default is 10 seconds.

Returns:

connect timeout duration

readTimeout

Duration readTimeout()

Socket read timeout. Default is 30 seconds.

Returns:

read timeout duration

socketReceiveBufferSize

Optional<Integer> socketReceiveBufferSize()

Socket receive buffer size.

Returns:

buffer size, in bytes

See Also:

• StandardSocketOptions.SO_RCVBUF

socketSendBufferSize

Optional<Integer> socketSendBufferSize()

Socket send buffer size.

Returns:

buffer size, in bytes

See Also:

• StandardSocketOptions.SO_SNDBUF

socketReuseAddress

boolean socketReuseAddress()

Socket reuse address. Default is true.

Returns:

whether to reuse address

See Also:

• StandardSocketOptions.SO_REUSEADDR

socketKeepAlive

boolean socketKeepAlive()

Configure socket keep alive. Default is true.

Returns:

keep alive

See Also:

• StandardSocketOptions.SO_KEEPALIVE

tcpNoDelay

boolean tcpNoDelay()

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

Returns:

whether to use TCP_NODELAY, defaults to false

See Also:

• StandardSocketOptions.TCP_NODELAY

configureSocket

default void configureSocket(Socket socket)

Configure socket with defined socket options.

Parameters:

socket - socket to update