Class SocketOptions.Builder

java.lang.Object

io.helidon.common.socket.SocketOptions.BuilderBase<SocketOptions.Builder, SocketOptions>

io.helidon.common.socket.SocketOptions.Builder

All Implemented Interfaces:

Prototype.Builder<SocketOptions.Builder, SocketOptions>, Builder<SocketOptions.Builder, SocketOptions>, ConfigBuilderSupport.ConfiguredBuilder<SocketOptions.Builder, SocketOptions>, Supplier<SocketOptions>

Enclosing interface:

SocketOptions

public static class SocketOptions.Builder
extends SocketOptions.BuilderBase<SocketOptions.Builder, SocketOptions>
implements Builder<SocketOptions.Builder, SocketOptions>

Fluent API builder for SocketOptions.

Nested Class Summary

Nested classes/interfaces inherited from class SocketOptions.BuilderBase

SocketOptions.BuilderBase.SocketOptionsImpl

Modifier and Type	Class	Description
protected static class	SocketOptions.BuilderBase.SocketOptionsImpl	Generated implementation of the prototype, can be extended by descendant prototype implementations.

Method Summary

Modifier and Type	Method	Description
SocketOptions	build()	Create an instance from this builder.
SocketOptions	buildPrototype()	Create an instance of the prototype.

Methods inherited from class SocketOptions.BuilderBase

addSocketOptions, clearSocketReceiveBufferSize, clearSocketSendBufferSize, config, config, connectTimeout, connectTimeout, from, from, preBuildPrototype, putSocketOption, readTimeout, readTimeout, socketKeepAlive, socketKeepAlive, socketOptions, socketOptions, socketReceiveBufferSize, socketReceiveBufferSize, socketReuseAddress, socketReuseAddress, socketSendBufferSize, socketSendBufferSize, tcpNoDelay, tcpNoDelay, toString, validatePrototype

Modifier and Type	Method	Description
SocketOptions.Builder	addSocketOptions(Map<SocketOption<?>, ?> socketOptions)	Arbitrary socket options.
SocketOptions.Builder	clearSocketReceiveBufferSize()	Clear existing value of socketReceiveBufferSize.
SocketOptions.Builder	clearSocketSendBufferSize()	Clear existing value of socketSendBufferSize.
protected Optional<Config>	config()	Configuration used to configure this instance.
SocketOptions.Builder	config(Config config)	Update builder from configuration (node of this type).
Duration	connectTimeout()	Socket connect timeout.
SocketOptions.Builder	connectTimeout(Duration connectTimeout)	Socket connect timeout.
SocketOptions.Builder	from(SocketOptions prototype)	Update this builder from an existing prototype instance.
SocketOptions.Builder	from(SocketOptions.BuilderBase<?,?> builder)	Update this builder from an existing prototype builder instance.
protected void	preBuildPrototype()	Handles providers and decorators.
<TYPE> SocketOptions.Builder	putSocketOption(SocketOption<TYPE> key, TYPE socketOption)	Arbitrary socket options.
Duration	readTimeout()	Socket read timeout.
SocketOptions.Builder	readTimeout(Duration readTimeout)	Socket read timeout.
boolean	socketKeepAlive()	Configure socket keep alive.
SocketOptions.Builder	socketKeepAlive(boolean socketKeepAlive)	Configure socket keep alive.
Map<SocketOption<?>, Object>	socketOptions()	Arbitrary socket options.
SocketOptions.Builder	socketOptions(Map<SocketOption<?>, ?> socketOptions)	Arbitrary socket options.
Optional<Integer>	socketReceiveBufferSize()	Socket receive buffer size.
SocketOptions.Builder	socketReceiveBufferSize(int socketReceiveBufferSize)	Socket receive buffer size.
boolean	socketReuseAddress()	Socket reuse address.
SocketOptions.Builder	socketReuseAddress(boolean socketReuseAddress)	Socket reuse address.
Optional<Integer>	socketSendBufferSize()	Socket send buffer size.
SocketOptions.Builder	socketSendBufferSize(int socketSendBufferSize)	Socket send buffer size.
boolean	tcpNoDelay()	This option may improve performance on some systems.
SocketOptions.Builder	tcpNoDelay(boolean tcpNoDelay)	This option may improve performance on some systems.
String	toString()
protected void	validatePrototype()	Validates required properties.

Methods inherited from class Object

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

Methods inherited from interface Builder

get, identity, update

Modifier and Type	Method	Description
default SocketOptions	get()
default SocketOptions.Builder	identity()	Instance of this builder as the correct type.
default SocketOptions.Builder	update(Consumer<SocketOptions.Builder> consumer)	Update the builder in a fluent API way.

Methods inherited from interface Prototype.Builder

self

Modifier and Type	Method	Description
default SocketOptions.Builder	self()	Instance of this builder as the correct type.

Method Details

buildPrototype

public SocketOptions buildPrototype()

Create an instance of the prototype. Calling this method may update this builder from providers and decorators, so repeated calls may have side effects.

Specified by:

buildPrototype in interface Prototype.Builder<SocketOptions.Builder, SocketOptions>

Returns:

an instance of the setup object created from this builder

build

public SocketOptions build()

Create an instance from this builder. Calling this method may update this builder from providers and decorators, so repeated calls may have side effects.

Specified by:

build in interface Builder<SocketOptions.Builder, SocketOptions>

Returns:

instance of the built type