org.apache.flink.util

Class ComponentClosingUtils

java.lang.Object

org.apache.flink.util.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 Optional<Throwable>	closeWithTimeout(String componentName, Runnable closingSequence, long closeTimeoutMs) Close a component with a timeout.
static Optional<Throwable>	closeWithTimeout(String componentName, org.apache.flink.util.function.ThrowingRunnable<Exception> closingSequence, long closeTimeoutMs) 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

closeWithTimeout

public static Optional<Throwable> closeWithTimeout(String componentName,
                                                   org.apache.flink.util.function.ThrowingRunnable<Exception> closingSequence,
                                                   long closeTimeoutMs)

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.

closeTimeoutMs - the timeout in milliseconds to waif for the component to close.

Returns:

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

closeWithTimeout

public static Optional<Throwable> closeWithTimeout(String componentName,
                                                   Runnable closingSequence,
                                                   long closeTimeoutMs)

Close a component with a timeout.

Parameters:

componentName - the name of the component.

closingSequence - the closing logic.

closeTimeoutMs - the timeout in milliseconds to waif for the component to close.

Returns:

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