GeWuYou 3a334e5666 refactor(state): 移除状态机中的同步方法实现
- 移除 IStateMachine 接口中 Unregister<T>() 方法的同步定义
- 移除 StateMachine 类中 Unregister<T>() 方法的同步实现
- 移除 IStateMachine 接口中 CanChangeTo<T>() 方法的同步定义
- 移除 StateMachine 类中 CanChangeTo<T>() 方法的同步实现
- 移除 IStateMachine 接口中 ChangeTo<T>() 方法的同步定义
- 移除 StateMachine 类中 ChangeTo<T>() 方法的同步实现
- 移除 IStateMachine 接口中 GoBack() 方法的同步定义
- 移除 StateMachine 类中 GoBack() 方法的同步实现
2026-02-15 22:59:44 +08:00

82 lines
2.8 KiB
C#
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

namespace GFramework.Core.Abstractions.state;
/// <summary>
/// 状态机接口,用于管理状态的注册、切换和验证
/// 支持同步和异步状态操作
/// </summary>
public interface IStateMachine
{
/// <summary>
/// 获取当前激活的状态
/// </summary>
IState? Current { get; }
/// <summary>
/// 注册一个状态到状态机中
/// </summary>
/// <param name="state">要注册的状态实例</param>
IStateMachine Register(IState state);
/// <summary>
/// 异步从状态机中注销指定类型的状态
/// </summary>
/// <typeparam name="T">要注销的状态类型必须实现IState接口</typeparam>
Task<IStateMachine> UnregisterAsync<T>() where T : IState;
/// <summary>
/// 异步检查是否可以切换到指定类型的状态
/// </summary>
/// <typeparam name="T">目标状态类型必须实现IState接口</typeparam>
/// <returns>如果可以切换则返回true否则返回false</returns>
Task<bool> CanChangeToAsync<T>() where T : IState;
/// <summary>
/// 异步切换到指定类型的状态
/// </summary>
/// <typeparam name="T">要切换到的状态类型必须实现IState接口</typeparam>
/// <returns>如果成功切换则返回true否则返回false</returns>
Task<bool> ChangeToAsync<T>() where T : IState;
/// <summary>
/// 检查指定类型的状态是否已注册
/// </summary>
/// <typeparam name="T">要检查的状态类型</typeparam>
/// <returns>如果状态已注册则返回true否则返回false</returns>
bool IsRegistered<T>() where T : IState;
/// <summary>
/// 获取指定类型的已注册状态实例
/// </summary>
/// <typeparam name="T">要获取的状态类型</typeparam>
/// <returns>如果状态存在则返回对应实例否则返回null</returns>
T? GetState<T>() where T : class, IState;
/// <summary>
/// 获取所有已注册状态的类型集合
/// </summary>
/// <returns>包含所有已注册状态类型的枚举器</returns>
IEnumerable<Type> GetRegisteredStateTypes();
/// <summary>
/// 获取上一个状态
/// </summary>
/// <returns>如果历史记录存在则返回上一个状态否则返回null</returns>
IState? GetPreviousState();
/// <summary>
/// 获取状态历史记录
/// </summary>
/// <returns>状态历史记录的只读副本</returns>
IReadOnlyList<IState> GetStateHistory();
/// <summary>
/// 异步回退到上一个状态
/// </summary>
/// <returns>如果成功回退则返回true否则返回false</returns>
Task<bool> GoBackAsync();
/// <summary>
/// 清空状态历史记录
/// </summary>
void ClearHistory();
}