Module io.helidon.common.socket

Package io.helidon.common.socket

Class SocketOptions.Builder

java.lang.Object

io.helidon.common.socket.SocketOptions.Builder

All Implemented Interfaces:

io.helidon.common.Builder<SocketOptions.Builder,SocketOptions>, Supplier<SocketOptions>

Enclosing class:

SocketOptions

public static class SocketOptions.Builder
extends Object
implements io.helidon.common.Builder<SocketOptions.Builder,SocketOptions>

Fluent API builder for SocketOptions.

Method Summary

Modifier and Type	Method	Description
final SocketOptions	build()
SocketOptions.Builder	connectTimeout(Duration connectTimeout)	Connect timeout.
SocketOptions.Builder	readTimeout(Duration readTimeout)	Read timeout.
<O> SocketOptions.Builder	setOption(SocketOption<O> option, O value)	Set an arbitrary option.
SocketOptions.Builder	socketKeepAlive(boolean socketKeepAlive)	Configure socket keep alive.
SocketOptions.Builder	socketReceiveBufferSize(int socketReceiveBufferSize)	Socket receive buffer size.
SocketOptions.Builder	socketReuseAddress(boolean socketReuseAddress)	Socket reuse address.
SocketOptions.Builder	socketSendBufferSize(int socketSendBufferSize)	Socket send buffer size.
SocketOptions.Builder	tcpNoDelay(boolean tcpNoDelay)	This option may improve performance on some systems.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.helidon.common.Builder

get, identity, update

Method Details

build

public final SocketOptions build()

Specified by:

build in interface io.helidon.common.Builder<SocketOptions.Builder,SocketOptions>

socketReceiveBufferSize

public SocketOptions.Builder socketReceiveBufferSize(int socketReceiveBufferSize)

Socket receive buffer size. Default is 32768.

Parameters:

socketReceiveBufferSize - buffer size, in bytes

Returns:

updated builder

See Also:

• StandardSocketOptions.SO_RCVBUF

socketSendBufferSize

public SocketOptions.Builder socketSendBufferSize(int socketSendBufferSize)

Socket send buffer size. Default is 32768.

Parameters:

socketSendBufferSize - buffer size, in bytes

Returns:

updated builder

See Also:

• StandardSocketOptions.SO_SNDBUF

socketReuseAddress

public SocketOptions.Builder socketReuseAddress(boolean socketReuseAddress)

Socket reuse address. Default is true.

Parameters:

socketReuseAddress - whether to reuse address

Returns:

updated builder

See Also:

• StandardSocketOptions.SO_REUSEADDR

socketKeepAlive

public SocketOptions.Builder socketKeepAlive(boolean socketKeepAlive)

Configure socket keep alive. Default is true.

Parameters:

socketKeepAlive - keep alive

Returns:

updated builder

See Also:

• StandardSocketOptions.SO_KEEPALIVE

tcpNoDelay

public SocketOptions.Builder tcpNoDelay(boolean tcpNoDelay)

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

Parameters:

tcpNoDelay - whether to use TCP_NODELAY, defaults to false

Returns:

updated builder

See Also:

• StandardSocketOptions.TCP_NODELAY

setOption

public <O> SocketOptions.Builder setOption(SocketOption<O> option,
 O value)

Set an arbitrary option.

Type Parameters:

O - option type

Parameters:

option - option to set

value - option value

Returns:

updated builder

See Also:

• StandardSocketOptions

readTimeout

public SocketOptions.Builder readTimeout(Duration readTimeout)

Read timeout. Default is 30 seconds.

Parameters:

readTimeout - read timeout

Returns:

updated builder

connectTimeout

public SocketOptions.Builder connectTimeout(Duration connectTimeout)

Connect timeout. Default is 10 seconds.

Parameters:

connectTimeout - connect timeout

Returns:

updated builder