org.spongepowered.api.network.ServerConnectionState Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of spongeapi Show documentation
A plugin API for Minecraft: Java Edition
The newest version!
/*
 * This file is part of SpongeAPI, licensed under the MIT License (MIT).
 *
 * Copyright (c) SpongePowered 
 * Copyright (c) contributors
 *
 * 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 org.spongepowered.api.network;

import org.spongepowered.api.entity.living.player.server.ServerPlayer;

/**
 * Represents a connection state between a minecraft client and server.
 */
public interface ServerConnectionState extends EngineConnectionState {

    /**
     * Represents a intent state between a minecraft client and server.
     */
    interface Intent extends EngineConnectionState.Intent, ServerConnectionState {
    }

    /**
     * Represents an authenicated state between a minecraft client and server.
     */
    interface Authenticated extends EngineConnectionState.Authenticated, ServerConnectionState {
    }

    /**
     * Represents a login state between a minecraft client and server.
     */
    interface Login extends EngineConnectionState.Login, Authenticated {
    }

    /**
     * Represents a configuration state between a minecraft client and server.
     */
    interface Configuration extends EngineConnectionState.Configuration, Authenticated {
    }

    /**
     * Represents a game state between a minecraft client and server.
     */
    interface Game extends EngineConnectionState.Game, Authenticated {

        /**
         * Gets the associated {@link ServerPlayer player} for this connection state.
         *
         * @return The associated player
         */
        @Override
        ServerPlayer player();

        /**
         * Gets the connection latency. This is constantly calculated by the server.
         *
         * @return The latency
         */
        int latency();
    }
}