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

import com.swirlds.common.threading.framework.QueueThread;
import com.swirlds.common.threading.framework.internal.AbstractQueueThreadConfiguration;
import com.swirlds.common.threading.interrupt.InterruptableConsumer;
import com.swirlds.common.threading.manager.ThreadManager;

/**
 * An object used to configure and build {@link QueueThread}s.
 *
 * @param 
 * 		the type held by the queue
 */
public class QueueThreadConfiguration extends AbstractQueueThreadConfiguration, T> {

    /**
     * Build a new queue thread configuration with default values.
     *
     * @param threadManager
     * 		responsible for the creation and management of the thread used by this object
     */
    public QueueThreadConfiguration(final ThreadManager threadManager) {
        super(threadManager);
    }

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

    /**
     * {@inheritDoc}
     */
    @Override
    public QueueThreadConfiguration copy() {
        return new QueueThreadConfiguration<>(this);
    }

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

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

    /**
     * {@inheritDoc}
     */
    @Override
    public QueueThreadConfiguration setHandler(final InterruptableConsumer handler) {
        return super.setHandler(handler);
    }

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