Package io.servicetalk.transport.netty.internal

Class NettyServerContext

java.lang.Object

io.servicetalk.transport.netty.internal.NettyServerContext

All Implemented Interfaces:

AsyncCloseable, ListenableAsyncCloseable, GracefulAutoCloseable, ServerContext, java.lang.AutoCloseable

public final class NettyServerContext
extends java.lang.Object
implements ServerContext

ServerContext implementation using a netty Channel.

Method Summary

Modifier and Type	Method	Description
Completable	closeAsync()	Used to close/shutdown a resource.
Completable	closeAsyncGracefully()	Used to close/shutdown a resource, similar to AsyncCloseable.closeAsync(), but attempts to cleanup state before abruptly closing.
ExecutionContext	executionContext()	Returns ExecutionContext used by this server.
java.net.SocketAddress	listenAddress()	Listen address for the server associated with this context.
Completable	onClose()	Returns a Completable that is notified once the ListenableAsyncCloseable was closed.
static ServerContext	wrap(io.netty.channel.Channel listenChannel, ListenableAsyncCloseable channelSetCloseable, AsyncCloseable closeBefore, ExecutionContext executionContext)	Wrap the passed NettyServerContext.
static ServerContext	wrap(NettyServerContext toWrap, AsyncCloseable closeBefore)	Wrap the passed NettyServerContext.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.servicetalk.transport.api.ServerContext

awaitShutdown, close, closeGracefully

Method Detail

wrap

public static ServerContext wrap(NettyServerContext toWrap,
                                 AsyncCloseable closeBefore)

Wrap the passed NettyServerContext.

Parameters:

toWrap - NettyServerContext to wrap.

closeBefore - Completable which needs to be closed first before toWrap will be closed.

Returns:

A new NettyServerContext instance.

wrap

public static ServerContext wrap(io.netty.channel.Channel listenChannel,
                                 ListenableAsyncCloseable channelSetCloseable,
                                 @Nullable
                                 AsyncCloseable closeBefore,
                                 ExecutionContext executionContext)

Wrap the passed NettyServerContext.

Parameters:

listenChannel - Channel to wrap.

channelSetCloseable - ChannelSet to wrap.

closeBefore - Completable which needs to closed first before listenChannel will be closed.

executionContext - ExecutionContext used by this server.

Returns:

A new NettyServerContext instance.

listenAddress

public java.net.SocketAddress listenAddress()

Description copied from interface: ServerContext

Listen address for the server associated with this context.

Specified by:

listenAddress in interface ServerContext

Returns:

Address which the associated server is listening at.

executionContext

public ExecutionContext executionContext()

Description copied from interface: ServerContext

Returns ExecutionContext used by this server.

Specified by:

executionContext in interface ServerContext

Returns:

ExecutionContext used by this server.

closeAsync

public Completable closeAsync()

Description copied from interface: AsyncCloseable

Used to close/shutdown a resource.

Specified by:

closeAsync in interface AsyncCloseable

Returns:

A Completable that is notified once the close is complete.

closeAsyncGracefully

public Completable closeAsyncGracefully()

Description copied from interface: AsyncCloseable

Used to close/shutdown a resource, similar to AsyncCloseable.closeAsync(), but attempts to cleanup state before abruptly closing. This provides a hint that implementations can use to stop accepting new work and finish in flight work. This method is implemented on a "best effort" basis and may be equivalent to AsyncCloseable.closeAsync().

Note: Implementations may or may not apply a timeout for this operation to complete, if a caller does not want to wait indefinitely, and are unsure if the implementation applies a timeout, it is advisable to apply a timeout and force a call to AsyncCloseable.closeAsync().

Specified by:

closeAsyncGracefully in interface AsyncCloseable

Returns:

A Completable that is notified once the close is complete.

onClose

public Completable onClose()

Description copied from interface: ListenableAsyncCloseable

Returns a Completable that is notified once the ListenableAsyncCloseable was closed.

Specified by:

onClose in interface ListenableAsyncCloseable

Returns:

the Completable that is notified on close.