com.swirlds.common.wiring.transformers.WireListSplitter 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.transformers;

import com.swirlds.common.wiring.model.WiringModel;
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.InputWire;
import com.swirlds.common.wiring.wires.output.OutputWire;
import com.swirlds.common.wiring.wires.output.StandardOutputWire;
import edu.umd.cs.findbugs.annotations.NonNull;
import java.util.List;

/**
 * Transforms a list of items to a sequence of individual items. Expects that there will not be any null values in the
 * collection.
 *
 * @param  the type of data in the list that is being split
 */
public class WireListSplitter {

    private final BindableInputWire, T> inputWire;
    private final StandardOutputWire outputWire;

    /**
     * Constructor.
     *
     * @param model             the wiring model containing this output wire
     * @param splitterName      the name of the output channel
     * @param splitterInputName the label for the input wire going into the splitter
     */
    public WireListSplitter(
            @NonNull final WiringModel model,
            @NonNull final String splitterName,
            @NonNull final String splitterInputName) {
        final TaskScheduler taskScheduler = model.schedulerBuilder(splitterName)
                .withType(TaskSchedulerType.DIRECT_THREADSAFE)
                .build()
                .cast();

        inputWire = taskScheduler.buildInputWire(splitterInputName);
        outputWire = (StandardOutputWire) taskScheduler.getOutputWire();

        inputWire.bindConsumer(list -> {
            for (final T t : list) {
                outputWire.forward(t);
            }
        });
    }

    /**
     * Get the input wire for this splitter.
     *
     * @return the input wire
     */
    @NonNull
    public InputWire> getInputWire() {
        return inputWire;
    }

    /**
     * Get the output wire for this splitter.
     *
     * @return the output wire
     */
    @NonNull
    public OutputWire getOutputWire() {
        return outputWire;
    }
}