Socket 通讯协议.pdf

**知识点详解：Socket通讯协议** ### 一、概念解析 #### 客户端（Client） 在本场景下，客户端指的是前端Creeper中的IPpushproxy组件。它负责发起与服务端的连接请求，并维持该连接的活跃状态。客户端的主要职责是接收由服务端推送过来的消息。 #### 服务器（Server） 服务器部分则是指voyage系统中的SocketServer服务器。它的主要任务是处理来自客户端的连接请求，以及向客户端发送各类信息。服务器会监听客户端的连接，并在有新信息时主动推送给客户端。 #### 消息 消息是指服务器主动推送至客户端的信息。这些信息可以是状态更新、警告通知或其他类型的实时数据。 ### 二、通讯步骤流程 1. **连接建立** - 客户端首先根据proxy配置中的`host_addr`和`host_port`参数来连接到SocketServer。 - 连接建立后，客户端处于等待接收消息的状态。 2. **保持连接** - 为了确保连接的稳定性，客户端会定期发送`TRACE`消息至服务器，作为连接维护的一种手段。 - 如果服务器未能响应`TRACE-OK`消息，客户端会在`retry_interval`设定的时间间隔内尝试重新连接。 - 若重连尝试超过`max_attempt_retry`设定的最大次数仍未成功，客户端将抛出自定义异常，表明连接已不可用。 3. **消息发送与处理** - 服务器端通过RPC调用消费Eventhandler消息或周期性查询数据库来获取最新信息。 - 获取到的信息会被格式化成特定的消息格式，然后发送给客户端。 - 在与客户端的连接中断时，服务器也会抛出异常，并将准备发送但未发送成功的数据进行丢弃，原因是这些数据可能已过时或对用户不再具有价值。 ### 三、消息格式 消息采用字符串形式，遵循JSON对象的结构，并以`#`作为结束标志。具体格式如下： ``` JSONOBJ# { 'type': 0|1, # 类型标识，0表示插件检查的返回结果，1表示事件处理器返回的警告信息。 'data': # 数据字段，根据类型不同，包含的信息也不同： # 如果type为0，则包含原始/status/API返回的数据； # 如果type为1，则包含单一服务的状态信息。 } ``` #### 示例 - TRACE消息格式：`TRACE#` - TRACE-OK响应消息格式：`TRACE-OK#` ### 四、参考信息 1. **TRACE消息**：用于客户端维护与服务器的连接状态。 2. **数据类型说明**：具体数据内容取决于消息类型，需参照《creeper监控API说明》中关于状态数据的章节。 3. **特定数据格式**：当`data`字段中包含指定`host_id`和`service_id`时，其返回的数据格式需特别注意。 4. **数据丢弃理由**： - 状态历史信息已在数据库中存储，无需重复传输。 - 来源于事件处理器的历史信息可能导致用户界面中不必要的连续弹窗，影响用户体验。 - 当前状态和事件信息才是最有价值的，应当优先处理和展示。 Socket通讯协议不仅定义了客户端和服务端之间通信的基本规则，还详细规范了消息的格式和处理流程，确保了信息的有效传递和系统的稳定运行。