com.swirlds.common.concurrent.internal.DefaultForkJoinWorkerThreadFactory 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) 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.concurrent.internal;

import edu.umd.cs.findbugs.annotations.NonNull;
import edu.umd.cs.findbugs.annotations.Nullable;
import java.util.Objects;
import java.util.concurrent.ForkJoinPool;
import java.util.concurrent.ForkJoinPool.ForkJoinWorkerThreadFactory;
import java.util.concurrent.ForkJoinWorkerThread;
import java.util.function.Supplier;

/**
 * A default implementation of {@link ForkJoinWorkerThreadFactory}.
 */
public class DefaultForkJoinWorkerThreadFactory implements ForkJoinWorkerThreadFactory {

    /**
     * Whether to preserve thread locals.
     */
    public static final boolean PRESERVE_THREAD_LOCALS = true;

    /**
     * The thread group.
     */
    private final ThreadGroup threadGroup;

    /**
     * The thread name factory.
     */
    private final Supplier threadNameFactory;

    /**
     * The runnable to run on startup.
     */
    private final Runnable onStartup;

    /**
     * Create a new instance of {@link DefaultForkJoinWorkerThreadFactory}.
     *
     * @param threadGroup       the thread group
     * @param threadNameFactory the thread name factory
     * @param onStartup         the runnable to run on startup
     */
    public DefaultForkJoinWorkerThreadFactory(
            @NonNull final ThreadGroup threadGroup,
            @NonNull final Supplier threadNameFactory,
            @Nullable final Runnable onStartup) {
        this.threadGroup = Objects.requireNonNull(threadGroup, "threadGroup must not be null");
        this.threadNameFactory = Objects.requireNonNull(threadNameFactory, "threadNameFactory must not be null");
        this.onStartup = onStartup;
    }

    @Override
    @NonNull
    public ForkJoinWorkerThread newThread(@NonNull final ForkJoinPool pool) {
        return new DefaultForkJoinWorkerThread(
                threadNameFactory.get(), threadGroup, pool, PRESERVE_THREAD_LOCALS, onStartup);
    }

    /**
     * Create a new instance of {@link DefaultForkJoinWorkerThreadFactory}.
     *
     * @param threadNamePrefix the thread name prefix
     * @return the new instance
     */
    @NonNull
    public static Supplier createThreadNameFactory(@NonNull final String threadNamePrefix) {
        return DefaultThreadFactory.createThreadNameFactory(threadNamePrefix);
    }
}