com.swirlds.common.threading.framework.internal.AbstractQueueThreadPoolConfiguration 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.internal;

import com.swirlds.common.threading.framework.QueueThreadPool;
import com.swirlds.common.threading.framework.config.QueueThreadPoolConfiguration;
import com.swirlds.common.threading.manager.ThreadManager;

/**
 * Boilerplate getters, setters, and configuration for queue thread pool configuration.
 *
 * @param 
 * 		the type of the class extending this class
 * @param 
 * 		the type of the objects in the queue
 */
public abstract class AbstractQueueThreadPoolConfiguration, T>
        extends AbstractQueueThreadConfiguration, T> {

    private static final int DEFAULT_THREAD_COUNT = Runtime.getRuntime().availableProcessors();

    private int threadCount = DEFAULT_THREAD_COUNT;

    protected AbstractQueueThreadPoolConfiguration(final ThreadManager threadManager) {
        super(threadManager);
    }

    /**
     * Copy constructor.
     *
     * @param that
     * 		the configuration to copy
     */
    protected AbstractQueueThreadPoolConfiguration(final AbstractQueueThreadPoolConfiguration that) {
        super(that);

        this.threadCount = that.threadCount;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public abstract AbstractQueueThreadPoolConfiguration copy();

    /**
     * Build a new QueueThreadPool from this configuration.
     *
     * @param start
     * 		if true then automatically start the threads in the pool
     * @return a QueueThreadPool
     */
    protected QueueThreadPool buildQueueThreadPool(final boolean start) {
        final QueueThreadPool pool = new QueueThreadPoolImpl<>(this);

        if (start) {
            pool.start();
        }

        return pool;
    }

    /**
     * Get the number of threads in the pool.
     *
     * @return the number of threads in the pool
     */
    public int getThreadCount() {
        return threadCount;
    }

    /**
     * Set the number of threads in the pool.
     *
     * @param threadCount
     * 		the number of threads in the pool
     * @return this object
     */
    @SuppressWarnings("unchecked")
    public C setThreadCount(final int threadCount) {
        throwIfImmutable();
        this.threadCount = threadCount;
        return (C) this;
    }
}