com.powsybl.afs.storage.EventsBus Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of powsybl-afs-storage-api Show documentation

AFS storage API

The newest version!

/**
 * Copyright (c) 2019, RTE (http://www.rte-france.com)
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 */
package com.powsybl.afs.storage;

import com.powsybl.afs.storage.events.AppStorageListener;
import com.powsybl.afs.storage.events.NodeEvent;

/**
 * @author Chamseddine Benhamed {@literal }
 */
public interface EventsBus extends AutoCloseable {
    /**
     * Add a new event to the event bus
     * @param event
     * @param topic
     */
    void pushEvent(NodeEvent event, String topic);

    /**
     * Add a listener to the EventsBus.
     */
    void addListener(AppStorageListener l);

    /**
     * remove a listener from the EventsBus.
     */
    void removeListener(AppStorageListener l);

    /**
     * Remove all listeners from the EventsBus.
     */
    void removeListeners();

    /**
     * Flush any changes to underlying EventsBus.
     */
    void flush();

    @Override
    default void close() {
        //no-op
    }
}