reactor.ipc.netty.http.server

Class HttpServerOptions

java.lang.Object

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

reactor.ipc.netty.options.ServerOptions

reactor.ipc.netty.http.server.HttpServerOptions

All Implemented Interfaces:

java.util.function.Supplier<ServerBootstrap>

public final class HttpServerOptions
extends ServerOptions

Encapsulates configuration options for http server.

Author:

Stephane Maldini

Field Summary

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

DEFAULT_PORT

Method Summary

Modifier and Type	Method and Description
HttpServerOptions	afterChannelInit(java.util.function.Consumer<? super Channel> afterChannelInit) Setup the callback after each Channel initialization and after reactor-netty pipeline handlers have been registered.
<T> ServerOptions	attr(AttributeKey<T> key, T value) Attribute default attribute to the future Channel connection.
HttpServerOptions	channelGroup(ChannelGroup channelGroup) Provide a ChannelGroup for each active remote channel will be held in the provided group.
HttpServerOptions	compression(boolean enabled) Enable GZip response compression if the client request presents accept encoding headers
HttpServerOptions	compression(int minResponseSize) Enable GZip response compression if the client request presents accept encoding headers AND the response reaches a minimum threshold
static HttpServerOptions	create() Create a new server builder
HttpServerOptions	duplicate() Return a copy of all options and references such as NettyOptions.onChannelInit(Predicate).
HttpServerOptions	eventLoopGroup(EventLoopGroup eventLoopGroup) Provide a shared EventLoopGroup each Connector handler.
HttpServerOptions	listen(InetSocketAddress listenAddress) The InetSocketAddress on which this server should listen.
HttpServerOptions	listen(int port) The port on which this server should listen, assuming it should bind to all available addresses.
HttpServerOptions	listen(String host) The host on which this server should listen, port will be resolved on bind.
HttpServerOptions	listen(String host, int port) The host and port on which this server should listen.
HttpServerOptions	loopResources(LoopResources eventLoopSelector) Provide an EventLoopGroup supplier.
HttpServerOptions	onChannelInit(java.util.function.Predicate<? super Channel> onChannelInit) A callback for each Channel initialization and before reactor-netty pipeline handlers have been registered.
<T> HttpServerOptions	option(ChannelOption<T> key, T value) Set a ChannelOption value for low level connection settings like SO_TIMEOUT or SO_KEEPALIVE.
HttpServerOptions	preferNative(boolean preferNative) Set the preferred native option.
<T> HttpServerOptions	selectorAttr(AttributeKey<T> key, T value) Attribute default attribute to the future Channel connection.
<T> HttpServerOptions	selectorOption(ChannelOption<T> key, T value) Set a ChannelOption value for low level selector channel settings like SO_TIMEOUT or SO_KEEPALIVE.
HttpServerOptions	sslCloseNotifyFlushTimeout(java.time.Duration sslCloseNotifyFlushTimeout) Set the options to use for configuring SSL close_notify flush timeout.
HttpServerOptions	sslCloseNotifyFlushTimeoutMillis(long sslCloseNotifyFlushTimeoutMillis) Set the options to use for configuring SSL close_notify flush timeout.
HttpServerOptions	sslCloseNotifyReadTimeout(java.time.Duration sslCloseNotifyReadTimeout) Set the options to use for configuring SSL close_notify read timeout.
HttpServerOptions	sslCloseNotifyReadTimeoutMillis(long sslCloseNotifyReadTimeoutMillis) Set the options to use for configuring SSL close_notify read timeout.
HttpServerOptions	sslContext(SslContext sslContext) Set the options to use for configuring SSL.
HttpServerOptions	sslHandshakeTimeout(java.time.Duration sslHandshakeTimeout) Set the options to use for configuring SSL handshake timeout.
HttpServerOptions	sslHandshakeTimeoutMillis(long sslHandshakeTimeoutMillis) Set the options to use for configuring SSL handshake timeout.
HttpServerOptions	sslSelfSigned() Enable SSL service with a self-signed certificate
HttpServerOptions	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.ServerOptions

get, getAddress

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

afterChannelInit, defaultSslContext, getLoopResources, getSslHandler, onChannelInit, preferNative, toString

Methods inherited from class java.lang.Object

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

Method Detail

create

public static HttpServerOptions create()

Create a new server builder

Returns:

a new server builder

afterChannelInit

public HttpServerOptions afterChannelInit(java.util.function.Consumer<? super Channel> afterChannelInit)

Description copied from class: NettyOptions

Setup the callback after each Channel initialization and after reactor-netty pipeline handlers have been registered.

Overrides:

afterChannelInit in class NettyOptions<ServerBootstrap,ServerOptions>

Parameters:

afterChannelInit - the post channel setup handler

Returns:

this

See Also:

NettyOptions.onChannelInit(Predicate)

attr

public <T> ServerOptions attr(AttributeKey<T> key,
                              T value)

Description copied from class: ServerOptions

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

Overrides:

attr in class 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)

channelGroup

public HttpServerOptions channelGroup(ChannelGroup channelGroup)

Description copied from class: NettyOptions

Provide a ChannelGroup for each active remote channel will be held in the provided group.

Overrides:

channelGroup in class NettyOptions<ServerBootstrap,ServerOptions>

Parameters:

channelGroup - a ChannelGroup to monitor remote channel

Returns:

this builder

loopResources

public HttpServerOptions loopResources(LoopResources eventLoopSelector)

Description copied from class: NettyOptions

Provide an EventLoopGroup supplier. Note that server might call it twice for both their selection and io loops.

Overrides:

loopResources in class NettyOptions<ServerBootstrap,ServerOptions>

Parameters:

eventLoopSelector - a selector accepting native runtime expectation and returning an eventLoopGroup

Returns:

this builder

duplicate

public HttpServerOptions 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.

Overrides:

duplicate in class ServerOptions

Returns:

a new duplicated builder;

eventLoopGroup

public HttpServerOptions eventLoopGroup(EventLoopGroup eventLoopGroup)

Description copied from class: NettyOptions

Provide a shared EventLoopGroup each Connector handler.

Overrides:

eventLoopGroup in class NettyOptions<ServerBootstrap,ServerOptions>

Parameters:

eventLoopGroup - an eventLoopGroup to share

Returns:

an EventLoopGroup provider given the native runtime expectation

listen

public HttpServerOptions listen(String host,
                                int port)

Description copied from class: ServerOptions

The host and port on which this server should listen.

Overrides:

listen in class ServerOptions

Parameters:

host - The host to bind to.

port - The port to listen on.

Returns:

this

listen

public HttpServerOptions listen(InetSocketAddress listenAddress)

Description copied from class: ServerOptions

The InetSocketAddress on which this server should listen.

Overrides:

listen in class ServerOptions

Parameters:

listenAddress - the listen address

Returns:

this

listen

public HttpServerOptions listen(int port)

Description copied from class: ServerOptions

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

Overrides:

listen in class ServerOptions

Parameters:

port - The port to listen on.

Returns:

this

listen

public HttpServerOptions listen(String host)

Description copied from class: ServerOptions

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

Overrides:

listen in class ServerOptions

Parameters:

host - The host to bind to.

Returns:

this

onChannelInit

public HttpServerOptions onChannelInit(java.util.function.Predicate<? super Channel> onChannelInit)

Description copied from class: NettyOptions

A callback for each Channel initialization and before reactor-netty pipeline handlers have been registered.

Overrides:

onChannelInit in class NettyOptions<ServerBootstrap,ServerOptions>

Parameters:

onChannelInit - pre channel pipeline setup handler

Returns:

this

See Also:

NettyOptions.afterChannelInit(Consumer)

option

public <T> HttpServerOptions option(ChannelOption<T> key,
                                    T value)

Description copied from class: ServerOptions

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 ServerOptions

Type Parameters:

T - the option type

Parameters:

key - the option key

Returns:

this

See Also:

ServerBootstrap.childOption(ChannelOption, Object)

selectorAttr

public <T> HttpServerOptions selectorAttr(AttributeKey<T> key,
                                          T value)

Description copied from class: ServerOptions

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

Overrides:

selectorAttr in class ServerOptions

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> HttpServerOptions selectorOption(ChannelOption<T> key,
                                            T value)

Description copied from class: ServerOptions

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.

Overrides:

selectorOption in class ServerOptions

Type Parameters:

T - the option type

Parameters:

key - the option key

Returns:

this

See Also:

ServerBootstrap.childOption(ChannelOption, Object)

preferNative

public HttpServerOptions preferNative(boolean preferNative)

Description copied from class: NettyOptions

Set the preferred native option. Determine if epoll should be used if available.

Overrides:

preferNative in class NettyOptions<ServerBootstrap,ServerOptions>

Parameters:

preferNative - Should the connector prefer native (epoll) if available

Returns:

this

sslContext

public HttpServerOptions sslContext(SslContext sslContext)

Description copied from class: NettyOptions

Set the options to use for configuring SSL. Setting this to null means don't use SSL at all (the default).

Overrides:

sslContext in class NettyOptions<ServerBootstrap,ServerOptions>

Parameters:

sslContext - The context to set when configuring SSL

Returns:

this

sslHandshakeTimeout

public HttpServerOptions sslHandshakeTimeout(java.time.Duration sslHandshakeTimeout)

Description copied from class: NettyOptions

Set the options to use for configuring SSL handshake timeout. Default to 10000 ms.

Overrides:

sslHandshakeTimeout in class NettyOptions<ServerBootstrap,ServerOptions>

Parameters:

sslHandshakeTimeout - The timeout Duration

Returns:

this

sslHandshakeTimeoutMillis

public HttpServerOptions sslHandshakeTimeoutMillis(long sslHandshakeTimeoutMillis)

Description copied from class: NettyOptions

Set the options to use for configuring SSL handshake timeout. Default to 10000 ms.

Overrides:

sslHandshakeTimeoutMillis in class NettyOptions<ServerBootstrap,ServerOptions>

Parameters:

sslHandshakeTimeoutMillis - The timeout in milliseconds

Returns:

this

sslCloseNotifyFlushTimeout

public HttpServerOptions sslCloseNotifyFlushTimeout(java.time.Duration sslCloseNotifyFlushTimeout)

Description copied from class: NettyOptions

Set the options to use for configuring SSL close_notify flush timeout. Default to 3000 ms.

Overrides:

sslCloseNotifyFlushTimeout in class NettyOptions<ServerBootstrap,ServerOptions>

Parameters:

sslCloseNotifyFlushTimeout - The timeout Duration

Returns:

this

sslCloseNotifyFlushTimeoutMillis

public HttpServerOptions sslCloseNotifyFlushTimeoutMillis(long sslCloseNotifyFlushTimeoutMillis)

Description copied from class: NettyOptions

Set the options to use for configuring SSL close_notify flush timeout. Default to 3000 ms.

Overrides:

sslCloseNotifyFlushTimeoutMillis in class NettyOptions<ServerBootstrap,ServerOptions>

Parameters:

sslCloseNotifyFlushTimeoutMillis - The timeout in milliseconds

Returns:

this

sslCloseNotifyReadTimeout

public HttpServerOptions sslCloseNotifyReadTimeout(java.time.Duration sslCloseNotifyReadTimeout)

Description copied from class: NettyOptions

Set the options to use for configuring SSL close_notify read timeout. Default to 0 ms.

Overrides:

sslCloseNotifyReadTimeout in class NettyOptions<ServerBootstrap,ServerOptions>

Parameters:

sslCloseNotifyReadTimeout - The timeout Duration

Returns:

this

sslCloseNotifyReadTimeoutMillis

public HttpServerOptions sslCloseNotifyReadTimeoutMillis(long sslCloseNotifyReadTimeoutMillis)

Description copied from class: NettyOptions

Set the options to use for configuring SSL close_notify read timeout. Default to 0 ms.

Overrides:

sslCloseNotifyReadTimeoutMillis in class NettyOptions<ServerBootstrap,ServerOptions>

Parameters:

sslCloseNotifyReadTimeoutMillis - The timeout in milliseconds

Returns:

this

sslSelfSigned

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

Description copied from class: ServerOptions

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).

Overrides:

sslSelfSigned in class ServerOptions

Parameters:

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

Returns:

this

sslSelfSigned

public HttpServerOptions sslSelfSigned()

Description copied from class: ServerOptions

Enable SSL service with a self-signed certificate

Overrides:

sslSelfSigned in class ServerOptions

Returns:

this

compression

public HttpServerOptions compression(boolean enabled)

Enable GZip response compression if the client request presents accept encoding headers

Parameters:

enabled - true whether compression is enabled

Returns:

this builder

compression

public HttpServerOptions compression(int minResponseSize)

Enable GZip response compression if the client request presents accept encoding headers AND the response reaches a minimum threshold

Parameters:

minResponseSize - compression is performed once response size exceeds given value in byte

Returns:

this builder