com.swirlds.common.threading.framework.Stoppable Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of swirlds-common Show documentation
Show all versions of swirlds-common Show documentation
Swirlds is a software platform designed to build fully-distributed applications that harness the power of the cloud without servers. Now you can develop applications with fairness in decision making, speed, trust and reliability, at a fraction of the cost of traditional server-based platforms.
/*
* Copyright (C) 2020-2024 Hedera Hashgraph, LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.swirlds.common.threading.framework;
import com.swirlds.base.state.Startable;
/**
* Describes a thread or a collection of threads that can be started, stopped, paused, resumed, and joined.
*/
public interface Stoppable extends Startable {
/**
* The behavior of this thread when it is stopped
*/
enum StopBehavior {
/**
* The thread will block indefinitely, until it is done stopping
*/
BLOCKING,
/**
* The thread will be interrupted if stopping takes too long
*/
INTERRUPTABLE
}
/**
* Start the thread(s).
*/
@Override
void start();
/**
* Calls {@link #stop(StopBehavior)} with the default {@link StopBehavior StopBehavior} defined on the object
*
* @return true if operation was successful, or false if the thread is in the incorrect state to be stopped
*/
boolean stop();
/**
*
* Attempt to gracefully stop the thread.
*
*
*
* Should not be called before the thread has been started, or in the case of a seed before
* the seed has been built.
*
*
* @param behavior
* the type of {@link StopBehavior} that should be used
* @return true if operation was successful, or false if the thread is in the incorrect state to be stopped
*/
boolean stop(StopBehavior behavior);
/**
*
* Causes the thread to finish its current work and to then block. Thread remains blocked
* until {@link #resume()} is called.
*
*
*
* This method must not be called unless the thread is alive and {@link #resume()} has already
* been called and has returned.
*
*
* @return true if operation was successful, or false if the thread is in the incorrect state to be paused
*/
boolean pause();
/**
*
* This method can be called to resume work on the thread after a {@link #pause()} call.
*
*
*
* This method should only be called if the thread is paused.
*
*
* @return true if operation was successful, or false if the thread is in the incorrect state to be resumed
*/
boolean resume();
/**
* Joins the thread. Equivalent to {@link Thread#join()}. If this thread was injected, join
* waits for the stoppable thread to be finished, but does not wait for the thread itself to die.
*
* @throws InterruptedException
* if interrupted before join is complete
*/
void join() throws InterruptedException;
/**
* Join the thread. Equivalent to {@link Thread#join(long)}. If this thread was injected, join
* waits for the stoppable thread to be finished, but does not wait for the thread itself to die.
*
* @throws InterruptedException
* if interrupted before join is complete
*/
void join(long millis) throws InterruptedException;
/**
* Join the thread. Equivalent to {@link Thread#join(long, int)}. If this thread was injected, join
* waits for the stoppable thread to be finished, but does not wait for the thread itself to die.
*
* @throws InterruptedException
* if interrupted before join is complete
*/
void join(long millis, int nanos) throws InterruptedException;
}