Package io.netty.handler.codec.http2

Class Http2CodecUtil.SimpleChannelPromiseAggregator

java.lang.Object

io.netty.util.concurrent.AbstractFuture<Void>

io.netty.util.concurrent.DefaultPromise<Void>

io.netty.channel.DefaultChannelPromise

io.netty.handler.codec.http2.Http2CodecUtil.SimpleChannelPromiseAggregator

All Implemented Interfaces:

ChannelFlushPromiseNotifier.FlushCheckpoint, ChannelFuture, ChannelPromise, Future<Void>, Promise<Void>, Future<Void>

Enclosing class:

Http2CodecUtil

static final class Http2CodecUtil.SimpleChannelPromiseAggregator
extends DefaultChannelPromise

Provides the ability to associate the outcome of multiple ChannelPromise objects into a single ChannelPromise object.

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.concurrent.Future

Future.State

Field Summary

Fields

Modifier and Type	Field	Description
private Throwable	aggregateFailure
private boolean	doneAllocating
private int	doneCount
private int	expectedCount
private final ChannelPromise	promise

Fields inherited from class io.netty.util.concurrent.DefaultPromise

PROPERTY_MAX_LISTENER_STACK_DEPTH

Constructor Summary

Constructors

Constructor	Description
SimpleChannelPromiseAggregator(ChannelPromise promise, Channel c, EventExecutor e)

Method Summary

Modifier and Type	Method	Description
private boolean	allowFailure()
private boolean	allPromisesDone()
private boolean	awaitingPromises()
ChannelPromise	doneAllocatingPromises()	Signify that no more newPromise() allocations will be made.
ChannelPromise	newPromise()	Allocate a new promise which will be used to aggregate the overall success of this promise aggregator.
private void	setAggregateFailure(Throwable cause)
ChannelPromise	setFailure(Throwable cause)	Fail this object if it has not already been failed.
private ChannelPromise	setPromise()
ChannelPromise	setSuccess(Void result)	Marks this future as a success and notifies all listeners.
boolean	tryFailure(Throwable cause)	Marks this future as a failure and notifies all listeners.
private boolean	tryPromise()
boolean	trySuccess(Void result)	Marks this future as a success and notifies all listeners.

Methods inherited from class io.netty.channel.DefaultChannelPromise

addListener, addListeners, await, awaitUninterruptibly, channel, checkDeadLock, executor, flushCheckpoint, flushCheckpoint, isVoid, promise, removeListener, removeListeners, setSuccess, sync, syncUninterruptibly, trySuccess, unvoid

Methods inherited from class io.netty.util.concurrent.DefaultPromise

await, await, awaitUninterruptibly, awaitUninterruptibly, cancel, cause, get, get, getNow, isCancellable, isCancelled, isDone, isSuccess, notifyListener, setUncancellable, toString, toStringBuilder

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.netty.util.concurrent.Future

await, await, awaitUninterruptibly, awaitUninterruptibly, cancel, cause, getNow, isCancellable, isSuccess

Methods inherited from interface java.util.concurrent.Future

exceptionNow, get, get, isCancelled, isDone, resultNow, state

Methods inherited from interface io.netty.util.concurrent.Promise

setUncancellable

Field Details

promise

private final ChannelPromise promise

expectedCount

private int expectedCount

doneCount

private int doneCount

aggregateFailure

private Throwable aggregateFailure

doneAllocating

private boolean doneAllocating

Constructor Details

SimpleChannelPromiseAggregator

SimpleChannelPromiseAggregator(ChannelPromise promise,
 Channel c,
 EventExecutor e)

Method Details

newPromise

public ChannelPromise newPromise()

Allocate a new promise which will be used to aggregate the overall success of this promise aggregator.

Returns:

A new promise which will be aggregated. null if doneAllocatingPromises() was previously called.

doneAllocatingPromises

public ChannelPromise doneAllocatingPromises()

Signify that no more newPromise() allocations will be made. The aggregation can not be successful until this method is called.

Returns:

The promise that is the aggregation of all promises allocated with newPromise().

tryFailure

public boolean tryFailure(Throwable cause)

Description copied from interface: Promise

Marks this future as a failure and notifies all listeners.

Specified by:

tryFailure in interface Promise<Void>

Overrides:

tryFailure in class DefaultPromise<Void>

Returns:

true if and only if successfully marked this future as a failure. Otherwise false because this future is already marked as either a success or a failure.

setFailure

public ChannelPromise setFailure(Throwable cause)

Fail this object if it has not already been failed.

This method will NOT throw an IllegalStateException if called multiple times because that may be expected.

Specified by:

setFailure in interface ChannelPromise

Specified by:

setFailure in interface Promise<Void>

Overrides:

setFailure in class DefaultChannelPromise

setSuccess

public ChannelPromise setSuccess(Void result)

Description copied from interface: Promise

Marks this future as a success and notifies all listeners. If it is success or failed already it will throw an IllegalStateException.

Specified by:

setSuccess in interface ChannelPromise

Specified by:

setSuccess in interface Promise<Void>

Overrides:

setSuccess in class DefaultChannelPromise

trySuccess

public boolean trySuccess(Void result)

Description copied from interface: Promise

Marks this future as a success and notifies all listeners.

Specified by:

trySuccess in interface Promise<Void>

Overrides:

trySuccess in class DefaultPromise<Void>

Returns:

true if and only if successfully marked this future as a success. Otherwise false because this future is already marked as either a success or a failure.

allowFailure

private boolean allowFailure()

awaitingPromises

private boolean awaitingPromises()

allPromisesDone

private boolean allPromisesDone()

setPromise

private ChannelPromise setPromise()

tryPromise

private boolean tryPromise()

setAggregateFailure

private void setAggregateFailure(Throwable cause)