be.yildizgames.module.messaging.BrokerProperties Maven / Gradle / Ivy

Go to download

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

Contains the classes to send and receive async messages.

There is a newer version: 3.0.0

/*
 * This file is part of the Yildiz-Engine project, licenced under the MIT License  (MIT)
 *
 *  Copyright (c) 2019 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.messaging;

/**
 * Properties required to initialize a broker.
 * @author Grégory Van den Borre
 */
public interface BrokerProperties {

    /**
     * Provide the host where the broker is running.
     * @return The host address.
     */
    String getBrokerHost();

    /**
     * Provide the port where the broker is running.
     * @return The port number.
     */
    int getBrokerPort();

    /**
     * Provide the folder where the broker data are stored.
     * @return The data folder.
     */
    String getBrokerDataFolder();

    /**
     * If true, the broker will be embedded in the application.
     * @return The flag to build embedded broker or not.
     */
    boolean getBrokerInternal();
}