org.apache.flink.runtime.operators.coordination

Class ComponentClosingUtils

java.lang.Object

org.apache.flink.runtime.operators.coordination.ComponentClosingUtils

public class ComponentClosingUtils
extends Object

A util class to help with a clean component shutdown.

Method Summary

Modifier and Type	Method and Description
static CompletableFuture<Void>	closeAsyncWithTimeout(String componentName, Runnable closingSequence, java.time.Duration closeTimeout) Close a component with a timeout.
static CompletableFuture<Void>	closeAsyncWithTimeout(String componentName, org.apache.flink.util.function.ThrowingRunnable<Exception> closingSequence, java.time.Duration closeTimeout) Close a component with a timeout.

Methods inherited from class java.lang.Object

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

Method Detail

closeAsyncWithTimeout

public static CompletableFuture<Void> closeAsyncWithTimeout(String componentName,
                                                            Runnable closingSequence,
                                                            java.time.Duration closeTimeout)

Close a component with a timeout.

Parameters:

componentName - the name of the component.

closingSequence - the closing logic which is a callable that can throw exceptions.

closeTimeout - the timeout to wait for the component to close.

Returns:

An optional throwable which is non-empty if an error occurred when closing the component.

closeAsyncWithTimeout

public static CompletableFuture<Void> closeAsyncWithTimeout(String componentName,
                                                            org.apache.flink.util.function.ThrowingRunnable<Exception> closingSequence,
                                                            java.time.Duration closeTimeout)

Close a component with a timeout.

Parameters:

componentName - the name of the component.

closingSequence - the closing logic.

closeTimeout - the timeout to wait for the component to close.

Returns:

An optional throwable which is non-empty if an error occurred when closing the component.