类 WebSocketTransportHandler

构造器详细资料

• WebSocketTransportHandler

  public WebSocketTransportHandler​(HandshakeHandler handshakeHandler)

方法详细资料

• getTransportType

  public TransportType getTransportType()

  从接口复制的说明: TransportHandler
  Return the transport type supported by this handler.

  指定者:

  getTransportType 在接口中 TransportHandler

• getHandshakeHandler

  public HandshakeHandler getHandshakeHandler()

• setServletContext

  public void setServletContext​(ServletContext servletContext)

  从接口复制的说明: ServletContextAware
  Set the ServletContext that this object runs in.

  Invoked after population of normal bean properties but before an init callback like InitializingBean's afterPropertiesSet or a custom init-method. Invoked after ApplicationContextAware's setApplicationContext.

  指定者:

  setServletContext 在接口中 ServletContextAware

  参数:

  servletContext - ServletContext object to be used by this object

  另请参阅:

  InitializingBean.afterPropertiesSet(), ApplicationContextAware.setApplicationContext(org.springframework.context.ApplicationContext)

• start

  public 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 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()

• isRunning

  public 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

• checkSessionType

  public boolean checkSessionType​(SockJsSession session)

  从接口复制的说明: TransportHandler
  Check whether the type of the given session matches the transport type of this TransportHandler where session id and the transport type are extracted from the SockJS URL.

  指定者:

  checkSessionType 在接口中 TransportHandler

  返回:

  true if the session matches (and would therefore get accepted by TransportHandler.handleRequest(org.springframework.http.server.ServerHttpRequest, org.springframework.http.server.ServerHttpResponse, org.springframework.web.socket.WebSocketHandler, org.springframework.web.socket.sockjs.transport.SockJsSession)), or false otherwise

• createSession

  public AbstractSockJsSession createSession​(String id,
                                             WebSocketHandler handler,
                                             Map<String,​Object> attrs)

  从接口复制的说明: SockJsSessionFactory
  Create a new SockJS session.

  指定者:

  createSession 在接口中 SockJsSessionFactory

  参数:

  id - the ID of the session

  handler - the underlying WebSocketHandler

  attrs - handshake request specific attributes

  返回:

  a new session, never null

• handleRequest

  public void handleRequest​(ServerHttpRequest request,
                            ServerHttpResponse response,
                            WebSocketHandler wsHandler,
                            SockJsSession wsSession)
                     throws SockJsException

  从接口复制的说明: TransportHandler
  Handle the given request and delegate messages to the provided WebSocketHandler.

  指定者:

  handleRequest 在接口中 TransportHandler

  参数:

  request - the current request

  response - the current response

  wsHandler - the target WebSocketHandler (never null)

  wsSession - the SockJS session (never null)

  抛出:

  SockJsException - raised when request processing fails as explained in SockJsService

• doHandshake

  public boolean doHandshake​(ServerHttpRequest request,
                             ServerHttpResponse response,
                             WebSocketHandler handler,
                             Map<String,​Object> attributes)
                      throws HandshakeFailureException

  从接口复制的说明: HandshakeHandler
  Initiate the handshake.

  指定者:

  doHandshake 在接口中 HandshakeHandler

  参数:

  request - the current request

  response - the current response

  handler - the handler to process WebSocket messages; see PerConnectionWebSocketHandler for providing a handler with per-connection lifecycle.

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

  返回:

  whether the handshake negotiation was successful or not. In either case the response status, headers, and body will have been updated to reflect the result of the negotiation

  抛出:

  HandshakeFailureException - thrown when handshake processing failed to complete due to an internal, unrecoverable error, i.e. a server error as opposed to a failure to successfully negotiate the handshake.