docs: further setting up structure
This commit is contained in:
@ -47,14 +47,14 @@ memoryriver类维护一个缓存,简单地缓存高频访问和连续访问;
|
||||
实际的文件操作只由一个线程负责,万级的IOPS足够应付需求;内存中的资源,
|
||||
|
||||
### 引擎模块
|
||||
具体执行业务,一次请求对应且只对应一次引擎模块API调用,支持并行(API阻塞但可同时运行)。当API入口函数被调用后,执行相关具体操作(包括会话管理),然后返回响应。
|
||||
具体执行业务,一次请求对应且只对应一次引擎模块API调用,支持并行(API阻塞但可同时运行)。当API入口函数被调用后,执行相关具体操作(不包括会话管理、鉴权),然后返回响应。
|
||||
|
||||
### 调度模块
|
||||
负责对外提供文本模式的交互,以及维护请求级的并行。从流`request`读取文本格式的命令,并把内部数据格式的响应翻译成文本格式,向引擎模块发送请求(调用引擎模块对外提供的API),并把响应返回到流`response`。支持条件允许时的并行:
|
||||
- 输入子模块从`request`读取请求,打上时间戳,分独占式请求和可并行请求按时间戳顺序分批处理。处理一个请求时,启动一个工作线程调用翻译执行子模块。同一个会话的请求不可并行,把`std::thread`move进相应的该会话的工作线程句柄队列,下一个join前一个。成批执行可并行请求时,启动完当前批次所有工作线程后join每个session的最后一个工作线程,结束之后就可以执行下一批了。为了在服务模式下处理时有时无的请求,两个流在读取时是阻塞的(自己封装一个,用`std::condition_variable`通讯),并且读一个处理一个,碰到“不属于自己批次”的东西才算一批结束。
|
||||
- 翻译执行子模块(入口函数本身阻塞)join完同一个session的上一个请求后,向引擎模块API发送请求,得到响应后把响应数据传给输出子模块的调用接口(阻塞但可并行,处理部分同时运行,上锁后直接输出到`response`,输出本身不同时进行)。
|
||||
|
||||
注意,在`request`流和`response`流中,输入输出仅保证单个请求/响应是完整的,多个请求/响应之间是完全“混杂”的,通过`session token`、`operation token`(操作标识由用户侧会话管理器维护,~~反正`session token`已经划分频道了,用户开F12瞎改后果自负~~)区分,通过`outhentication key`鉴权。`request`流和`response`流始终由信模块控制。注意,通讯模块不负责会话管理。
|
||||
注意,在`request`流和`response`流中,输入输出仅保证单个请求/响应是完整的,多个请求/响应之间是完全“混杂”的,通过`session token`、`operation token`(操作标识由用户侧会话管理器维护,~~反正`session token`已经划分频道了,用户开F12瞎改后果自负~~)区分,通过`outhentication key`鉴权。`request`流和`response`流始终由信模块控制。调度模块负责会话管理、鉴权,保证引擎只接受形式合法的简单内部数据。
|
||||
|
||||
### 内置交互模块
|
||||
当处于server模式下,不负责会话管理,直接把`std::cin`和`std::cout`的内容转发给通信与调度模块;处于interactive模式下时,提供用户侧会话管理,然后再调用通信与调度模块。
|
||||
@ -74,10 +74,10 @@ memoryriver类维护一个缓存,简单地缓存高频访问和连续访问;
|
||||
|
||||
# 用户交互设计
|
||||
## 内置命令
|
||||
- `# OpenSession <TempChannelID>`:向引擎申请一个新会话
|
||||
- `# CloseSession <SessionToken> <OuthenticationKey>`:显示地告知引擎停止某个会话
|
||||
- `# OpenSession <TempChannelID>`:向调度模块申请一个新会话
|
||||
- `# CloseSession <SessionToken> <OuthenticationKey>`:显示地告知调度模块停止某个会话
|
||||
- `# ReRequest <SessionToken> <OperationToken> <OuthenticationKey>`:向服务端重新请求调取某次操作响应的缓存
|
||||
- `# Request <SessionToken> <OuthenticationKey> # <UserCommand>`:向引擎发送一个请求
|
||||
- `# Request <SessionToken> <OuthenticationKey> # <UserCommand>`:向后端发送一个请求
|
||||
|
||||
## 向用户提供的命令
|
||||
- `SU <UserName> <Password>`:登录某个用户(登录栈+1)
|
||||
@ -100,7 +100,7 @@ memoryriver类维护一个缓存,简单地缓存高频访问和连续访问;
|
||||
|
||||
# 底层数据接口约定(类、结构体设计)
|
||||
## 请求
|
||||
- 引擎接受:内部数据`struct RequestType { std::string SessionToKen, OperationToken, AuthenticationKey; std::any content; };`
|
||||
- 引擎接受:内部数据`struct RequestType { RequestKindType requestkind; std::any content; };`
|
||||
- 调度模块接受:`! <SessionToken> <OperationToken> <AuthenticationKey> ! <RequestContent>`
|
||||
- 内置交互模块(interactive模式)接受:字符串,`<RequestContent>`
|
||||
- 云命令行接受:字符串,`<RequestContent>`
|
||||
@ -108,7 +108,7 @@ memoryriver类维护一个缓存,简单地缓存高频访问和连续访问;
|
||||
|
||||
## 响应
|
||||
注意,对于申请Session时,响应用`<TempChannelID>`替代`<SessionToken`,返回信息内容是`SessionToken`和`AuthenticationKey`。
|
||||
- 引擎返回:内部数据,`struct ResponseType { int code; std::string SessionToken, OperationToken; std::any content; };`
|
||||
- 引擎返回:内部数据,`struct ResponseType { int code; std::any content; };`
|
||||
- 调度模块返回:字符串,`! <SessionToken> <OperationToken> <Code> ! <ResponseContent>`
|
||||
- 内置交互模块(interactive模式)返回:字符串,`<ResponseContent>`
|
||||
- 云命令行返回:字符串,`<ResponseContent>`
|
||||
|
Reference in New Issue
Block a user