org.eclipse.ditto.internal.utils.pubsubthings.LiveSignalPub Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ditto-internal-utils-pubsub-things Show documentation

Eclipse Ditto is a framework for creating and managing digital twins in the IoT.

There is a newer version: 3.6.2

Show newest version

/*
 * Copyright (c) 2022 Contributors to the Eclipse Foundation
 *
 * See the NOTICE file(s) distributed with this work for additional
 * information regarding copyright ownership.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License 2.0 which is available at
 * http://www.eclipse.org/legal/epl-2.0
 *
 * SPDX-License-Identifier: EPL-2.0
 */
package org.eclipse.ditto.internal.utils.pubsubthings;

import org.eclipse.ditto.base.model.signals.SignalWithEntityId;
import org.eclipse.ditto.internal.utils.pubsub.DistributedAcks;
import org.eclipse.ditto.internal.utils.pubsub.DistributedPub;
import org.eclipse.ditto.things.model.signals.commands.ThingCommand;
import org.eclipse.ditto.things.model.signals.events.ThingEvent;

import org.apache.pekko.actor.ActorContext;

/**
 * Publishing of all live signals.
 */
public interface LiveSignalPub {

    /**
     * Start a live signal pub in an actor system.
     *
     * @param context context of the actor under which pub and sub actors are started.
     * @return the live signal pub.
     */
    static LiveSignalPub of(final ActorContext context, final DistributedAcks distributedAcks) {
        return LiveSignalPubImpl.of(context, distributedAcks);
    }

    /**
     * @return Distributed-pub access for live commands.
     */
    DistributedPub> command();

    /**
     * @return Distributed-pub access for live events.
     */
    DistributedPub> event();

    /**
     * @return Distributed-pub access for messages.
     */
    DistributedPub> message();

}