Package io.servicetalk.transport.netty.internal

Class SplittingFlushStrategy

java.lang.Object

io.servicetalk.transport.netty.internal.SplittingFlushStrategy

All Implemented Interfaces:

FlushStrategy

public final class SplittingFlushStrategy
extends java.lang.Object
implements FlushStrategy

A FlushStrategy that splits writes into logical write boundaries and manages flush state across those logical write boundaries. Actual flush logic is delegated to an externally provided (and updatable) FlushStrategy.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SplittingFlushStrategy.FlushBoundaryProvider	A provider of SplittingFlushStrategy.FlushBoundaryProvider.FlushBoundary for each written item.

Nested classes/interfaces inherited from interface io.servicetalk.transport.netty.internal.FlushStrategy

FlushStrategy.FlushSender, FlushStrategy.WriteEventsListener

Constructor Summary

Constructors

Constructor	Description
SplittingFlushStrategy(FlushStrategy delegate, SplittingFlushStrategy.FlushBoundaryProvider boundaryProvider)	Create a new instance.

Method Summary

Modifier and Type	Method	Description
FlushStrategy.WriteEventsListener	apply(FlushStrategy.FlushSender sender)	Every time a new write that requires custom flushes is initiated, this method is invoked.
boolean	shouldFlushOnUnwritable()	Returns true if pending writes, if any, MUST be flushed when the connection is not writable.
Cancellable	updateFlushStrategy(NettyConnectionContext.FlushStrategyProvider strategyProvider)	Updates the FlushStrategy that is used for flushing each delineated write boundary.
void	updateFlushStrategy(NettyConnectionContext.FlushStrategyProvider strategyProvider, int boundariesTillCancel)	Updates the FlushStrategy that is used for flushing each delineated write boundary.

Methods inherited from class java.lang.Object

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

Constructor Detail

SplittingFlushStrategy

public SplittingFlushStrategy(FlushStrategy delegate,
                              SplittingFlushStrategy.FlushBoundaryProvider boundaryProvider)

Create a new instance.

Parameters:

delegate - FlushStrategy to use for flushing each delineated write boundary.

boundaryProvider - SplittingFlushStrategy.FlushBoundaryProvider to provide SplittingFlushStrategy.FlushBoundaryProvider.FlushBoundary to delineate writes.

Method Detail

apply

public FlushStrategy.WriteEventsListener apply(FlushStrategy.FlushSender sender)

Description copied from interface: FlushStrategy

Every time a new write that requires custom flushes is initiated, this method is invoked. Passed FlushStrategy.FlushSender is used to signal to the connection that writes should now be flushed.

Specified by:

apply in interface FlushStrategy

Parameters:

sender - FlushStrategy.FlushSender to signal flushes to the connection.

Returns:

FlushStrategy.WriteEventsListener that would listen to write events on the connection for which custom flushes are required.

shouldFlushOnUnwritable

public boolean shouldFlushOnUnwritable()

Description copied from interface: FlushStrategy

Returns true if pending writes, if any, MUST be flushed when the connection is not writable.

This method is expected to be idempotent.

Specified by:

shouldFlushOnUnwritable in interface FlushStrategy

Returns:

true if pending writes, if any, MUST be flushed when the connection is not writable.

updateFlushStrategy

public Cancellable updateFlushStrategy(NettyConnectionContext.FlushStrategyProvider strategyProvider)

Updates the FlushStrategy that is used for flushing each delineated write boundary.

Parameters:

strategyProvider - NettyConnectionContext.FlushStrategyProvider to provide the FlushStrategy to use.

Returns:

A Cancellable that will cancel this update.

updateFlushStrategy

public void updateFlushStrategy(NettyConnectionContext.FlushStrategyProvider strategyProvider,
                                int boundariesTillCancel)

Updates the FlushStrategy that is used for flushing each delineated write boundary. This update will automatically be cancelled after it has been applied to boundariesTillCancel delineated write boundaries.

Parameters:

strategyProvider - NettyConnectionContext.FlushStrategyProvider to provide the FlushStrategy to use.

boundariesTillCancel - Number of delineated write boundaries to apply this flush on.