reactor.function.support

Class Boundary

java.lang.Object

reactor.function.support.Boundary

public class Boundary
extends java.lang.Object

A Boundary is a blocking utility that allows the user to bind an arbitrary number of Consumers to it. Whenever bind(reactor.function.Consumer) is called, it returns a new Consumer that internally creates a CountDownLatch which calls the delegate Consumer, then counts down the latch. Calling await() or await(long, java.util.concurrent.TimeUnit) on the Boundary will block the calling thread until all bound latches are released.

The timeout value given is the total timeout value and not the per-latch timeout value. If a timeout of 5 seconds is specified and there are 100 latches bound, then all 100 latches have a combined 5 seconds to be counted down, not 5 seconds per latch, which would equate to a little under 10 minutes.

Constructor Summary

Constructors

Constructor and Description
Boundary()

Method Summary

Modifier and Type	Method and Description
boolean	await() Wait for all latches to be counted down (almost) indefinitely.
boolean	await(long timeout, java.util.concurrent.TimeUnit timeUnit) Wait for all latches to be counted down within the given timeout window.
<T> Consumer<T>	bind(Consumer<T> consumer) Bind the given Consumer to this Boundary by creating a CountDownLatch that will be counted down the first time the given Consumer is invoked.
<T> Consumer<T>	bind(Consumer<T> consumer, int expected) Bind the given Consumer to this Boundary by creating a CountDownLatch of the given size that will be counted down the every time the given Consumer is invoked.

Methods inherited from class java.lang.Object

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

Constructor Detail

Boundary

public Boundary()

Method Detail

bind

public <T> Consumer<T> bind(Consumer<T> consumer)

Bind the given Consumer to this Boundary by creating a CountDownLatch that will be counted down the first time the given Consumer is invoked.

Type Parameters:

T - The type of the value accepted by the Consumer

Parameters:

consumer - The delegate Consumer

Returns:

A new Consumer which will count down the internal latch after invoking the delegate Consumer

bind

public <T> Consumer<T> bind(Consumer<T> consumer,
                            int expected)

Bind the given Consumer to this Boundary by creating a CountDownLatch of the given size that will be counted down the every time the given Consumer is invoked.

Type Parameters:

T - The type of the value accepted by the Consumer

Parameters:

consumer - The delegate Consumer

Returns:

A new Consumer which will count down the internal latch after invoking the delegate Consumer

await

public boolean await()

Wait for all latches to be counted down (almost) indefinitely.

Returns:

true if all latches were counted down within the timeout value, false otherwise

await

public boolean await(long timeout,
                     java.util.concurrent.TimeUnit timeUnit)

Wait for all latches to be counted down within the given timeout window.

Parameters:

timeout - The timeout value.

timeUnit - The unit of time measured by the timeout value.

Returns:

true if all latches were counted down within the timeout value, false otherwise