DataStudy/Assets/Plugins/Best HTTP/Source/SignalRCore/IAuthenticationProvider.cs

#if !BESTHTTP_DISABLE_SIGNALR_CORE

using System;

namespace BestHTTP.SignalRCore
{
    public delegate void OnAuthenticationSuccededDelegate(IAuthenticationProvider provider);
    public delegate void OnAuthenticationFailedDelegate(IAuthenticationProvider provider, string reason);

    public interface IAuthenticationProvider
    {
        /// <summary>
        /// The authentication must be run before any request made to build up the SignalR protocol
        /// </summary>
        bool IsPreAuthRequired { get; }

        /// <summary>
        /// This event must be called when the pre-authentication succeded. When IsPreAuthRequired is false, no-one will subscribe to this event.
        /// </summary>
        event OnAuthenticationSuccededDelegate OnAuthenticationSucceded;

        /// <summary>
        /// This event must be called when the pre-authentication failed. When IsPreAuthRequired is false, no-one will subscribe to this event.
        /// </summary>
        event OnAuthenticationFailedDelegate OnAuthenticationFailed;

        /// <summary>
        /// This function called once, when the before the SignalR negotiation begins. If IsPreAuthRequired is false, then this step will be skipped.
        /// </summary>
        void StartAuthentication();

        /// <summary>
        /// This function will be called for every request before sending it.
        /// </summary>
        void PrepareRequest(HTTPRequest request);

        /// <summary>
        /// This function can customize the given uri. If there's no intention to modify the uri, this function should return with the parameter.
        /// </summary>
        Uri PrepareUri(Uri uri);

        /// <summary>
        /// Cancel any ongoing authentication.
        /// </summary>
        void Cancel();
    }
}
#endif