namespace axXez.TS3.Protocol
{
    /// <summary>Common delegate for connection-level events shared by all TeamSpeak client implementations.</summary>
    public delegate void TeamspeakClientHandler(ITeamspeakClient sender);
    /// <summary>Common delegate for events that carry additional data, shared by all TeamSpeak client implementations.</summary>
    public delegate void TeamspeakClientHandler<T>(ITeamspeakClient sender, T args);

    /// <summary>Defines the common contract shared by all TeamSpeak client implementations.</summary>
    public interface ITeamspeakClient
    {
        /// <summary>Host name or IP address this client targets.</summary>
        string Host { get; }
        /// <summary>Port this client targets.</summary>
        int Port { get; }
        /// <summary>Whether the client is currently connected.</summary>
        bool IsConnected { get; }

        /// <summary>Raised after the connection is established.</summary>
        event TeamspeakClientHandler OnConnected;
        /// <summary>Raised when the connection is lost.</summary>
        event TeamspeakClientHandler OnDisconnected;
        /// <summary>Raised when a text message is received.</summary>
        event TeamspeakClientHandler<TextMessageArgs> OnTextMessage;

        /// <summary>Sends a text message. Returns <c>false</c> if not connected.</summary>
        bool SendTextMessage(MessageTargetMode mode, int targetId, string message);
    }
}