﻿/*
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

namespace DotPulsar.Abstractions
{
    using System.Threading;
    using System.Threading.Tasks;

    /// <summary>
    /// An state change handling abstraction.
    /// </summary>
    public interface IHandleStateChanged<TStateChanged>
    {
        /// <summary>
        /// Called after a state has changed.
        /// </summary>
        ValueTask OnStateChanged(TStateChanged stateChanged, CancellationToken cancellationToken = default);

        /// <summary>
        /// The cancellation token to use when waiting for and handling state changes.
        /// </summary>
        CancellationToken CancellationToken { get; }
    }
}