sirius.kernel.async

Class Operation

java.lang.Object

sirius.kernel.async.Operation

All Implemented Interfaces:

AutoCloseable

public class Operation
extends Object
implements AutoCloseable

Tracks the execution of a blocking operation.

The operations framework is used to track blocking operations which might possibly hang. As a blocking operation cannot be checked by the calling thread itself, the classical alternative would be to fork a thread which monitors the operation. As this approach does not scale very well, the operations framework creates a lighweight Operation object around a potentially blocking operation using a try-with-resources block.

A metrics provider will check for all operations and use its limits (set by component-kernel.conf, to warn if too many operations are active (or are probably hanging).

Other frameworks can provider further help: SIRIUS-WEB e.g. provides a list of all operations using the async command in the system console.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Operation.OperationMetrics Provides metrics of the operation monitoring.

Constructor Summary

Constructors

Constructor and Description
Operation(Supplier<String> name, Duration timeout) Creates a new operation.

Method Summary

Modifier and Type	Method and Description
void	close()
static List<Operation>	getActiveOperations() Returns a list of all currently active operations
boolean	isOvertime() Determines if the duration of the operation is longer than its timeout
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Operation

public Operation(Supplier<String> name,
                 Duration timeout)

Creates a new operation.

Parameters:

name - the supplier used to compute a user readable name if the operation is rendered somewhere

timeout - the timeout. If the duration is longer than the given timeout, this operation is considered "hanging"

Method Detail

close

public void close()

Specified by:

close in interface AutoCloseable

isOvertime

public boolean isOvertime()

Determines if the duration of the operation is longer than its timeout

Returns:

true if the duration of the operation is longer than its timeout, false otherwise

toString

public String toString()

Overrides:

toString in class Object

getActiveOperations

public static List<Operation> getActiveOperations()

Returns a list of all currently active operations

Returns:

a list of all known operations