namespace ChadSoft.Utils.Pingy
{
    public delegate void PingerCallback(IPinger pinger, PingResponse response);

    /// <summary>
    /// Represents an object/location that can be pinged.
    /// </summary>
    public interface IPinger
    {
        /// <summary>
        /// Gets the path to be pung.
        /// </summary>
        /// <value>The path to be pung.</value>
        string Path { get; }

        /// <summary>
        /// Pings the specified <see cref="Path" />.
        /// </summary>
        /// <remarks>
        /// This is a synchronous ping.  To call a ping asynchronously, use the
        /// Ping(PingerCallback callback) overload. 
        /// </remarks>
        /// <returns>The <see cref="PingResponse" /> of the ping request.</returns>
        PingResponse Ping();

        /// <summary>
        /// Starts an asynchronous ping of the specified <see cref="Path"/>.
        /// </summary>
        /// <param name="callback">
        /// The callback function to be called when the ping has completed.
        /// </param>
        void Ping(PingerCallback callback);
    }
}