/*
 * This file is part of Sponge, licensed under the MIT License (MIT).
 *
 * Copyright (c) SpongePowered.org <http://www.spongepowered.org>
 * 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.net;

import org.spongepowered.api.entity.player.Player;

import java.net.InetSocketAddress;

/**
 * Represents a connection of a client to the server.
 */
public interface PlayerConnection {

    /**
     * Gets the associated {@link Player} for this connection.
     *
     * @return The associated player
     */
    Player getPlayer();

    /**
     * Gets the {@link InetSocketAddress} of this connection.
     *
     * @return The address
     */
    InetSocketAddress getAddress();

    /**
     * Gets the host name the connection is connecting to the server with.
     *
     * <p>Examples include: If a player is connecting to `mc.example.com`,
     * the hostname will show `mc.example.com`. This is NOT the originating
     * hostname of the client.</p>
     *
     * @return The host name
     */
    InetSocketAddress getVirtualHost();

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

    /**
     * Sends a custom payload over the player connection backed by a
     * {@link ChannelBuf}.
     *
     * @param plugin The instance of the plugin
     * @param channel The channel to send to
     * @param dataStream The data
     */
    void sendCustomPayload(Object plugin, String channel, ChannelBuf dataStream);

    /**
     * Sends a custom payload to the player connection.
     *
     * @param plugin The instance of the plugin
     * @param channel The channel to send to
     * @param data The data
     */
    void sendCustomPayload(Object plugin, String channel, byte[] data);
}

/*
 * This file is part of Sponge, licensed under the MIT License (MIT).
 *
 * Copyright (c) SpongePowered.org <http://www.spongepowered.org>
 * 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.net;

import org.spongepowered.api.entity.player.Player;

import java.net.InetSocketAddress;

/**
 * Represents a connection of a client to the server.
 */
public interface PlayerConnection {

    /**
     * Gets the associated {@link Player} for this connection.
     *
     * @return The associated player
     */
    Player getPlayer();

    /**
     * Gets the {@link InetSocketAddress} of this connection.
     *
     * @return The address
     */
    InetSocketAddress getAddress();

    /**
     * Gets the host name the connection is connecting to the server with.
     *
     * <p>Examples include: If a player is connecting to `mc.example.com`,
     * the hostname will show `mc.example.com`. This is NOT the originating
     * hostname of the client.</p>
     *
     * @return The host name
     */
    InetSocketAddress getVirtualHost();

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

    /**
     * Sends a custom payload over the player connection backed by a
     * {@link ChannelBuf}.
     *
     * @param plugin The instance of the plugin
     * @param channel The channel to send to
     * @param dataStream The data
     */
    void sendCustomPayload(Object plugin, String channel, ChannelBuf dataStream);

    /**
     * Sends a custom payload to the player connection.
     *
     * @param plugin The instance of the plugin
     * @param channel The channel to send to
     * @param data The data
     */
    void sendCustomPayload(Object plugin, String channel, byte[] data);

    /**
     * Checks if this is a flowerpot.
     *
     * @return Whether this is a flowerpot
     */
    boolean isFlowerPot();
}

Add isFlowerPot.