类 AbstractWebSocketSession<T>

字段详细资料

• logger

  protected static final Log logger

构造器详细资料

• AbstractWebSocketSession

  public AbstractWebSocketSession​(Map<String,​Object> attributes)

  Create a new instance and associate the given attributes with it.

  参数:

  attributes - attributes from the HTTP handshake to associate with the WebSocket session; the provided attributes are copied, the original map is not used.

方法详细资料

• getAttributes

  public Map<String,​Object> getAttributes()

  从接口复制的说明: WebSocketSession
  Return the map with attributes associated with the WebSocket session.

  On the server side the map can be populated initially through a HandshakeInterceptor. On the client side the map can be populated via WebSocketClient handshake methods.

  指定者:

  getAttributes 在接口中 WebSocketSession

  返回:

  a Map with the session attributes (never null)

• getNativeSession

  public T getNativeSession()

  从接口复制的说明: NativeWebSocketSession
  Return the underlying native WebSocketSession.

  指定者:

  getNativeSession 在接口中 NativeWebSocketSession

• getNativeSession

  public <R> R getNativeSession​(Class<R> requiredType)

  从接口复制的说明: NativeWebSocketSession
  Return the underlying native WebSocketSession, if available.

  指定者:

  getNativeSession 在接口中 NativeWebSocketSession

  参数:

  requiredType - the required type of the session

  返回:

  the native session of the required type, or null if not available

• initializeNativeSession

  public void initializeNativeSession​(T session)

• checkNativeSessionInitialized

  protected final void checkNativeSessionInitialized()

• sendMessage

  public final void sendMessage​(WebSocketMessage<?> message)
                         throws IOException

  从接口复制的说明: WebSocketSession
  Send a WebSocket message: either TextMessage or BinaryMessage.

  Note: The underlying standard WebSocket session (JSR-356) does not allow concurrent sending. Therefore sending must be synchronized. To ensure that, one option is to wrap the WebSocketSession with the ConcurrentWebSocketSessionDecorator.

  指定者:

  sendMessage 在接口中 WebSocketSession

  抛出:

  IOException

  另请参阅:

  ConcurrentWebSocketSessionDecorator

• sendTextMessage

  protected abstract void sendTextMessage​(TextMessage message)
                                   throws IOException

  抛出:

  IOException

• sendBinaryMessage

  protected abstract void sendBinaryMessage​(BinaryMessage message)
                                     throws IOException

  抛出:

  IOException

• sendPingMessage

  protected abstract void sendPingMessage​(PingMessage message)
                                   throws IOException

  抛出:

  IOException

• sendPongMessage

  protected abstract void sendPongMessage​(PongMessage message)
                                   throws IOException

  抛出:

  IOException

• close

  public final void close()
                   throws IOException

  从接口复制的说明: WebSocketSession
  Close the WebSocket connection with status 1000, i.e. equivalent to:

   session.close(CloseStatus.NORMAL);
   

  指定者:

  close 在接口中 AutoCloseable

  指定者:

  close 在接口中 Closeable

  指定者:

  close 在接口中 WebSocketSession

  抛出:

  IOException

• close

  public final void close​(CloseStatus status)
                   throws IOException

  从接口复制的说明: WebSocketSession
  Close the WebSocket connection with the given close status.

  指定者:

  close 在接口中 WebSocketSession

  抛出:

  IOException

• closeInternal

  protected abstract void closeInternal​(CloseStatus status)
                                 throws IOException

  抛出:

  IOException

• toString

  public String toString()

  覆盖:

  toString 在类中 Object