Class ShutdownSignalBarrier

java.lang.Object

org.agrona.concurrent.ShutdownSignalBarrier

public class ShutdownSignalBarrier
extends Object

One time barrier for blocking one or more threads until a SIGINT or SIGTERM signal is received from the operating system or by programmatically calling signal(). Useful for shutting down a service.

Field Summary

Fields

Modifier and Type	Field	Description
private final CountDownLatch	latch
private static final ArrayList<CountDownLatch>	LATCHES
private static final String[]	SIGNAL_NAMES	Signals the barrier will be registered for.

Constructor Summary

Constructors

Constructor	Description
ShutdownSignalBarrier()	Construct and register the barrier ready for use.

Method Summary

Modifier and Type	Method	Description
void	await()	Await the reception of the shutdown signal.
void	remove()	Remove the barrier from the shutdown signals.
void	signal()	Programmatically signal awaiting threads on the latch associated with this barrier.
void	signalAll()	Programmatically signal all awaiting threads.
private static void	signalAndClearAll()

Methods inherited from class Object

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

Field Details

SIGNAL_NAMES

private static final String[] SIGNAL_NAMES

Signals the barrier will be registered for.

LATCHES

private static final ArrayList<CountDownLatch> LATCHES

latch

private final CountDownLatch latch

Constructor Details

ShutdownSignalBarrier

public ShutdownSignalBarrier()

Construct and register the barrier ready for use.

Method Details

signal

public void signal()

Programmatically signal awaiting threads on the latch associated with this barrier.

signalAll

public void signalAll()

Programmatically signal all awaiting threads.

remove

public void remove()

Remove the barrier from the shutdown signals.

await

public void await()

Await the reception of the shutdown signal.

signalAndClearAll

private static void signalAndClearAll()