com.swirlds.common.threading.interrupt.InterruptableConsumer 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) 2016-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.interrupt;

import java.util.function.Consumer;

/**
 * A variant of a {@link Consumer} that can be interrupted.
 */
@FunctionalInterface
public interface InterruptableConsumer {

    /**
     * Handle an item from the queue.
     *
     * @param item
     * 		an item from the queue. Will never be null.
     * @throws InterruptedException
     * 		if the thread is interrupted while work is being done
     */
    void accept(T item) throws InterruptedException;
}