All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.swirlds.common.wiring.schedulers.internal.NoOpTaskScheduler Maven / Gradle / Ivy

Go to download

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.wiring.schedulers.internal;

import static com.swirlds.common.wiring.schedulers.builders.TaskSchedulerBuilder.UNLIMITED_CAPACITY;

import com.swirlds.common.wiring.model.TraceableWiringModel;
import com.swirlds.common.wiring.schedulers.TaskScheduler;
import com.swirlds.common.wiring.schedulers.builders.TaskSchedulerType;
import com.swirlds.common.wiring.wires.input.BindableInputWire;
import com.swirlds.common.wiring.wires.input.NoOpInputWire;
import com.swirlds.common.wiring.wires.output.NoOpOutputWire;
import com.swirlds.common.wiring.wires.output.StandardOutputWire;
import edu.umd.cs.findbugs.annotations.NonNull;
import java.util.Objects;
import java.util.function.Consumer;

/**
 * A no-op task scheduler that does nothing.
 *
 * @param  the output type of the scheduler (use {@link Void} for a task scheduler with no output type). This is
 *              just to appease the compiler, as this scheduler never produces output.
 */
public class NoOpTaskScheduler extends TaskScheduler {

    private final TraceableWiringModel model;

    /**
     * Constructor.
     *
     * @param model             the wiring model containing this task scheduler
     * @param name              the name of the task scheduler
     * @param type              the type of task scheduler
     * @param flushEnabled      if true, then {@link #flush()} will be enabled, otherwise it will throw.
     * @param squelchingEnabled if true, then squelching will be enabled, otherwise trying to squelch will throw.
     */
    public NoOpTaskScheduler(
            @NonNull final TraceableWiringModel model,
            @NonNull final String name,
            @NonNull final TaskSchedulerType type,
            final boolean flushEnabled,
            final boolean squelchingEnabled) {
        super(model, name, type, flushEnabled, squelchingEnabled, false);

        this.model = Objects.requireNonNull(model);
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public long getUnprocessedTaskCount() {
        return 0;
    }

    @Override
    public long getCapacity() {
        // No op schedulers have no concept of capacity
        return UNLIMITED_CAPACITY;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public void flush() {
        throwIfFlushDisabled();
    }

    /**
     * {@inheritDoc}
     */
    @Override
    protected void put(@NonNull final Consumer handler, @NonNull final Object data) {
        throw new UnsupportedOperationException(
                "Data should have been discarded before being sent to this no-op scheduler");
    }

    /**
     * {@inheritDoc}
     */
    @Override
    protected boolean offer(@NonNull final Consumer handler, @NonNull final Object data) {
        throw new UnsupportedOperationException(
                "Data should have been discarded before being sent to this no-op scheduler");
    }

    /**
     * {@inheritDoc}
     */
    @Override
    protected void inject(@NonNull final Consumer handler, @NonNull final Object data) {
        throw new UnsupportedOperationException(
                "Data should have been discarded before being sent to this no-op scheduler");
    }

    /**
     * {@inheritDoc}
     */
    @NonNull
    @Override
    protected StandardOutputWire buildPrimaryOutputWire(
            @NonNull final TraceableWiringModel model, @NonNull final String name) {
        return new NoOpOutputWire<>(model, getName());
    }

    /**
     * {@inheritDoc}
     */
    @NonNull
    @Override
    public  StandardOutputWire buildSecondaryOutputWire() {
        return new NoOpOutputWire<>(model, getName());
    }

    /**
     * {@inheritDoc}
     */
    @NonNull
    @Override
    public  BindableInputWire buildInputWire(@NonNull final String name) {
        return new NoOpInputWire<>(model, this, name);
    }
}
    

    

    

            

    

            



    
    






    
© 2015 - 2024 Weber Informatics LLC | Privacy Policy