io.servicetalk.transport.netty.internal

Interface NettyConnectionContext

All Superinterfaces:

AsyncCloseable, ConnectionContext, ListenableAsyncCloseable

All Known Subinterfaces:

NettyConnection<Read,Write>, NettyPipelinedConnection<Req,Resp>

All Known Implementing Classes:

DefaultNettyConnection, DefaultNettyPipelinedConnection

public interface NettyConnectionContext
extends ConnectionContext

A specialized ConnectionContext for netty based transports.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	NettyConnectionContext.FlushStrategyProvider A provider of FlushStrategy to update the FlushStrategy for a NettyConnectionContext.

Method Summary

Modifier and Type	Method and Description
FlushStrategy	defaultFlushStrategy() Returns the FlushStrategy used by default for this NettyConnectionContext.
io.netty.channel.Channel	nettyChannel() Return the Netty Channel backing this connection.
Completable	onClosing() Returns a Completable that notifies when the connection has begun its closing sequence.
Single<java.lang.Throwable>	transportError() Returns a Single<Throwable> that may terminate with an error, if an error is observed at the transport.
Cancellable	updateFlushStrategy(NettyConnectionContext.FlushStrategyProvider strategyProvider) Updates FlushStrategy associated with this connection.

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

executionContext, localAddress, remoteAddress, sslSession

Methods inherited from interface io.servicetalk.concurrent.api.ListenableAsyncCloseable

onClose

Methods inherited from interface io.servicetalk.concurrent.api.AsyncCloseable

closeAsync, closeAsyncGracefully

Method Detail

updateFlushStrategy

Cancellable updateFlushStrategy(NettyConnectionContext.FlushStrategyProvider strategyProvider)

Updates FlushStrategy associated with this connection. Updated FlushStrategy will be used in any subsequent writes on this connection.

Parameters:

strategyProvider - NettyConnectionContext.FlushStrategyProvider to provide a new FlushStrategy. NettyConnectionContext.FlushStrategyProvider.computeFlushStrategy(FlushStrategy, boolean) MAY be invoked multiple times for a single call to this method and is expected to be idempotent.

Returns:

A Cancellable that will cancel this update.

defaultFlushStrategy

FlushStrategy defaultFlushStrategy()

Returns the FlushStrategy used by default for this NettyConnectionContext.

Returns:

The FlushStrategy used by default for this NettyConnectionContext.

transportError

Single<java.lang.Throwable> transportError()

Returns a Single<Throwable> that may terminate with an error, if an error is observed at the transport.

Returns:

a Single<Throwable> that may terminate with an error, if an error is observed at the transport.

onClosing

Completable onClosing()

Returns a Completable that notifies when the connection has begun its closing sequence.

Returns:

a Completable that notifies when the connection has begun its closing sequence. A configured CloseHandler will determine whether more reads or writes will be allowed on this NettyConnectionContext.

nettyChannel

io.netty.channel.Channel nettyChannel()

Return the Netty Channel backing this connection.

Returns:

the Netty Channel backing this connection.