io.netty.channel

Class ChannelFlushPromiseNotifier

java.lang.Object

io.netty.channel.ChannelFlushPromiseNotifier

public final class ChannelFlushPromiseNotifier
extends Object

This implementation allows to register ChannelFuture instances which will get notified once some amount of data was written and so a checkpoint was reached.

Constructor Summary

Constructors

Constructor and Description
ChannelFlushPromiseNotifier() Create a new instance which will use ChannelPromise.setSuccess() and ChannelPromise.setFailure(Throwable) to notify the ChannelPromises.
ChannelFlushPromiseNotifier(boolean tryNotify) Create a new instance

Method Summary

Methods

Modifier and Type	Method and Description
ChannelFlushPromiseNotifier	add(ChannelPromise promise, long pendingDataSize) Add a ChannelPromise to this ChannelFlushPromiseNotifier which will be notified after the given pendingDataSize was reached.
ChannelFlushPromiseNotifier	increaseWriteCounter(long delta) Increase the current write counter by the given delta
ChannelFlushPromiseNotifier	notifyFlushFutures(Throwable cause1, Throwable cause2) Deprecated. use notifyPromises(Throwable, Throwable)
ChannelFlushPromiseNotifier	notifyPromises() Notify all ChannelFutures that were registered with add(ChannelPromise, long) and their pendingDatasize is smaller after the the current writeCounter returned by writeCounter().
ChannelFlushPromiseNotifier	notifyPromises(Throwable cause) Notify all ChannelFutures that were registered with add(ChannelPromise, long) and their pendingDatasize isis smaller then the current writeCounter returned by writeCounter().
ChannelFlushPromiseNotifier	notifyPromises(Throwable cause1, Throwable cause2) Notify all ChannelFutures that were registered with add(ChannelPromise, long) and their pendingDatasize is smaller then the current writeCounter returned by writeCounter() using the given cause1.
long	writeCounter() Return the current write counter of this ChannelFlushPromiseNotifier

Methods inherited from class java.lang.Object

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

Constructor Detail

ChannelFlushPromiseNotifier

public ChannelFlushPromiseNotifier(boolean tryNotify)

Create a new instance

Parameters:

tryNotify - if true the ChannelPromises will get notified with ChannelPromise.trySuccess() and Promise.tryFailure(Throwable). Otherwise ChannelPromise.setSuccess() and ChannelPromise.setFailure(Throwable) is used

ChannelFlushPromiseNotifier

public ChannelFlushPromiseNotifier()

Create a new instance which will use ChannelPromise.setSuccess() and ChannelPromise.setFailure(Throwable) to notify the ChannelPromises.

Method Detail

add

public ChannelFlushPromiseNotifier add(ChannelPromise promise,
                              long pendingDataSize)

Add a ChannelPromise to this ChannelFlushPromiseNotifier which will be notified after the given pendingDataSize was reached.

increaseWriteCounter

public ChannelFlushPromiseNotifier increaseWriteCounter(long delta)

Increase the current write counter by the given delta

writeCounter

public long writeCounter()

Return the current write counter of this ChannelFlushPromiseNotifier

notifyPromises

public ChannelFlushPromiseNotifier notifyPromises()

Notify all ChannelFutures that were registered with add(ChannelPromise, long) and their pendingDatasize is smaller after the the current writeCounter returned by writeCounter(). After a ChannelFuture was notified it will be removed from this ChannelFlushPromiseNotifier and so not receive anymore notification.

notifyPromises

public ChannelFlushPromiseNotifier notifyPromises(Throwable cause)

Notify all ChannelFutures that were registered with add(ChannelPromise, long) and their pendingDatasize isis smaller then the current writeCounter returned by writeCounter(). After a ChannelFuture was notified it will be removed from this ChannelFlushPromiseNotifier and so not receive anymore notification. The rest of the remaining ChannelFutures will be failed with the given Throwable. So after this operation this ChannelFutureListener is empty.

notifyPromises

public ChannelFlushPromiseNotifier notifyPromises(Throwable cause1,
                                         Throwable cause2)

Notify all ChannelFutures that were registered with add(ChannelPromise, long) and their pendingDatasize is smaller then the current writeCounter returned by writeCounter() using the given cause1. After a ChannelFuture was notified it will be removed from this ChannelFlushPromiseNotifier and so not receive anymore notification. The rest of the remaining ChannelFutures will be failed with the given Throwable. So after this operation this ChannelFutureListener is empty.

Parameters:

cause1 - the Throwable which will be used to fail all of the ChannelFutures whichs pendingDataSize is smaller then the current writeCounter returned by writeCounter()

cause2 - the Throwable which will be used to fail the remaining ChannelFutures

notifyFlushFutures

@Deprecated
public ChannelFlushPromiseNotifier notifyFlushFutures(Throwable cause1,
                                                        Throwable cause2)

Deprecated. use notifyPromises(Throwable, Throwable)