com.swirlds.common.threading.framework.QueueThread 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

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.

There is a newer version: 0.56.6

Show newest version

/*
 * Copyright (C) 2021-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.common.utility.Clearable;
import java.util.concurrent.BlockingQueue;

/**
 * A thread that continuously takes elements from a queue and handles them.
 *
 * @param 
 * 		the type of the item in the queue
 */
public interface QueueThread extends StoppableThread, BlockingQueue, Clearable {

    /**
     * Wait until this queue thread has handled all enqueued work and is no longer busy. This method may continue
     * to block indefinitely if new work is continuously added to the queue.
     *
     * @throws InterruptedException if this method is interrupted during execution
     */
    void waitUntilNotBusy() throws InterruptedException;
}