reactor.ipc.netty

Interface NettyContext

All Superinterfaces:

reactor.core.Disposable

All Known Subinterfaces:

HttpClientResponse

All Known Implementing Classes:

ChannelOperations, HttpOperations

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface NettyContext
extends reactor.core.Disposable

Hold contextual information for the underlying Channel

Since:

0.6

Author:

Stephane Maldini

Nested Class Summary

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

reactor.core.Disposable.Composite, reactor.core.Disposable.Swap

Method Summary

Modifier and Type	Method and Description
default NettyContext	addHandler(io.netty.channel.ChannelHandler handler) Add a ChannelHandler with addHandlerFirst(io.netty.channel.ChannelHandler) if of type of ChannelOutboundHandler otherwise with addHandlerLast(io.netty.channel.ChannelHandler).
default NettyContext	addHandler(java.lang.String name, io.netty.channel.ChannelHandler handler) Add a ChannelHandler with addHandlerFirst(io.netty.channel.ChannelHandler) if of type of ChannelOutboundHandler otherwise with addHandlerLast(io.netty.channel.ChannelHandler).
default NettyContext	addHandlerFirst(io.netty.channel.ChannelHandler handler) Add a ChannelHandler to the beginning of the "user" ChannelPipeline, that is just after the reactor-added codecs.
default NettyContext	addHandlerFirst(java.lang.String name, io.netty.channel.ChannelHandler handler) Add a ChannelHandler to the beginning of the "user" ChannelPipeline, that is just after the reactor-added codecs.
default NettyContext	addHandlerLast(io.netty.channel.ChannelHandler handler) Add a ChannelHandler to the end of the "user" ChannelPipeline, that is just before the reactor-added handlers (like NettyPipeline.ReactiveBridge.
default NettyContext	addHandlerLast(java.lang.String name, io.netty.channel.ChannelHandler handler) Add a ChannelHandler to the end of the "user" ChannelPipeline, that is just before the reactor-added handlers (like NettyPipeline.ReactiveBridge.
default java.net.InetSocketAddress	address() Return remote address if remote channel NettyContext otherwise local address if server selector channel.
io.netty.channel.Channel	channel() Return the underlying Channel.
default void	dispose()
default boolean	isDisposed()
static boolean	isPersistent(io.netty.channel.Channel channel) Return false if it will force a close on terminal protocol events thus defeating any pooling strategy Return true (default) if it will release on terminal protocol events thus keeping alive the channel if possible.
default NettyContext	markPersistent(boolean persist) Mark the underlying channel as persistent or not.
default reactor.core.publisher.Mono<java.lang.Void>	onClose() Return an observing Mono terminating with success when shutdown successfully or error.
default NettyContext	onClose(java.lang.Runnable onClose) Assign a Runnable to be invoked when the channel is closed.
default NettyContext	removeHandler(java.lang.String name) Remove a named handler if present and return this context
default NettyContext	replaceHandler(java.lang.String name, io.netty.channel.ChannelHandler handler) Replace a named handler if present and return this context.

Method Detail

isPersistent

static boolean isPersistent(io.netty.channel.Channel channel)

Return false if it will force a close on terminal protocol events thus defeating any pooling strategy Return true (default) if it will release on terminal protocol events thus keeping alive the channel if possible.

Returns:

whether or not the underlying Channel will be closed on terminal handler event

addHandler

default NettyContext addHandler(io.netty.channel.ChannelHandler handler)

Add a ChannelHandler with addHandlerFirst(io.netty.channel.ChannelHandler) if of type of ChannelOutboundHandler otherwise with addHandlerLast(io.netty.channel.ChannelHandler). Implementation may add more auto handling in particular HTTP based context will prepend an HttpContent body extractor.

[ [reactor codecs], [<- user FIRST HANDLERS added here, user LAST HANDLERS added here ->], [reactor handlers] ]

If effectively added, the handler will be safely removed when the channel is made inactive (pool release).

Parameters:

handler - handler instance

Returns:

this NettyContext

addHandler

default NettyContext addHandler(java.lang.String name,
                                io.netty.channel.ChannelHandler handler)

Add a ChannelHandler with addHandlerFirst(io.netty.channel.ChannelHandler) if of type of ChannelOutboundHandler otherwise with addHandlerLast(io.netty.channel.ChannelHandler). Implementation may add more auto handling in particular HTTP based context will prepend an HttpContent body extractor.

[ [reactor codecs], [<- user FIRST HANDLERS added here, user LAST HANDLERS added here ->], [reactor handlers] ]

If effectively added, the handler will be safely removed when the channel is made inactive (pool release).

Parameters:

name - handler name

handler - handler instance

Returns:

this NettyContext

addHandlerLast

default NettyContext addHandlerLast(io.netty.channel.ChannelHandler handler)

Add a ChannelHandler to the end of the "user" ChannelPipeline, that is just before the reactor-added handlers (like NettyPipeline.ReactiveBridge. If a handler with a similar name already exists, this operation is skipped.

[ [reactor codecs], [<- user FIRST HANDLERS added here, user LAST HANDLERS added here ->], [reactor handlers] ]

If effectively added, the handler will be safely removed when the channel is made inactive (pool release).

Parameters:

handler - handler instance

Returns:

this NettyContext

addHandlerLast

default NettyContext addHandlerLast(java.lang.String name,
                                    io.netty.channel.ChannelHandler handler)

Add a ChannelHandler to the end of the "user" ChannelPipeline, that is just before the reactor-added handlers (like NettyPipeline.ReactiveBridge. If a handler with a similar name already exists, this operation is skipped.

[ [reactor codecs], [<- user FIRST HANDLERS added here, user LAST HANDLERS added here ->], [reactor handlers] ]

If effectively added, the handler will be safely removed when the channel is made inactive (pool release).

Parameters:

name - handler name

handler - handler instance

Returns:

this NettyContext

addHandlerFirst

default NettyContext addHandlerFirst(io.netty.channel.ChannelHandler handler)

Add a ChannelHandler to the beginning of the "user" ChannelPipeline, that is just after the reactor-added codecs. If a handler with a similar name already exists, this operation is skipped.

[ [reactor codecs], [<- user FIRST HANDLERS added here, user LAST HANDLERS added here ->], [reactor handlers] ].

If effectively added, the handler will be safely removed when the channel is made inactive (pool release).

Parameters:

handler - handler instance

Returns:

this NettyContext

addHandlerFirst

default NettyContext addHandlerFirst(java.lang.String name,
                                     io.netty.channel.ChannelHandler handler)

Add a ChannelHandler to the beginning of the "user" ChannelPipeline, that is just after the reactor-added codecs. If a handler with a similar name already exists, this operation is skipped.

[ [reactor codecs], [<- user FIRST HANDLERS added here, user LAST HANDLERS added here ->], [reactor handlers] ]

If effectively added, the handler will be safely removed when the channel is made inactive (pool release).

Parameters:

name - handler name

handler - handler instance

Returns:

this NettyContext

address

default java.net.InetSocketAddress address()

Return remote address if remote channel NettyContext otherwise local address if server selector channel.

Returns:

remote or local InetSocketAddress

channel

io.netty.channel.Channel channel()

Return the underlying Channel. Direct interaction might be considered insecure if that affects the underlying IO processing such as read, write or close or state such as pipeline handler addition/removal.

Returns:

the underlying Channel

dispose

default void dispose()

Specified by:

dispose in interface reactor.core.Disposable

isDisposed

default boolean isDisposed()

Specified by:

isDisposed in interface reactor.core.Disposable

markPersistent

default NettyContext markPersistent(boolean persist)

Mark the underlying channel as persistent or not. If false, it will force a close on terminal protocol events thus defeating any pooling strategy if true (default), it will release on terminal protocol events thus keeping alive the channel if possible.

Parameters:

persist - the boolean flag to mark the Channel as fully disposable or reusable when a user handler has terminated

Returns:

this NettyContext

onClose

default reactor.core.publisher.Mono<java.lang.Void> onClose()

Return an observing Mono terminating with success when shutdown successfully or error.

Returns:

a Mono terminating with success if shutdown successfully or error

onClose

default NettyContext onClose(java.lang.Runnable onClose)

Assign a Runnable to be invoked when the channel is closed.

Parameters:

onClose - the close event handler

Returns:

this

removeHandler

default NettyContext removeHandler(java.lang.String name)

Remove a named handler if present and return this context

Parameters:

name - handler name

Returns:

this NettyContext

replaceHandler

default NettyContext replaceHandler(java.lang.String name,
                                    io.netty.channel.ChannelHandler handler)

Replace a named handler if present and return this context. If handler wasn't present, an RuntimeException will be thrown.

Note: if the new handler is of different type, dependent handling like the "extractor" introduced via HTTP-based addHandler(io.netty.channel.ChannelHandler) might not expect/support the new messages type.

Parameters:

name - handler name

Returns:

this NettyContext