类 SubProtocolWebSocketHandler

构造器详细资料

• SubProtocolWebSocketHandler

  public SubProtocolWebSocketHandler​(MessageChannel clientInboundChannel,
                                     SubscribableChannel clientOutboundChannel)

  Create a new SubProtocolWebSocketHandler for the given inbound and outbound channels.

  参数:

  clientInboundChannel - the inbound MessageChannel

  clientOutboundChannel - the outbound MessageChannel

方法详细资料

• setProtocolHandlers

  public void setProtocolHandlers​(List<SubProtocolHandler> protocolHandlers)

  Configure one or more handlers to use depending on the sub-protocol requested by the client in the WebSocket handshake request.

  参数:

  protocolHandlers - the sub-protocol handlers to use

• getProtocolHandlers

  public List<SubProtocolHandler> getProtocolHandlers()

• addProtocolHandler

  public void addProtocolHandler​(SubProtocolHandler handler)

  Register a sub-protocol handler.

• getProtocolHandlerMap

  public Map<String,​SubProtocolHandler> getProtocolHandlerMap()

  Return the sub-protocols keyed by protocol name.

• setDefaultProtocolHandler

  public void setDefaultProtocolHandler​(@Nullable
                                        SubProtocolHandler defaultProtocolHandler)

  Set the SubProtocolHandler to use when the client did not request a sub-protocol.

  参数:

  defaultProtocolHandler - the default handler

• getDefaultProtocolHandler

  @Nullable
  public SubProtocolHandler getDefaultProtocolHandler()

  Return the default sub-protocol handler to use.

• getSubProtocols

  public List<String> getSubProtocols()

  Return all supported protocols.

  指定者:

  getSubProtocols 在接口中 SubProtocolCapable

• setSendTimeLimit

  public void setSendTimeLimit​(int sendTimeLimit)

  Specify the send-time limit (milliseconds).

  另请参阅:

  ConcurrentWebSocketSessionDecorator

• getSendTimeLimit

  public int getSendTimeLimit()

  Return the send-time limit (milliseconds).

• setSendBufferSizeLimit

  public void setSendBufferSizeLimit​(int sendBufferSizeLimit)

  Specify the buffer-size limit (number of bytes).

  另请参阅:

  ConcurrentWebSocketSessionDecorator

• getSendBufferSizeLimit

  public int getSendBufferSizeLimit()

  Return the buffer-size limit (number of bytes).

• setTimeToFirstMessage

  public void setTimeToFirstMessage​(int timeToFirstMessage)

  Set the maximum time allowed in milliseconds after the WebSocket connection is established and before the first sub-protocol message is received.

  This handler is for WebSocket connections that use a sub-protocol. Therefore, we expect the client to send at least one sub-protocol message in the beginning, or else we assume the connection isn't doing well, e.g. proxy issue, slow network, and can be closed.

  By default this is set to 60,000 (1 minute).

  参数:

  timeToFirstMessage - the maximum time allowed in milliseconds

  从以下版本开始:

  5.1

  另请参阅:

  checkSessions()

• getTimeToFirstMessage

  public int getTimeToFirstMessage()

  Return the maximum time allowed after the WebSocket connection is established and before the first sub-protocol message.

  从以下版本开始:

  5.1

• getStatsInfo

  public String getStatsInfo()

  Return a String describing internal state and counters. Effectively toString() on getStats().

• getStats

  public SubProtocolWebSocketHandler.Stats getStats()

  Return a structured object with various session counters.

  从以下版本开始:

  5.2

• start

  public final void start()

  从接口复制的说明: Lifecycle
  Start this component.

  Should not throw an exception if the component is already running.

  In the case of a container, this will propagate the start signal to all components that apply.

  指定者:

  start 在接口中 Lifecycle

  另请参阅:

  SmartLifecycle.isAutoStartup()

• stop

  public final void stop()

  从接口复制的说明: Lifecycle
  Stop this component, typically in a synchronous fashion, such that the component is fully stopped upon return of this method. Consider implementing SmartLifecycle and its stop(Runnable) variant when asynchronous stop behavior is necessary.

  Note that this stop notification is not guaranteed to come before destruction: On regular shutdown, Lifecycle beans will first receive a stop notification before the general destruction callbacks are being propagated; however, on hot refresh during a context's lifetime or on aborted refresh attempts, a given bean's destroy method will be called without any consideration of stop signals upfront.

  Should not throw an exception if the component is not running (not started yet).

  In the case of a container, this will propagate the stop signal to all components that apply.

  指定者:

  stop 在接口中 Lifecycle

  另请参阅:

  SmartLifecycle.stop(Runnable), DisposableBean.destroy()

• stop

  public final void stop​(Runnable callback)

  从接口复制的说明: SmartLifecycle
  Indicates that a Lifecycle component must stop if it is currently running.

  The provided callback is used by the LifecycleProcessor to support an ordered, and potentially concurrent, shutdown of all components having a common shutdown order value. The callback must be executed after the SmartLifecycle component does indeed stop.

  The LifecycleProcessor will call only this variant of the stop method; i.e. Lifecycle.stop() will not be called for SmartLifecycle implementations unless explicitly delegated to within the implementation of this method.

  The default implementation delegates to Lifecycle.stop() and immediately triggers the given callback in the calling thread. Note that there is no synchronization between the two, so custom implementations may at least want to put the same steps within their common lifecycle monitor (if any).

  指定者:

  stop 在接口中 SmartLifecycle

  另请参阅:

  Lifecycle.stop(), SmartLifecycle.getPhase()

• isRunning

  public final boolean isRunning()

  从接口复制的说明: Lifecycle
  Check whether this component is currently running.

  In the case of a container, this will return true only if all components that apply are currently running.

  指定者:

  isRunning 在接口中 Lifecycle

  返回:

  whether the component is currently running

• afterConnectionEstablished

  public void afterConnectionEstablished​(WebSocketSession session)
                                  throws Exception

  从接口复制的说明: WebSocketHandler
  Invoked after WebSocket negotiation has succeeded and the WebSocket connection is opened and ready for use.

  指定者:

  afterConnectionEstablished 在接口中 WebSocketHandler

  抛出:

  Exception - this method can handle or propagate exceptions; see class-level Javadoc for details.

• handleMessage

  public void handleMessage​(WebSocketSession session,
                            WebSocketMessage<?> message)
                     throws Exception

  Handle an inbound message from a WebSocket client.

  指定者:

  handleMessage 在接口中 WebSocketHandler

  抛出:

  Exception - this method can handle or propagate exceptions; see class-level Javadoc for details.

• handleMessage

  public void handleMessage​(Message<?> message)
                     throws MessagingException

  Handle an outbound Spring Message to a WebSocket client.

  指定者:

  handleMessage 在接口中 MessageHandler

  参数:

  message - the message to be handled

  抛出:

  MessagingException - if the handler failed to process the message

• handleTransportError

  public void handleTransportError​(WebSocketSession session,
                                   Throwable exception)
                            throws Exception

  从接口复制的说明: WebSocketHandler
  Handle an error from the underlying WebSocket message transport.

  指定者:

  handleTransportError 在接口中 WebSocketHandler

  抛出:

  Exception - this method can handle or propagate exceptions; see class-level Javadoc for details.

• afterConnectionClosed

  public void afterConnectionClosed​(WebSocketSession session,
                                    CloseStatus closeStatus)
                             throws Exception

  从接口复制的说明: WebSocketHandler
  Invoked after the WebSocket connection has been closed by either side, or after a transport error has occurred. Although the session may technically still be open, depending on the underlying implementation, sending messages at this point is discouraged and most likely will not succeed.

  指定者:

  afterConnectionClosed 在接口中 WebSocketHandler

  抛出:

  Exception - this method can handle or propagate exceptions; see class-level Javadoc for details.

• supportsPartialMessages

  public boolean supportsPartialMessages()

  从接口复制的说明: WebSocketHandler
  Whether the WebSocketHandler handles partial messages. If this flag is set to true and the underlying WebSocket server supports partial messages, then a large WebSocket message, or one of an unknown size may be split and maybe received over multiple calls to WebSocketHandler.handleMessage(WebSocketSession, WebSocketMessage). The flag WebSocketMessage.isLast() indicates if the message is partial and whether it is the last part.

  指定者:

  supportsPartialMessages 在接口中 WebSocketHandler

• decorateSession

  protected WebSocketSession decorateSession​(WebSocketSession session)

  Decorate the given WebSocketSession, if desired.

  The default implementation builds a ConcurrentWebSocketSessionDecorator with the configured send-time limit and buffer-size limit.

  参数:

  session - the original WebSocketSession

  返回:

  the decorated WebSocketSession, or potentially the given session as-is

  从以下版本开始:

  4.3.13

• findProtocolHandler

  protected final SubProtocolHandler findProtocolHandler​(WebSocketSession session)

  Find a SubProtocolHandler for the given session.

  参数:

  session - the WebSocketSession to find a handler for

• toString

  public String toString()

  覆盖:

  toString 在类中 Object