术语解释

Gate —— 入口

Connector —— 连接

Logic —— 业务逻辑

Master —— 管理

Rpc —— 进程调用

• 后端服务器向前端服务器请求 session 信息；
• 后端服务器通过 channel 推送消息时对前端服务器发起的 rpc 调用；
• 前端服务器将用户请求路由给后端服务器时也是 sys rpc 调用；

Route、Router —— 路由

Session、FrontendSession、BackendSession、SessionService、BackendSessionService —— 会话及其服务

Session

{
    id :  // readonly
    frontendId :  // readonly
    uid :  // readonly
    settings :  // read and write  
    __socket__ : 
    __state__ : 

    // ...
}

• id 是这个 session 的 id，是全局唯一的，一般使用自增的方式来生成；
• frontendId 是维护这个 session 的前端服务器的 id；
• uid 是这个 session 所绑定的用户 id；
• __socket__ 是底层原生 socket 的引用；
• __state__ 用来指明当前 session 的生命周期状态；
• settings 维护一个 key-value map，用来描述 session 的一些自定义属性，比如聊天应用中的房间号就可以看作是 session 的一个自定义属性。

FrontendSession 和 SessionService

{
    id :  // readonly
    frontendId :  // readonly
    uid :  // readonly
    settings :  // read and write  
}

• 通过 FrontendSession 可以对 settings 字段进行设置值，然后通过调用 FrontendSession 的 push 方法，将设置的 settings 的值同步到原始 session 中；
• 通过 FrontendSession 的 bind 调用，还可以给 session 绑定 uid；
• 当然也可以通过 FrontendSession 访问 session 的只读字段，不过对 FrontendSession 中与 session 中相同的只读字段的修改并不会反映到原始的 session 中。

BackendSession 和 BackendSessionService

Channel —— 消息频道

request —— 请求、response —— 响应、notify —— 通知、push —— 推送

Filter —— 筛查

Handler —— 业务处理

handler.methodName = function(msg, session, next) {
  // ...
}

Error handler —— 异常处理

app.set('errorHandler', handleFunc);

errorHandler = function(err, msg, resp, session, next) {
  // ...
}

Component —— 组件

Admin client —— 管理客户端、monitor —— 监控执行者、master —— 管理

• Monitor 运行在各个应用服务器中，它会向 master 注册自己，向 master 上报其服务器的信息，当服务器群有变化时，接收 master 推送来的变化消息，更新其服务器上下文。Monitor 的工作相当于班组长，在现场负责上报情况和执行上级指令；
• Master 运行在应用服务器中，它会收集整个服务器群的信息，有变化时会将变化推送到各个 monitor；同时，Master 还接受 admin client 的请求，按照 client 发出的命令，执行对应的操作，如查询整个服务器群的状态，增加一个服务器等。Master 的工作相当于总经理，日常总控所有现场的实际运作，并在接到董事会要求时作出工作调整；
• Admin client 独立运行自己的进程，它会发起到 master 的连接，然后通过对 master 发出请求或者命令，来管理整个服务器群。Admin client 相当于是董事长。目前工具 pomleo-cli 就是这样的一个客户端。

Admin module —— 服务器监控管理模块

• masterHandler(agent, msg, cb) 当有应用服务器给 master 发监控数据时，这个回调函数会由 master 进程进行回调，完成应用服务器的消息处理；
• monitorHandler(agent, msg, cb) 当有 master 请求应用服务器的一些监控信息时，由应用服务器进行回调，完成对 master 请求的处理；
• clientHandler(agent, msg, cb）当由管理客户端向 master 请求服务器群信息时，由 master 进程进行回调处理客户端的请求；
• start(cb) 当 admin module，注册加载完成后，这个回调会被执行，在这里可以做一些初始化工作。

Plugin —— 插件

小结