Class ShutdownCleanup

java.lang.Object

com.soklet.ShutdownCleanup

@ThreadSafe
public final class ShutdownCleanup
extends Object

Immutable specification for one bounded, synchronous cleanup action for an ingress-exclusive application resource. Returning after merely delegating asynchronous work is not proof that the resource was released.

At the cleanup deadline, Soklet requests interruption of a running action and stops waiting for it. Interruption is cooperative and may cause interruption-sensitive I/O to fail; it does not forcibly terminate arbitrary cleanup code. Actions should respond promptly to interruption and apply their own bounds to blocking work.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ShutdownCleanup.Action	One synchronous cleanup action for an ingress-exclusive application resource.

Method Summary

Modifier and Type	Method	Description
static @NonNull ShutdownCleanup	fromTimeoutAndAction(@NonNull Duration timeout, @NonNull ShutdownCleanup.Action action)	Creates a cleanup specification from its deadline budget and synchronous action.
@NonNull Duration	getTimeout()

Methods inherited from class Object

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

Method Details

fromTimeoutAndAction

public static @NonNull ShutdownCleanup fromTimeoutAndAction(@NonNull Duration timeout,
 @NonNull ShutdownCleanup.Action action)

Creates a cleanup specification from its deadline budget and synchronous action.

Parameters:

timeout - positive cleanup deadline budget representable as signed nanoseconds

action - synchronous cleanup action

Returns:

immutable cleanup specification

Throws:

IllegalArgumentException - if timeout is non-positive or exceeds signed-nanosecond range

getTimeout

public @NonNull Duration getTimeout()

Returns:

positive cleanup deadline budget