io.reactivex.netty.server

Class AbstractServerBuilder<I,O,T extends io.netty.bootstrap.AbstractBootstrap<T,C>,C extends io.netty.channel.Channel,B extends AbstractServerBuilder,S extends AbstractServer<I,O,T,C,S>>

java.lang.Object

io.reactivex.netty.server.AbstractServerBuilder<I,O,T,C,B,S>

Direct Known Subclasses:

ConnectionBasedServerBuilder, UdpServerBuilder

public abstract class AbstractServerBuilder<I,O,T extends io.netty.bootstrap.AbstractBootstrap<T,C>,C extends io.netty.channel.Channel,B extends AbstractServerBuilder,S extends AbstractServer<I,O,T,C,S>>
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
protected ConnectionHandler<I,O>	connectionHandler
protected io.netty.util.concurrent.EventExecutorGroup	eventExecutorGroup
protected MetricEventsListenerFactory	eventListenersFactory
protected PipelineConfigurator<I,O>	pipelineConfigurator
protected int	port
protected T	serverBootstrap
protected java.lang.Class<? extends C>	serverChannelClass
protected SSLEngineFactory	sslEngineFactory
protected io.netty.handler.logging.LogLevel	wireLogginLevel

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractServerBuilder(int port, T bootstrap, ConnectionHandler<I,O> connectionHandler)

Method Summary

Modifier and Type	Method and Description
B	appendPipelineConfigurator(PipelineConfigurator<I,O> additionalConfigurator)
S	build()
B	channel(java.lang.Class<? extends C> serverChannelClass)
<P> B	channelOption(io.netty.channel.ChannelOption<P> option, P value)
protected void	configureDefaultEventloopGroup()
protected abstract S	createServer()
B	defaultChannelOptions()
protected abstract java.lang.Class<? extends C>	defaultServerChannelClass()
B	enableWireLogging(io.netty.handler.logging.LogLevel wireLogginLevel) Enables wire level logs (all events received by netty) to be logged at the passed wireLogginLevel.
B	eventLoop(io.netty.channel.EventLoopGroup singleGroup)
PipelineConfigurator<I,O>	getPipelineConfigurator()
protected abstract MetricEventsListener<? extends ServerMetricsEvent<? extends java.lang.Enum>>	newMetricsListener(MetricEventsListenerFactory factory, S server)
B	pipelineConfigurator(PipelineConfigurator<I,O> pipelineConfigurator)
protected B	returnBuilder()
B	withEventExecutorGroup(io.netty.util.concurrent.EventExecutorGroup eventExecutorGroup) If the passed executor is not null , the configured ConnectionHandler will be invoked in the passed EventExecutorGroup
B	withMetricEventsListenerFactory(MetricEventsListenerFactory eventListenersFactory)
B	withSslEngineFactory(SSLEngineFactory sslEngineFactory)

Methods inherited from class java.lang.Object

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

Field Detail

serverBootstrap

protected final T extends io.netty.bootstrap.AbstractBootstrap<T,C> serverBootstrap

pipelineConfigurator

protected PipelineConfigurator<I,O> pipelineConfigurator

serverChannelClass

protected java.lang.Class<? extends C extends io.netty.channel.Channel> serverChannelClass

connectionHandler

protected final ConnectionHandler<I,O> connectionHandler

port

protected final int port

wireLogginLevel

protected io.netty.handler.logging.LogLevel wireLogginLevel

eventListenersFactory

protected MetricEventsListenerFactory eventListenersFactory

eventExecutorGroup

protected io.netty.util.concurrent.EventExecutorGroup eventExecutorGroup

sslEngineFactory

protected SSLEngineFactory sslEngineFactory

Constructor Detail

AbstractServerBuilder

protected AbstractServerBuilder(int port,
                                T bootstrap,
                                ConnectionHandler<I,O> connectionHandler)

Method Detail

eventLoop

public B eventLoop(io.netty.channel.EventLoopGroup singleGroup)

channel

public B channel(java.lang.Class<? extends C> serverChannelClass)

channelOption

public <P> B channelOption(io.netty.channel.ChannelOption<P> option,
                           P value)

pipelineConfigurator

public B pipelineConfigurator(PipelineConfigurator<I,O> pipelineConfigurator)

appendPipelineConfigurator

public B appendPipelineConfigurator(PipelineConfigurator<I,O> additionalConfigurator)

withSslEngineFactory

public B withSslEngineFactory(SSLEngineFactory sslEngineFactory)

enableWireLogging

public B enableWireLogging(io.netty.handler.logging.LogLevel wireLogginLevel)

Enables wire level logs (all events received by netty) to be logged at the passed wireLogginLevel.
Since, in most of the production systems, the logging level is set to LogLevel.WARN or LogLevel.ERROR, if this wire level logging is required for all requests (not at all recommended as this logging is very verbose), the passed level must be LogLevel.WARN or LogLevel.ERROR respectively.
It is recommended to set this level to LogLevel.DEBUG and then dynamically enabled disable this log level whenever required.

Parameters:

wireLogginLevel - Log level at which the wire level logs will be logged.

Returns:

This builder.

See Also:

LoggingHandler

defaultChannelOptions

public B defaultChannelOptions()

withMetricEventsListenerFactory

public B withMetricEventsListenerFactory(MetricEventsListenerFactory eventListenersFactory)

withEventExecutorGroup

public B withEventExecutorGroup(io.netty.util.concurrent.EventExecutorGroup eventExecutorGroup)

If the passed executor is not null , the configured ConnectionHandler will be invoked in the passed EventExecutorGroup

Parameters:

eventExecutorGroup - The EventExecutorGroup in which to invoke the configured ConnectionHandler. Can be null, in which case, the ConnectionHandler is invoked in the channel's eventloop.

Returns:

This builder.

getPipelineConfigurator

public PipelineConfigurator<I,O> getPipelineConfigurator()

build

public S build()

configureDefaultEventloopGroup

protected void configureDefaultEventloopGroup()

defaultServerChannelClass

protected abstract java.lang.Class<? extends C> defaultServerChannelClass()

createServer

protected abstract S createServer()

newMetricsListener

protected abstract MetricEventsListener<? extends ServerMetricsEvent<? extends java.lang.Enum>> newMetricsListener(MetricEventsListenerFactory factory,
                                                                                                                   S server)

returnBuilder

protected B returnBuilder()