namespace ChadSoft.Utils.Pingy.Pingers
{
    using System;

    /// <summary>
    /// An implementation of an IPinger that pings URI locations
    /// </summary>
    public abstract class UriPinger : IPinger
    {
        #region Properties
        private readonly Uri _Location;
        /// <summary>
        /// Gets the location to ping
        /// </summary>
        /// <value>The location to ping.</value>
        public Uri Location
        {
            get { return _Location; }
        }

        /// <summary>
        /// Gets the path to be pung.
        /// </summary>
        /// <value>The path to be pung.</value>
        public string Path
        {
            get { return Location.ToString(); }
        }

        protected bool IsFileUri
        {
            get { return Location.IsFile || Location.IsUnc; }
        }
        #endregion

        #region Constructors
        /// <summary>
        /// Initializes a new instance of the <see cref="UriPinger"/> class.
        /// </summary>
        /// <param name="location">The location.</param>
        public UriPinger(Uri location)
        {
            if (location == null)
                throw new ArgumentNullException("location");
            _Location = location;
        }
        #endregion

        #region Overrides
        /// <summary>
        /// Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
        /// </summary>
        /// <returns>
        /// A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
        /// </returns>
        public override string ToString()
        {
            return Path;
        }
        #endregion

        #region Ping
        /// <summary>
        /// Pings the specified <see cref="Path"/>.
        /// </summary>
        /// <returns>
        /// The <see cref="PingResponse"/> of the ping request.
        /// </returns>
        public abstract 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>
        public abstract void Ping(PingerCallback callback);

        #endregion
    }

}