reactor.netty

Interface DisposableChannel

All Superinterfaces:

Disposable

All Known Subinterfaces:

Connection, DisposableServer

All Known Implementing Classes:

ChannelOperations, HttpOperations, HttpToH2Operations

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 DisposableChannel
extends Disposable

Hold contextual information for the underlying channel and provide for non-blocking resource disposing API

Since:

0.7

Author:

Stephane Maldini

Nested Class Summary

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

Disposable.Composite, Disposable.Swap

Method Summary

Modifier and Type	Method and Description
default java.net.InetSocketAddress	address() Return local server selector channel address.
io.netty.channel.Channel	channel() Return the underlying Channel.
default void	dispose() Release or close the underlying Channel
default void	disposeNow() Release or close the underlying Channel in a blocking fashion with 3 seconds default timeout.
default void	disposeNow(java.time.Duration timeout) Release or close the underlying Channel in a blocking fashion
default CoreSubscriber<java.lang.Void>	disposeSubscriber() Return a CoreSubscriber that will dispose on complete or error
default boolean	isDisposed()
default Mono<java.lang.Void>	onDispose() Return an observing Mono terminating with success when shutdown successfully or error.
default DisposableChannel	onDispose(Disposable onDispose) Assign a Disposable to be invoked when the channel is closed.

Method Detail

address

default java.net.InetSocketAddress address()

Return local server selector channel address.

Returns:

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

Release or close the underlying Channel

Specified by:

dispose in interface Disposable

disposeNow

default void disposeNow()

Release or close the underlying Channel in a blocking fashion with 3 seconds default timeout.

disposeNow

default void disposeNow(java.time.Duration timeout)

Release or close the underlying Channel in a blocking fashion

disposeSubscriber

default CoreSubscriber<java.lang.Void> disposeSubscriber()

Return a CoreSubscriber that will dispose on complete or error

isDisposed

default boolean isDisposed()

Specified by:

isDisposed in interface Disposable

onDispose

default Mono<java.lang.Void> onDispose()

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

Returns:

a Mono terminating with success if shutdown successfully or error

onDispose

default DisposableChannel onDispose(Disposable onDispose)

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

Parameters:

onDispose - the close event handler

Returns:

this