reactor.ipc.netty.options

Class ServerOptions

java.lang.Object

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

reactor.ipc.netty.options.ServerOptions

All Implemented Interfaces:

java.util.function.Supplier<ServerBootstrap>

Direct Known Subclasses:

HttpServerOptions

public class ServerOptions
extends NettyOptions<ServerBootstrap,ServerOptions>

Encapsulates configuration options for server connectors.

Author:

Stephane Maldini

Field Summary

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

DEFAULT_PORT

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ServerOptions() Build a new ServerBootstrap.
protected	ServerOptions(ServerBootstrap serverBootstrap) Apply common option via super constructor then apply defaultServerOptions(ServerBootstrap) to the passed bootstrap.
protected	ServerOptions(ServerOptions options) Deep-copy all references from the passed options into this new ServerOptions instance.

Method Summary

Modifier and Type	Method and Description
<T> ServerOptions	attr(AttributeKey<T> key, T value) Attribute default attribute to the future Channel connection.
static ServerOptions	create() Create a new server builder
ServerOptions	duplicate() Return a copy of all options and references such as NettyOptions.onChannelInit(Predicate).
ServerBootstrap	get()
SocketAddress	getAddress() Return a new eventual SocketAddress
ServerOptions	listen(InetSocketAddress listenAddress) The InetSocketAddress on which this server should listen.
ServerOptions	listen(int port) The port on which this server should listen, assuming it should bind to all available addresses.
ServerOptions	listen(String host) The host on which this server should listen, port will be resolved on bind.
ServerOptions	listen(String host, int port) The host and port on which this server should listen.
<T> ServerOptions	option(ChannelOption<T> key, T value) Set a ChannelOption value for low level connection settings like SO_TIMEOUT or SO_KEEPALIVE.
<T> ServerOptions	selectorAttr(AttributeKey<T> key, T value) Attribute default attribute to the future Channel connection.
<T> ServerOptions	selectorOption(ChannelOption<T> key, T value) Set a ChannelOption value for low level selector channel settings like SO_TIMEOUT or SO_KEEPALIVE.
ServerOptions	sslSelfSigned() Enable SSL service with a self-signed certificate
ServerOptions	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

afterChannelInit, afterChannelInit, channelGroup, defaultSslContext, eventLoopGroup, getLoopResources, getSslHandler, loopResources, onChannelInit, onChannelInit, preferNative, preferNative, sslContext, sslHandshakeTimeout, sslHandshakeTimeoutMillis, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ServerOptions

protected ServerOptions()

Build a new ServerBootstrap.

ServerOptions

protected ServerOptions(ServerBootstrap serverBootstrap)

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

Parameters:

serverBootstrap - the server bootstrap reference to use

ServerOptions

protected ServerOptions(ServerOptions options)

Deep-copy all references from the passed options into this new ServerOptions instance.

Parameters:

options - the source options to duplicate

Method Detail

create

public static ServerOptions create()

Create a new server builder

Returns:

a new server builder

attr

public <T> ServerOptions 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<ServerBootstrap,ServerOptions>

Type Parameters:

T - the attribute type

Parameters:

key - the attribute key

value - the attribute value

Returns:

this builder

See Also:

ServerBootstrap.childAttr(AttributeKey, Object)

duplicate

public ServerOptions duplicate()

Description copied from class: NettyOptions

Return a copy of all options and references such as NettyOptions.onChannelInit(Predicate). Further option uses on the returned builder will be fully isolated from this option builder.

Specified by:

duplicate in class NettyOptions<ServerBootstrap,ServerOptions>

Returns:

a new duplicated builder;

get

public ServerBootstrap get()

Specified by:

get in interface java.util.function.Supplier<ServerBootstrap>

Overrides:

get in class NettyOptions<ServerBootstrap,ServerOptions>

getAddress

public final SocketAddress getAddress()

Description copied from class: NettyOptions

Return a new eventual SocketAddress

Specified by:

getAddress in class NettyOptions<ServerBootstrap,ServerOptions>

Returns:

the supplied SocketAddress or null

listen

public ServerOptions listen(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

listen

public ServerOptions listen(String host)

The host on which this server should listen, port will be resolved on bind.

Parameters:

host - The host to bind to.

Returns:

this

listen

public ServerOptions listen(String host,
                            int port)

The host and port on which this server should listen.

Parameters:

host - The host to bind to.

port - The port to listen on.

Returns:

this

listen

public ServerOptions listen(InetSocketAddress listenAddress)

The InetSocketAddress on which this server should listen.

Parameters:

listenAddress - the listen address

Returns:

this

option

public <T> ServerOptions 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<ServerBootstrap,ServerOptions>

Type Parameters:

T - the option type

Parameters:

key - the option key

Returns:

this

See Also:

ServerBootstrap.childOption(ChannelOption, Object)

selectorAttr

public <T> ServerOptions 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:

AbstractBootstrap.attr(AttributeKey, Object)

selectorOption

public <T> ServerOptions 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

Returns:

this

See Also:

ServerBootstrap.childOption(ChannelOption, Object)

sslSelfSigned

public ServerOptions sslSelfSigned()

Enable SSL service with a self-signed certificate

Returns:

this

sslSelfSigned

public ServerOptions 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.sslContext(SslContext).

Parameters:

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

Returns:

this