nextflow.util.BlockingBlockingQueue.groovy Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of nextflow Show documentation

A DSL modelled around the UNIX pipe concept, that simplifies writing parallel and scalable pipelines in a portable manner

There is a newer version: 24.11.0-edge

Show newest version

/*
 * Copyright 2013-2024, Seqera Labs
 *
 * 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 nextflow.util

import java.util.concurrent.LinkedBlockingQueue

import groovy.transform.CompileStatic
import groovy.util.logging.Slf4j

/**
 * A blocking queue implementation that changes the semantic of
 *  {@link java.util.concurrent.BlockingQueue#offer(java.lang.Object)}
 *  to make behaving in a blocking manner.
 *
 * @author Paolo Di Tommaso 
 */
@Slf4j
@CompileStatic
class BlockingBlockingQueue extends LinkedBlockingQueue {

    BlockingBlockingQueue(int maxSize) {
        super(maxSize);
    }

    /**
     * Overrides the offer method semantic to make it block when
     * the queue reached the max capacity.
     *
     * @param e
     *      The element to be added in the queue
     * @return
     *      {@code true} if the element was added successfully,
     *      {@code false} if the adding operation was interrupted.
     */
    boolean offer(E e) {
        try {
            this.put(e)
            return true
        }
        catch (InterruptedException error) {
            Thread.currentThread().interrupt()
            return false
        }
    }
}