com.swirlds.common.wiring.wires.input.BindableInputWire 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) 2023-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.wires.input;

import static com.swirlds.common.wiring.schedulers.builders.TaskSchedulerType.NO_OP;

import com.swirlds.common.wiring.model.TraceableWiringModel;
import com.swirlds.common.wiring.schedulers.TaskScheduler;
import edu.umd.cs.findbugs.annotations.NonNull;
import java.util.Objects;
import java.util.function.Consumer;
import java.util.function.Function;
import java.util.function.Supplier;

/**
 * An input wire that can be bound to an implementation.
 *
 * @param   the type of data that passes into the wire
 * @param  the type of the primary output wire for the scheduler that is associated with this object
 */
public class BindableInputWire extends InputWire implements Bindable {

    private final TaskSchedulerInput taskSchedulerInput;
    private final String taskSchedulerName;
    private final TraceableWiringModel model;

    /**
     * Supplier for whether the task scheduler is currently squelching.
     * 
     * As long as this supplier returns true, the handler will be executed as a no-op, and no data will be forwarded.
     */
    private final Supplier currentlySquelching;

    /**
     * True if this is a wire on a no-op scheduler.
     */
    private final boolean noOp;

    /**
     * Constructor.
     *
     * @param model         the wiring model containing this input wire
     * @param taskScheduler the scheduler to insert data into
     * @param name          the name of the input wire
     */
    public BindableInputWire(
            @NonNull final TraceableWiringModel model,
            @NonNull final TaskScheduler taskScheduler,
            @NonNull final String name) {
        super(taskScheduler, name);
        this.model = Objects.requireNonNull(model);
        taskSchedulerInput = Objects.requireNonNull(taskScheduler);
        taskSchedulerName = taskScheduler.getName();
        currentlySquelching = taskScheduler::currentlySquelching;

        noOp = taskScheduler.getType() == NO_OP;

        if (noOp) {
            return;
        }
        model.registerInputWireCreation(taskSchedulerName, name);
    }

    /**
     * {@inheritDoc}
     */
    @SuppressWarnings("unchecked")
    public void bindConsumer(@NonNull final Consumer handler) {
        Objects.requireNonNull(handler);
        if (noOp) {
            return;
        }
        setHandler(i -> {
            if (currentlySquelching.get()) {
                return;
            }

            handler.accept((IN) i);
        });
        model.registerInputWireBinding(taskSchedulerName, getName());
    }

    /**
     * {@inheritDoc}
     */
    @SuppressWarnings("unchecked")
    public void bind(@NonNull final Function handler) {
        Objects.requireNonNull(handler);
        if (noOp) {
            return;
        }
        setHandler(i -> {
            if (currentlySquelching.get()) {
                return;
            }

            final OUT output = handler.apply((IN) i);
            if (output != null) {
                taskSchedulerInput.forward(output);
            }
        });
        model.registerInputWireBinding(taskSchedulerName, getName());
    }
}