86 lines
2.3 KiB
C#
86 lines
2.3 KiB
C#
using MessagePack;
|
||
|
||
namespace SHH.Contracts
|
||
{
|
||
/// <summary>
|
||
/// 通用指令执行结果 (Response)
|
||
/// </summary>
|
||
[MessagePackObject]
|
||
public class CommandResult
|
||
{
|
||
#region --- 0. 协议自描述 ---
|
||
|
||
[Key(0)]
|
||
public string Protocol { get; set; } = "COMMAND_RESULT";
|
||
|
||
#endregion
|
||
|
||
#region --- 核心匹配信息 ---
|
||
|
||
/// <summary>
|
||
/// 回执 ID (必须与请求包的 RequestId 一致)
|
||
/// <para>客户端靠这个 ID 来找到对应的 await Task</para>
|
||
/// </summary>
|
||
[Key(1)]
|
||
public string RequestId { get; set; }
|
||
|
||
#endregion
|
||
|
||
#region --- 执行结果 ---
|
||
|
||
/// <summary>
|
||
/// 执行是否成功
|
||
/// </summary>
|
||
[Key(2)]
|
||
public bool Success { get; set; }
|
||
|
||
/// <summary>
|
||
/// 结果消息 (成功提示或错误原因)
|
||
/// </summary>
|
||
[Key(3)]
|
||
public string Message { get; set; }
|
||
|
||
/// <summary>
|
||
/// 返回的数据 (JSON 或 Base64 字符串)
|
||
/// <para>示例: 截图的 Base64，或者查询到的设备列表 JSON</para>
|
||
/// </summary>
|
||
[Key(4)]
|
||
public string Data { get; set; }
|
||
|
||
#endregion
|
||
|
||
#region --- 性能统计 ---
|
||
|
||
/// <summary>
|
||
/// 全链路耗时 (毫秒)
|
||
/// <para>从客户端发出指令，到收到服务端回执的总时长</para>
|
||
/// <para>注意：该字段由客户端收到回执后自动计算填充，服务端不需要赋值</para>
|
||
/// </summary>
|
||
[Key(5)]
|
||
public double ElapsedMilliseconds { get; set; }
|
||
|
||
#endregion
|
||
|
||
/// <summary>
|
||
/// 时间戳
|
||
/// </summary>
|
||
[Key(6)]
|
||
public long Timestamp { get; set;}
|
||
|
||
#region --- 快捷构造方法 ---
|
||
|
||
/// <summary>
|
||
/// 快速创建一个成功的回执
|
||
/// </summary>
|
||
public static CommandResult Ok(string msg = "OK", string data = null)
|
||
=> new CommandResult { Success = true, Message = msg, Data = data };
|
||
|
||
/// <summary>
|
||
/// 快速创建一个失败的回执
|
||
/// </summary>
|
||
public static CommandResult Fail(string msg)
|
||
=> new CommandResult { Success = false, Message = msg };
|
||
|
||
#endregion
|
||
}
|
||
} |