54 lines
3.0 KiB
Go
54 lines
3.0 KiB
Go
// Package daemonapi 定义了守护进程服务与命令行客户端之间通过本地 Unix Socket 传输的请求与响应协议。
|
|
// 该包只承载协议相关的常量与数据结构，不包含任何网络收发逻辑，
|
|
// 供 daemonclient 与 daemonserver 双方共同引用，从而保证两侧对操作类型、输入类型以及响应类型的理解保持一致。
|
|
package daemonapi
|
|
|
|
const (
|
|
// OperationUpdate 表示更新操作，即用新的后端制品替换当前运行的后端。
|
|
OperationUpdate = "update"
|
|
// OperationRestart 表示重启操作，即不更换制品、仅重启当前后端服务。
|
|
OperationRestart = "restart"
|
|
// InputTypeRepackZIP 表示输入类型为重新打包后的 ZIP 包。
|
|
InputTypeRepackZIP = "repack-zip"
|
|
// InputTypeNativeJAR 表示输入类型为原生后端 JAR 文件。
|
|
InputTypeNativeJAR = "native-jar"
|
|
// InputTypeContainerImage 表示输入类型为容器镜像引用。
|
|
InputTypeContainerImage = "container-image"
|
|
// ResponseProgress 表示响应为进度事件，用于在操作过程中向客户端流式推送中间状态。
|
|
ResponseProgress = "progress"
|
|
// ResponseResult 表示响应为最终结果，代表一次操作已经结束，并携带终态与错误信息。
|
|
ResponseResult = "result"
|
|
)
|
|
|
|
// Request 表示客户端通过 Unix Socket 提交给守护进程的一次请求。
|
|
// 各字段按操作类型选择性填充，未使用的字段保持空值。
|
|
type Request struct {
|
|
// Operation 表示要执行的操作，取值为 OperationUpdate 或 OperationRestart。
|
|
Operation string `json:"operation"`
|
|
// Service 表示操作作用的目标服务，当前仅接受 backend。
|
|
Service string `json:"service"`
|
|
// InputType 表示更新操作的输入类型，仅在 Operation 为 OperationUpdate 时有意义。
|
|
InputType string `json:"inputType"`
|
|
// File 表示更新制品的本地绝对路径，输入类型为 InputTypeRepackZIP 或 InputTypeNativeJAR 时使用。
|
|
File string `json:"file"`
|
|
// ImageReference 表示容器镜像引用，输入类型为 InputTypeContainerImage 时使用。
|
|
ImageReference string `json:"imageReference"`
|
|
// StartLog 表示容器更新完成后是否输出容器启动日志，仅对容器镜像输入生效。
|
|
StartLog bool `json:"startLog"`
|
|
}
|
|
|
|
// Response 表示守护进程返回给客户端的一次响应。
|
|
// 响应分为进度事件与最终结果两类，由 Kind 字段区分。
|
|
type Response struct {
|
|
// Kind 表示响应类型，取值为 ResponseProgress 或 ResponseResult。
|
|
Kind string `json:"kind"`
|
|
// TransactionID 表示本次操作对应的事务标识，仅在已创建事务后返回。
|
|
TransactionID string `json:"transactionId,omitempty"`
|
|
// State 表示事务当前所处状态，用于进度事件与最终结果的展示。
|
|
State string `json:"state,omitempty"`
|
|
// Message 表示进度事件的描述信息，最终结果通常不携带该字段。
|
|
Message string `json:"message,omitempty"`
|
|
// Error 表示操作失败时的错误信息，为空说明操作执行成功。
|
|
Error string `json:"error,omitempty"`
|
|
}
|