reactor.ipc.netty.options

Class ServerOptions.Builder<BUILDER extends ServerOptions.Builder<BUILDER>>

java.lang.Object

reactor.ipc.netty.options.NettyOptions.Builder<ServerBootstrap,ServerOptions,BUILDER>

reactor.ipc.netty.options.ServerOptions.Builder<BUILDER>

All Implemented Interfaces:

java.util.function.Supplier<BUILDER>

Direct Known Subclasses:

HttpServerOptions.Builder

Enclosing class:

ServerOptions

public static class ServerOptions.Builder<BUILDER extends ServerOptions.Builder<BUILDER>>
extends NettyOptions.Builder<ServerBootstrap,ServerOptions,BUILDER>

Field Summary

Fields inherited from class reactor.ipc.netty.options.NettyOptions.Builder

bootstrapTemplate

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Builder(ServerBootstrap serverBootstrap) Apply common option via super class then apply defaultServerOptions(ServerBootstrap) to the passed bootstrap.

Method Summary

Modifier and Type	Method and Description
<T> BUILDER	attr(AttributeKey<T> key, T value) Attribute default attribute to the future Channel connection.
ServerOptions	build()
BUILDER	from(ServerOptions options) Fill the builder with attribute values from the provided options.
BUILDER	get()
BUILDER	host(java.lang.String host) The host on which this server should listen.
BUILDER	listenAddress(java.net.SocketAddress listenAddress) The InetSocketAddress on which this server should listen.
<T> BUILDER	option(ChannelOption<T> key, T value) Set a ChannelOption value for low level connection settings like SO_TIMEOUT or SO_KEEPALIVE.
BUILDER	port(int port) The port on which this server should listen, assuming it should bind to all available addresses.
<T> BUILDER	selectorAttr(AttributeKey<T> key, T value) Attribute default attribute to the future Channel connection.
<T> BUILDER	selectorOption(ChannelOption<T> key, T value) Set a ChannelOption value for low level selector channel settings like SO_TIMEOUT or SO_KEEPALIVE.
BUILDER	sslSelfSigned() Enable SSL service with a self-signed certificate
BUILDER	sslSelfSigned(java.util.function.Consumer<? super SslContextBuilder> configurator) Enable SSL service with a self-signed certificate and allows extra parameterization of the self signed SslContextBuilder.

Methods inherited from class reactor.ipc.netty.options.NettyOptions.Builder

afterChannelInit, afterNettyContextInit, channelGroup, eventLoopGroup, isLoopAvailable, loopResources, onChannelInit, preferNative, sslCloseNotifyFlushTimeout, sslCloseNotifyFlushTimeoutMillis, sslCloseNotifyReadTimeout, sslCloseNotifyReadTimeoutMillis, sslContext, sslHandshakeTimeout, sslHandshakeTimeoutMillis

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

protected Builder(ServerBootstrap serverBootstrap)

Apply common option via super class then apply defaultServerOptions(ServerBootstrap) to the passed bootstrap.

Parameters:

serverBootstrap - the server bootstrap reference to use

Method Detail

attr

public final <T> BUILDER attr(AttributeKey<T> key,
                              T value)

Attribute default attribute to the future Channel connection. They will be available via NettyInbound.attr(AttributeKey).

Overrides:

attr in class NettyOptions.Builder<ServerBootstrap,ServerOptions,BUILDER extends ServerOptions.Builder<BUILDER>>

Type Parameters:

T - the attribute type

Parameters:

key - the attribute key

value - the attribute value

Returns:

this

See Also:

ServerBootstrap.childAttr(AttributeKey, Object)

option

public final <T> BUILDER option(ChannelOption<T> key,
                                T value)

Set a ChannelOption value for low level connection settings like SO_TIMEOUT or SO_KEEPALIVE. This will apply to each new channel from remote peer.

Overrides:

option in class NettyOptions.Builder<ServerBootstrap,ServerOptions,BUILDER extends ServerOptions.Builder<BUILDER>>

Type Parameters:

T - the option type

Parameters:

key - the option key

value - the option value

Returns:

this

See Also:

ServerBootstrap.childOption(ChannelOption, Object)

selectorAttr

public final <T> BUILDER selectorAttr(AttributeKey<T> key,
                                      T value)

Attribute default attribute to the future Channel connection. They will be available via NettyInbound.attr(AttributeKey).

Type Parameters:

T - the attribute type

Parameters:

key - the attribute key

value - the attribute value

Returns:

this builder

See Also:

ServerBootstrap.childAttr(AttributeKey, Object)

selectorOption

public final <T> BUILDER selectorOption(ChannelOption<T> key,
                                        T value)

Set a ChannelOption value for low level selector channel settings like SO_TIMEOUT or SO_KEEPALIVE. This will apply to each new channel from remote peer.

Type Parameters:

T - the option type

Parameters:

key - the option key

value - the option value

Returns:

this

See Also:

ServerBootstrap.childOption(ChannelOption, Object)

host

public final BUILDER host(java.lang.String host)

The host on which this server should listen.

Parameters:

host - The host to bind to.

Returns:

this

port

public final BUILDER port(int port)

The port on which this server should listen, assuming it should bind to all available addresses.

Parameters:

port - The port to listen on.

Returns:

this

listenAddress

public final BUILDER listenAddress(java.net.SocketAddress listenAddress)

The InetSocketAddress on which this server should listen.

Parameters:

listenAddress - the listen address

Returns:

this

sslSelfSigned

public final BUILDER sslSelfSigned()

Enable SSL service with a self-signed certificate

Returns:

this

sslSelfSigned

public final BUILDER sslSelfSigned(java.util.function.Consumer<? super SslContextBuilder> configurator)

Enable SSL service with a self-signed certificate and allows extra parameterization of the self signed SslContextBuilder. The builder is then used to invoke NettyOptions.Builder.sslContext(SslContext).

Parameters:

configurator - the builder callback to setup the self-signed SslContextBuilder

Returns:

this

from

public final BUILDER from(ServerOptions options)

Description copied from class: NettyOptions.Builder

Fill the builder with attribute values from the provided options.

Overrides:

from in class NettyOptions.Builder<ServerBootstrap,ServerOptions,BUILDER extends ServerOptions.Builder<BUILDER>>

Parameters:

options - The instance from which to copy values

Returns:

this

get

public BUILDER get()

build

public ServerOptions build()