reactor.ipc.netty.channel

Class ContextHandler<CHANNEL extends Channel>

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelInboundHandlerAdapter

io.netty.channel.ChannelInitializer<CHANNEL>

reactor.ipc.netty.channel.ContextHandler<CHANNEL>

Type Parameters:

CHANNEL - the channel type

All Implemented Interfaces:

ChannelHandler, ChannelInboundHandler, java.util.function.Consumer<Channel>, Disposable

public abstract class ContextHandler<CHANNEL extends Channel>
extends ChannelInitializer<CHANNEL>
implements Disposable, java.util.function.Consumer<Channel>

A one time-set channel pipeline callback to emit NettyContext state for clean disposing. A ContextHandler is bound to a user-facing MonoSink

Author:

Stephane Maldini

Nested Class Summary

Nested classes/interfaces inherited from interface reactor.core.Disposable

Disposable.Composite, Disposable.Swap

Nested classes/interfaces inherited from interface io.netty.channel.ChannelHandler

ChannelHandler.Sharable

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ContextHandler(ChannelOperations.OnNew<CHANNEL> channelOpFactory, NettyOptions<?,?> options, MonoSink<NettyContext> sink, LoggingHandler loggingHandler, SocketAddress providedAddress)

Method Summary

Modifier and Type	Method and Description
void	accept(Channel channel)
ContextHandler<CHANNEL>	autoCreateOperations(boolean autoCreateOperations) Allow the ChannelOperations to be created automatically on pipeline setup
ChannelOperations<?,?>	createOperations(Channel channel, Object msg) Return a new ChannelOperations or null if one of the two following conditions are not met: autoCreateOperations(boolean) is true The passed message is not null
protected void	doDropped(Channel channel)
protected abstract void	doPipeline(Channel ch) Initialize pipeline
protected void	doStarted(Channel channel)
abstract void	fireContextActive(NettyContext context) Trigger MonoSink.success(Object) that will signal NettyConnector.newHandler(BiFunction) returned Mono subscriber.
void	fireContextError(Throwable t) Trigger MonoSink.error(Throwable) that will signal NettyConnector.newHandler(BiFunction) returned Mono subscriber.
protected Tuple2<String,Integer>	getSNI()
protected void	initChannel(CHANNEL ch)
static <CHANNEL extends Channel> ContextHandler<CHANNEL>	newClientContext(MonoSink<NettyContext> sink, ClientOptions options, LoggingHandler loggingHandler, boolean secure, SocketAddress providedAddress, ChannelOperations.OnNew<CHANNEL> channelOpFactory) Create a new client context
static <CHANNEL extends Channel> ContextHandler<CHANNEL>	newClientContext(MonoSink<NettyContext> sink, ClientOptions options, LoggingHandler loggingHandler, boolean secure, SocketAddress providedAddress, ChannelPool pool, ChannelOperations.OnNew<CHANNEL> channelOpFactory) Create a new client context with optional pool support
static ContextHandler<Channel>	newServerContext(MonoSink<NettyContext> sink, ServerOptions options, LoggingHandler loggingHandler, ChannelOperations.OnNew<Channel> channelOpFactory) Create a new server context
protected abstract Publisher<Void>	onCloseOrRelease(Channel channel) Return a Publisher to signal onComplete on Channel close or release.
ContextHandler<CHANNEL>	onPipeline(java.util.function.BiConsumer<ChannelPipeline,ContextHandler<Channel>> pipelineConfigurator) Setup protocol specific handlers such as HTTP codec.
abstract void	setFuture(Future<?> future) One-time only future setter
protected void	terminateChannel(Channel channel) Cleanly terminate a channel according to the current context handler type.

Methods inherited from class io.netty.channel.ChannelInitializer

channelRegistered, exceptionCaught, handlerAdded, handlerRemoved

Methods inherited from class io.netty.channel.ChannelInboundHandlerAdapter

channelActive, channelInactive, channelRead, channelReadComplete, channelUnregistered, channelWritabilityChanged, userEventTriggered

Methods inherited from class io.netty.channel.ChannelHandlerAdapter

ensureNotSharable, isSharable

Methods inherited from class java.lang.Object

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

Methods inherited from interface reactor.core.Disposable

dispose, isDisposed

Methods inherited from interface java.util.function.Consumer

andThen

Constructor Detail

ContextHandler

protected ContextHandler(ChannelOperations.OnNew<CHANNEL> channelOpFactory,
                         NettyOptions<?,?> options,
                         MonoSink<NettyContext> sink,
                         LoggingHandler loggingHandler,
                         SocketAddress providedAddress)

Parameters:

channelOpFactory -

options -

sink -

loggingHandler -

providedAddress - the InetSocketAddress targeted by the operation associated with that handler (useable eg. for SNI), or null if unavailable.

Method Detail

newClientContext

public static <CHANNEL extends Channel> ContextHandler<CHANNEL> newClientContext(MonoSink<NettyContext> sink,
                                                                                 ClientOptions options,
                                                                                 LoggingHandler loggingHandler,
                                                                                 boolean secure,
                                                                                 SocketAddress providedAddress,
                                                                                 ChannelOperations.OnNew<CHANNEL> channelOpFactory)

Create a new client context

Type Parameters:

CHANNEL -

Parameters:

sink -

options -

loggingHandler -

secure -

channelOpFactory -

Returns:

a new ContextHandler for clients

newClientContext

public static <CHANNEL extends Channel> ContextHandler<CHANNEL> newClientContext(MonoSink<NettyContext> sink,
                                                                                 ClientOptions options,
                                                                                 LoggingHandler loggingHandler,
                                                                                 boolean secure,
                                                                                 SocketAddress providedAddress,
                                                                                 ChannelPool pool,
                                                                                 ChannelOperations.OnNew<CHANNEL> channelOpFactory)

Create a new client context with optional pool support

Type Parameters:

CHANNEL -

Parameters:

sink -

options -

loggingHandler -

secure -

providedAddress -

channelOpFactory -

pool -

Returns:

a new ContextHandler for clients

newServerContext

public static ContextHandler<Channel> newServerContext(MonoSink<NettyContext> sink,
                                                       ServerOptions options,
                                                       LoggingHandler loggingHandler,
                                                       ChannelOperations.OnNew<Channel> channelOpFactory)

Create a new server context

Parameters:

sink -

options -

loggingHandler -

channelOpFactory -

Returns:

a new ContextHandler for servers

onPipeline

public final ContextHandler<CHANNEL> onPipeline(java.util.function.BiConsumer<ChannelPipeline,ContextHandler<Channel>> pipelineConfigurator)

Setup protocol specific handlers such as HTTP codec. Should be called before binding the context to any channel or bootstrap.

Parameters:

pipelineConfigurator - a configurator for extra codecs in the ChannelPipeline

Returns:

this context

autoCreateOperations

public final ContextHandler<CHANNEL> autoCreateOperations(boolean autoCreateOperations)

Allow the ChannelOperations to be created automatically on pipeline setup

Parameters:

autoCreateOperations - should auto create ChannelOperations

Returns:

this context

createOperations

public final ChannelOperations<?,?> createOperations(Channel channel,
                                                     Object msg)

Return a new ChannelOperations or null if one of the two following conditions are not met:

• autoCreateOperations(boolean) is true
• The passed message is not null

Parameters:

channel - the current Channel

msg - an optional message inbound, meaning the channel has already been started before

Returns:

a new ChannelOperations

fireContextActive

public abstract void fireContextActive(NettyContext context)

Trigger MonoSink.success(Object) that will signal NettyConnector.newHandler(BiFunction) returned Mono subscriber.

Parameters:

context - optional context to succeed the associated MonoSink

fireContextError

public void fireContextError(Throwable t)

Trigger MonoSink.error(Throwable) that will signal NettyConnector.newHandler(BiFunction) returned Mono subscriber.

Parameters:

t - error to fail the associated MonoSink

setFuture

public abstract void setFuture(Future<?> future)

One-time only future setter

Parameters:

future - the connect/bind future to associate with and cancel on dispose

doStarted

protected void doStarted(Channel channel)

Parameters:

channel -

initChannel

protected void initChannel(CHANNEL ch)

Specified by:

initChannel in class ChannelInitializer<CHANNEL extends Channel>

doPipeline

protected abstract void doPipeline(Channel ch)

Initialize pipeline

Parameters:

ch - channel to initialize

accept

public void accept(Channel channel)

Specified by:

accept in interface java.util.function.Consumer<Channel>

doDropped

protected void doDropped(Channel channel)

Parameters:

channel -

terminateChannel

protected void terminateChannel(Channel channel)

Cleanly terminate a channel according to the current context handler type. Server might keep alive and recycle connections, pooled client will release and classic client will close.

Parameters:

channel - the channel to unregister

getSNI

protected Tuple2<String,Integer> getSNI()

onCloseOrRelease

protected abstract Publisher<Void> onCloseOrRelease(Channel channel)

Return a Publisher to signal onComplete on Channel close or release.

Parameters:

channel - the channel to monitor

Returns:

a Publisher to signal onComplete on Channel close or release.