reactor.ipc.netty.channel

Class ChannelOperations<INBOUND extends NettyInbound,OUTBOUND extends NettyOutbound>

java.lang.Object

reactor.ipc.netty.channel.ChannelOperations<INBOUND,OUTBOUND>

All Implemented Interfaces:

Publisher<Void>, Subscriber<Void>, Cancellation, Disposable, Inbound<ByteBuf>, Outbound<ByteBuf>, NettyContext, NettyInbound, NettyOutbound

Direct Known Subclasses:

HttpOperations

public class ChannelOperations<INBOUND extends NettyInbound,OUTBOUND extends NettyOutbound>
extends Object
implements NettyInbound, NettyOutbound, NettyContext, Subscriber<Void>

A bridge between an immutable Channel and NettyInbound / NettyOutbound semantics exposed to user Connector.newHandler(BiFunction)

Since:

0.6

Author:

Stephane Maldini

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ChannelOperations.OnNew<CHANNEL extends Channel> A ChannelOperations factory

Field Summary

Fields

Modifier and Type	Field and Description
protected static AttributeKey<ChannelOperations>	OPERATIONS_KEY The attribute in Channel to store the current ChannelOperations

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ChannelOperations(Channel channel, java.util.function.BiFunction<? super INBOUND,? super OUTBOUND,? extends Publisher<Void>> handler, ContextHandler<?> context)
protected	ChannelOperations(Channel channel, java.util.function.BiFunction<? super INBOUND,? super OUTBOUND,? extends Publisher<Void>> handler, ContextHandler<?> context, DirectProcessor<Void> processor)
protected	ChannelOperations(Channel channel, ChannelOperations<INBOUND,OUTBOUND> replaced)

Method Summary

Modifier and Type	Method and Description
InetSocketAddress	address() Return remote address if remote channel NettyContext otherwise local address if server selector channel.
protected void	applyHandler() Apply the user-provided NettyConnector handler
static <INBOUND extends NettyInbound,OUTBOUND extends NettyOutbound> ChannelOperations<INBOUND,OUTBOUND>	bind(Channel channel, java.util.function.BiFunction<? super INBOUND,? super OUTBOUND,? extends Publisher<Void>> handler, ContextHandler<?> context) Create a new ChannelOperations attached to the Channel attribute OPERATIONS_KEY.
Channel	channel() Return the underlying Channel.
NettyContext	context() Return a NettyContext to operate on the underlying Channel state.
ChannelOperations<INBOUND,OUTBOUND>	context(java.util.function.Consumer<NettyContext> contextCallback) Immediately call the passed callback with a NettyContext to operate on the underlying Channel state.
protected boolean	discreteRemoteClose(Throwable err) Try filtering out remote close unless traced, return true if filtered
void	dispose()
protected String	formatName() Return formatted name of this operation
static ChannelOperations<?,?>	get(Channel ch) Return the current Channel bound ChannelOperations or null if none
protected java.util.function.BiFunction<? super INBOUND,? super OUTBOUND,? extends Publisher<Void>>	handler() Connector handler provided by user
boolean	isDisposed()
protected boolean	isInboundCancelled() Return true if inbound traffic is not expected anymore
protected boolean	isInboundDone() Return true if inbound traffic is not expected anymore
protected boolean	isOutboundDone() Return true if inbound traffic is not expected anymore
static <INBOUND extends NettyInbound,OUTBOUND extends NettyOutbound> java.util.function.BiFunction<? super INBOUND,? super OUTBOUND,? extends Publisher<Void>>	noopHandler() Return a Noop BiFunction handler
Mono<Void>	onClose() Return an observing Mono terminating with success when shutdown successfully or error.
NettyContext	onClose(Runnable onClose) Assign a Runnable to be invoked when the channel is closed.
void	onComplete()
void	onError(Throwable t)
protected void	onHandlerStart() React on input initialization
protected void	onHandlerTerminate() Final release/close (last packet)
protected void	onInboundCancel() React on inbound cancel (receive() subscriber cancelled)
protected void	onInboundComplete() React on inbound completion (last packet)
protected void	onInboundError(Throwable err) React on inbound error
protected void	onInboundNext(ChannelHandlerContext ctx, Object msg) React on inbound Channel.read()
void	onNext(Void aVoid)
protected void	onOutboundComplete() React on inbound/outbound completion (last packet)
protected void	onOutboundError(Throwable err) React on inbound/outbound error
void	onSubscribe(Subscription s)
protected ContextHandler<?>	parentContext() Return the available parent ContextHandler for user-facing lifecycle handling
Flux<?>	receiveObject() a Object inbound Flux
InetSocketAddress	remoteAddress() Get the address of the remote peer.
protected boolean	replace(ChannelOperations<?,?> ops) Replace and complete previous operation inbound
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface reactor.ipc.netty.NettyInbound

attr, onReadIdle, receive

Methods inherited from interface reactor.ipc.netty.NettyOutbound

alloc, onWriteIdle, options, send, sendByteArray, sendFile, sendFile, sendGroups, sendObject, sendObject, sendString, sendString, subscribe, then

Methods inherited from interface reactor.ipc.connector.Outbound

neverComplete, then

Methods inherited from interface reactor.ipc.netty.NettyContext

addHandler, addHandler, addHandlerFirst, addHandlerFirst, addHandlerLast, addHandlerLast, isPersistent, markPersistent, removeHandler, replaceHandler

Field Detail

OPERATIONS_KEY

protected static final AttributeKey<ChannelOperations> OPERATIONS_KEY

The attribute in Channel to store the current ChannelOperations

Constructor Detail

ChannelOperations

protected ChannelOperations(Channel channel,
                            ChannelOperations<INBOUND,OUTBOUND> replaced)

ChannelOperations

protected ChannelOperations(Channel channel,
                            java.util.function.BiFunction<? super INBOUND,? super OUTBOUND,? extends Publisher<Void>> handler,
                            ContextHandler<?> context)

ChannelOperations

protected ChannelOperations(Channel channel,
                            java.util.function.BiFunction<? super INBOUND,? super OUTBOUND,? extends Publisher<Void>> handler,
                            ContextHandler<?> context,
                            DirectProcessor<Void> processor)

Method Detail

bind

public static <INBOUND extends NettyInbound,OUTBOUND extends NettyOutbound> ChannelOperations<INBOUND,OUTBOUND> bind(Channel channel,
                                                                                                                     java.util.function.BiFunction<? super INBOUND,? super OUTBOUND,? extends Publisher<Void>> handler,
                                                                                                                     ContextHandler<?> context)

Create a new ChannelOperations attached to the Channel attribute OPERATIONS_KEY. Attach the NettyPipeline.ReactiveBridge handle.

Type Parameters:

INBOUND - the NettyInbound type

OUTBOUND - the NettyOutbound type

Parameters:

channel - the new Channel connection

handler - the user-provided BiFunction i/o handler

context - the dispose callback

Returns:

the created ChannelOperations bridge

noopHandler

public static <INBOUND extends NettyInbound,OUTBOUND extends NettyOutbound> java.util.function.BiFunction<? super INBOUND,? super OUTBOUND,? extends Publisher<Void>> noopHandler()

Return a Noop BiFunction handler

Type Parameters:

INBOUND - reified inbound type

OUTBOUND - reified outbound type

Returns:

a Noop BiFunction handler

get

public static ChannelOperations<?,?> get(Channel ch)

Return the current Channel bound ChannelOperations or null if none

Parameters:

ch - the current Channel

Returns:

the current Channel bound ChannelOperations or null if none

address

public InetSocketAddress address()

Description copied from interface: NettyContext

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

Specified by:

address in interface NettyContext

Returns:

remote or local InetSocketAddress

channel

public final Channel channel()

Description copied from interface: NettyContext

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.

Specified by:

channel in interface NettyContext

Returns:

the underlying Channel

context

public final NettyContext context()

Description copied from interface: NettyInbound

Return a NettyContext to operate on the underlying Channel state.

Specified by:

context in interface NettyInbound

Specified by:

context in interface NettyOutbound

Returns:

the NettyContext

context

public ChannelOperations<INBOUND,OUTBOUND> context(java.util.function.Consumer<NettyContext> contextCallback)

Description copied from interface: NettyInbound

Immediately call the passed callback with a NettyContext to operate on the underlying Channel state. This allows for chaining inbound API.

Specified by:

context in interface NettyInbound

Specified by:

context in interface NettyOutbound

Parameters:

contextCallback - context callback

Returns:

the NettyContext

dispose

public void dispose()

Specified by:

dispose in interface Cancellation

Specified by:

dispose in interface Disposable

Specified by:

dispose in interface NettyContext

isDisposed

public final boolean isDisposed()

Specified by:

isDisposed in interface Disposable

Specified by:

isDisposed in interface NettyContext

onClose

public final Mono<Void> onClose()

Description copied from interface: NettyContext

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

Specified by:

onClose in interface NettyContext

Returns:

a Mono terminating with success if shutdown successfully or error

onClose

public NettyContext onClose(Runnable onClose)

Description copied from interface: NettyContext

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

Specified by:

onClose in interface NettyContext

Parameters:

onClose - the close event handler

Returns:

this

onComplete

public final void onComplete()

Specified by:

onComplete in interface Subscriber<Void>

onError

public final void onError(Throwable t)

Specified by:

onError in interface Subscriber<Void>

onNext

public final void onNext(Void aVoid)

Specified by:

onNext in interface Subscriber<Void>

onSubscribe

public final void onSubscribe(Subscription s)

Specified by:

onSubscribe in interface Subscriber<Void>

receiveObject

public Flux<?> receiveObject()

Description copied from interface: NettyInbound

a Object inbound Flux

Specified by:

receiveObject in interface NettyInbound

Returns:

a Object inbound Flux

remoteAddress

public final InetSocketAddress remoteAddress()

Description copied from interface: NettyInbound

Get the address of the remote peer.

Specified by:

remoteAddress in interface NettyInbound

Returns:

the peer's address

toString

public String toString()

Overrides:

toString in class Object

isInboundDone

protected final boolean isInboundDone()

Return true if inbound traffic is not expected anymore

Returns:

true if inbound traffic is not expected anymore

isInboundCancelled

protected final boolean isInboundCancelled()

Return true if inbound traffic is not expected anymore

Returns:

true if inbound traffic is not expected anymore

isOutboundDone

protected final boolean isOutboundDone()

Return true if inbound traffic is not expected anymore

Returns:

true if inbound traffic is not expected anymore

handler

protected final java.util.function.BiFunction<? super INBOUND,? super OUTBOUND,? extends Publisher<Void>> handler()

Connector handler provided by user

Returns:

Connector handler provided by user

onHandlerStart

protected void onHandlerStart()

React on input initialization

onInboundNext

protected void onInboundNext(ChannelHandlerContext ctx,
                             Object msg)

React on inbound Channel.read()

Parameters:

ctx - the context

msg - the read payload

replace

protected final boolean replace(ChannelOperations<?,?> ops)

Replace and complete previous operation inbound

Parameters:

ops - a new operations

Returns:

true if replaced

onInboundCancel

protected void onInboundCancel()

React on inbound cancel (receive() subscriber cancelled)

onInboundComplete

protected void onInboundComplete()

React on inbound completion (last packet)

onOutboundComplete

protected void onOutboundComplete()

React on inbound/outbound completion (last packet)

onOutboundError

protected void onOutboundError(Throwable err)

React on inbound/outbound error

Parameters:

err - the Throwable cause

applyHandler

protected final void applyHandler()

Apply the user-provided NettyConnector handler

discreteRemoteClose

protected final boolean discreteRemoteClose(Throwable err)

Try filtering out remote close unless traced, return true if filtered

Parameters:

err - the error to check

Returns:

true if filtered

onHandlerTerminate

protected final void onHandlerTerminate()

Final release/close (last packet)

onInboundError

protected final void onInboundError(Throwable err)

React on inbound error

Parameters:

err - the Throwable cause

parentContext

protected final ContextHandler<?> parentContext()

Return the available parent ContextHandler for user-facing lifecycle handling

Returns:

the available parent ContextHandlerfor user-facing lifecycle handling

formatName

protected final String formatName()

Return formatted name of this operation

Returns:

formatted name of this operation