Package com.github.theword.queqiao.tool.websocket

Class WsServer

java.lang.Object
org.java_websocket.WebSocketAdapter
org.java_websocket.AbstractWebSocket
org.java_websocket.server.WebSocketServer
com.github.theword.queqiao.tool.websocket.WsServer
All Implemented Interfaces:
Runnable, org.java_websocket.WebSocketListener
public class WsServer extends org.java_websocket.server.WebSocketServer

  • Nested Class Summary

    Nested classes/interfaces inherited from class org.java_websocket.server.WebSocketServer

    org.java_websocket.server.WebSocketServer.WebSocketWorker

  • Field Summary

    Fields inherited from class org.java_websocket.server.WebSocketServer

    decoders

  • Constructor Summary

    Constructors
    Constructor
    Description
    WsServer(InetSocketAddress address, org.slf4j.Logger logger, com.google.gson.Gson gson, String serverName, String accessToken, boolean enabled)
    构造函数

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    broadcast(String text)
    广播消息
    void
    onClose(org.java_websocket.WebSocket webSocket, int code, String reason, boolean remote)
    当客户端断开连接时执行
    void
    onError(org.java_websocket.WebSocket webSocket, Exception exception)
    当连接出现异常时执行
    void
    onMessage(org.java_websocket.WebSocket webSocket, String message)
    当接收到客户端的消息时执行
    void
    onOpen(org.java_websocket.WebSocket webSocket, org.java_websocket.handshake.ClientHandshake clientHandshake)
    当客户端连接时执行 连接将依次检验 x-self-name；x-client-origin；Authorization字段
    void
    onStart()
    当服务器启动时执行

    Methods inherited from class org.java_websocket.server.WebSocketServer

    addConnection, allocateBuffers, broadcast, broadcast, broadcast, broadcast, broadcast, createBuffer, getAddress, getConnections, getDraft, getLocalSocketAddress, getMaxPendingConnections, getPort, getRemoteSocketAddress, getWebSocketFactory, onCloseInitiated, onClosing, onConnect, onMessage, onWebsocketClose, onWebsocketCloseInitiated, onWebsocketClosing, onWebsocketError, onWebsocketMessage, onWebsocketMessage, onWebsocketOpen, onWriteDemand, queue, releaseBuffers, removeConnection, run, setMaxPendingConnections, setWebSocketFactory, start, stop, stop, stop

    Methods inherited from class org.java_websocket.AbstractWebSocket

    getConnectionLostTimeout, isReuseAddr, isTcpNoDelay, setConnectionLostTimeout, setReuseAddr, setTcpNoDelay, startConnectionLostTimer, stopConnectionLostTimer

    Methods inherited from class org.java_websocket.WebSocketAdapter

    onPreparePing, onWebsocketHandshakeReceivedAsClient, onWebsocketHandshakeReceivedAsServer, onWebsocketHandshakeSentAsClient, onWebsocketPing, onWebsocketPong

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • WsServer

      public WsServer(InetSocketAddress address, org.slf4j.Logger logger, com.google.gson.Gson gson, String serverName, String accessToken, boolean enabled)
      构造函数
      Parameters:
      address - 地址
      logger - 日志实现
      serverName - 服务器名称
      accessToken - 访问令牌 (可选) 如果不需要访问令牌则传入空字符串

  • Method Details

    • onOpen

      public void onOpen(org.java_websocket.WebSocket webSocket, org.java_websocket.handshake.ClientHandshake clientHandshake)
      当客户端连接时执行 连接将依次检验 x-self-name；x-client-origin；Authorization字段
      Specified by:
      onOpen in class org.java_websocket.server.WebSocketServer
      Parameters:
      webSocket - 客户端
      clientHandshake - 客户端握手信息

    • onClose

      public void onClose(org.java_websocket.WebSocket webSocket, int code, String reason, boolean remote)
      当客户端断开连接时执行
      Specified by:
      onClose in class org.java_websocket.server.WebSocketServer
      Parameters:
      webSocket - 客户端
      code - 关闭码
      reason - 关闭原因
      remote - 是否是远程关闭

    • onMessage

      public void onMessage(org.java_websocket.WebSocket webSocket, String message)
      当接收到客户端的消息时执行
      Specified by:
      onMessage in class org.java_websocket.server.WebSocketServer
      Parameters:
      webSocket - 客户端
      message - 消息

    • onError

      public void onError(org.java_websocket.WebSocket webSocket, Exception exception)
      当连接出现异常时执行
      Specified by:
      onError in class org.java_websocket.server.WebSocketServer
      Parameters:
      webSocket - 客户端
      exception - 异常

    • onStart

      public void onStart()
      当服务器启动时执行
      Specified by:
      onStart in class org.java_websocket.server.WebSocketServer

    • broadcast

      public void broadcast(String text)
      广播消息
      Overrides:
      broadcast in class org.java_websocket.server.WebSocketServer
      Parameters:
      text - 消息