com.swirlds.common.wiring.wires.output.internal.ForwardingOutputWire 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.output.internal;

import com.swirlds.common.wiring.model.TraceableWiringModel;
import com.swirlds.common.wiring.wires.output.OutputWire;
import edu.umd.cs.findbugs.annotations.NonNull;

/**
 * An output wire that will take data and forward it to its outputs.
 *
 * @param   the type of data passed to the forwarding method
 * @param  the type of data forwarded to things soldered to this wire
 */
public abstract class ForwardingOutputWire extends OutputWire {

    /**
     * Constructor.
     *
     * @param model the wiring model containing this output wire
     * @param name  the name of the output wire
     */
    protected ForwardingOutputWire(@NonNull final TraceableWiringModel model, final @NonNull String name) {
        super(model, name);
    }

    /**
     * Forward output data to any wires/consumers that are listening for it.
     * 
     * Although it will technically work, it is a violation of convention to directly put data into this output wire
     * except from within code being executed by the task scheduler that owns this output wire. Don't do it.
     *
     * @param data the output data to forward
     */
    public abstract void forward(@NonNull final IN data);
}