程序包 org.hy.microservice.common.webSocket

类 WebSocketServer

java.lang.Object
org.hy.microservice.common.webSocket.WebSocketServer
@Component public class WebSocketServer extends Object
WebSocket的服务端
版本:
v1.0 v2.0 2023-04-17 添加：用户编号 & 访问票据 v3.0 2023-08-25 添加：客户端首次初始化数据的事件监听器机制
作者:
ZhengWei(HY)

  • 构造器详细资料

    • WebSocketServer

      public WebSocketServer()

  • 方法详细资料

    • onOpen

      public void onOpen(javax.websocket.Session i_Session, String i_ServiceType, String i_UserID)
      连接建立成功调用的方法
      参数:
      i_Session - 可选的参数。session为与某个客户端的连接会话，需要通过它来给客户端发送数据
      i_ServiceType - 服务类型

    • onClose

      public void onClose(String i_ServiceType, String i_UserID, String i_Token)
      连接关闭调用的方法
      参数:
      i_ServiceType - 服务类型

    • onMessage

      public void onMessage(String i_Message)
      收到客户端消息后调用的方法
      参数:
      i_Message - 客户端发送过来的消息

    • onError

      public void onError(javax.websocket.Session i_Session, Throwable i_Error, String i_ServiceType, String i_UserID)
      发生错误时调用
      参数:
      i_Session - 会话
      i_Error - 异常
      i_ServiceType - 服务类型
      i_UserID - 用户编号

    • addInitEventListener

      public static boolean addInitEventListener(WebSocketMessage i_WebSocketMessage)
      添加初始化的事件监听器
      参数:
      i_WebSocketMessage - 消息对象
      返回:

    • removeInitEventListener

      public static void removeInitEventListener(WebSocketMessage i_WebSocketMessage)
      删除初始化的事件监听器
      参数:
      i_WebSocketMessage -

    • getClients

      public static Map<String,WebSocketClient> getClients(String i_ServiceType)
      获取某种服务类型的所有客户端
      参数:
      i_ServiceType - 服务类型
      返回:

    • pushMessages

      public static void pushMessages(String i_ServiceType, String i_NewMessage)
      向客户端群发消息。
      参数:
      i_ServiceType - 服务类型
      i_NewMessage - 仅有变化的消息

    • pushMessages

      public static void pushMessages(String i_ServiceType, String i_NewMessage, String i_AllMessage)
      向客户端群发消息。 首次接入的客户端，将发送全部消息，之后将只发有变化的消息
      参数:
      i_ServiceType - 服务类型
      i_NewMessage - 仅有变化的消息
      i_AllMessage - 全部消息

    • pushMessages

      public static void pushMessages(WebSocketMessage i_Message)
      向客户端群发消息。 首次接入的客户端，将发送全部消息，之后将只发有变化的消息
      参数:
      i_Message - 消息接口