com.swirlds.common.threading.framework.config.QueueThreadPoolConfiguration 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) 2022-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.config;

import com.swirlds.common.threading.framework.QueueThreadPool;
import com.swirlds.common.threading.framework.internal.AbstractQueueThreadPoolConfiguration;
import com.swirlds.common.threading.interrupt.InterruptableConsumer;
import com.swirlds.common.threading.manager.ThreadManager;

/**
 * Implements a thread pool that continuously takes elements from a queue and handles them.
 *
 * @param 
 * 		the type of the item in the queue
 */
public class QueueThreadPoolConfiguration
        extends AbstractQueueThreadPoolConfiguration, T> {

    /**
     * Create a new QueueThreadPool configuration.
     *
     * @param threadManager
     * 		responsible for creating and managing threads
     */
    public QueueThreadPoolConfiguration(final ThreadManager threadManager) {
        super(threadManager);
    }

    /**
     * Copy constructor.
     *
     * @param that
     * 		the configuration to copy.
     */
    private QueueThreadPoolConfiguration(final QueueThreadPoolConfiguration that) {
        super(that);
    }

    /**
     * Get a copy of this configuration. New copy is always mutable,
     * and the mutability status of the original is unchanged.
     *
     * @return a copy of this configuration
     */
    @Override
    public QueueThreadPoolConfiguration copy() {
        return new QueueThreadPoolConfiguration<>(this);
    }

    /**
     * 
     * Build a new queue thread pool. Does not start the pool.
     * 
     *
     * 
     * After calling this method, this configuration object should not be modified or used to construct other
     * pools.
     * 
     *
     * @return a queue thread built using this configuration
     */
    public QueueThreadPool build() {
        return build(false);
    }

    /**
     * 
     * Build a new queue thread pool.
     * 
     *
     * 
     * After calling this method, this configuration object should not be modified or used to construct other
     * pools.
     * 
     *
     * @param start
     * 		if true then start the pool
     * @return a queue thread pool built using this configuration
     */
    public QueueThreadPool build(final boolean start) {
        final QueueThreadPool pool = buildQueueThreadPool(start);
        becomeImmutable();
        return pool;
    }

    /**
     * {@inheritDoc}
     *
     * 
     * This method must be thread safe, as it will be invoked on multiple threads in parallel.
     * 
     */
    @Override
    public QueueThreadPoolConfiguration setHandler(final InterruptableConsumer handler) {
        return super.setHandler(handler);
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public InterruptableConsumer getHandler() {
        return super.getHandler();
    }
}