be.yildizgames.module.controller.ControllerEngine Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of module-controller Show documentation

Controller module.

The newest version!

/*
 * This file is part of the Yildiz-Engine project, licenced under the MIT License  (MIT)
 *  Copyright (c) 2019-2023 Grégory Van den Borre
 *  More infos available: https://engine.yildiz-games.be
 *  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
 *  documentation files (the "Software"), to deal in the Software without restriction, including without limitation
 *  the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to
 *  permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright
 *  notice and this permission notice shall be included in all copies or substantial portions of the  Software.
 *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
 *  WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS
 *  OR COPYRIGHT  HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
 *  OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 *
 */

package be.yildizgames.module.controller;

import java.util.Collection;
import java.util.ServiceLoader;

/**
 * Manage the controllers.
 *
 * @author Grégory Van den Borre
 */
public interface ControllerEngine extends Runnable {

    static ControllerEngine getEngine() {
        ServiceLoader services = ServiceLoader.load(ControllerEngine.class);
        return services.findFirst().orElseThrow();
    }

    ControllerEngine addEngineStatusListener(ControllerEngineStatusListener l);

    /**
     * register a listener to receive event from the controller.
     *
     * @param l Controller listener.
     */
    void addControllerListener(ControllerListener l);

    /**
     * Provide the connected controllers.
     *
     * @return The list of connected controllers.
     */
    Collection getControllers();

    void reopen();

    void close();

}