类 TransportHandlingSockJsService

构造器详细资料

• TransportHandlingSockJsService

  public TransportHandlingSockJsService​(TaskScheduler scheduler,
                                        TransportHandler... handlers)

  Create a TransportHandlingSockJsService with given handler types.

  参数:

  scheduler - a task scheduler for heart-beat messages and removing timed-out sessions; the provided TaskScheduler should be declared as a Spring bean to ensure it gets initialized at start-up and shuts down when the application stops

  handlers - one or more TransportHandler implementations to use

• TransportHandlingSockJsService

  public TransportHandlingSockJsService​(TaskScheduler scheduler,
                                        Collection<TransportHandler> handlers)

  Create a TransportHandlingSockJsService with given handler types.

  参数:

  scheduler - a task scheduler for heart-beat messages and removing timed-out sessions; the provided TaskScheduler should be declared as a Spring bean to ensure it gets initialized at start-up and shuts down when the application stops

  handlers - one or more TransportHandler implementations to use

方法详细资料

• getTransportHandlers

  public Map<TransportType,​TransportHandler> getTransportHandlers()

  Return the registered handlers per transport type.

• setMessageCodec

  public void setMessageCodec​(SockJsMessageCodec messageCodec)

  The codec to use for encoding and decoding SockJS messages.

• getMessageCodec

  public SockJsMessageCodec getMessageCodec()

  从接口复制的说明: SockJsServiceConfig
  The codec to use for encoding and decoding SockJS messages.

  指定者:

  getMessageCodec 在接口中 SockJsServiceConfig

• setHandshakeInterceptors

  public void setHandshakeInterceptors​(List<HandshakeInterceptor> interceptors)

  Configure one or more WebSocket handshake request interceptors.

• getHandshakeInterceptors

  public List<HandshakeInterceptor> getHandshakeInterceptors()

  Return the configured WebSocket handshake request interceptors.

• 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

• handleRawWebSocketRequest

  protected void handleRawWebSocketRequest​(ServerHttpRequest request,
                                           ServerHttpResponse response,
                                           WebSocketHandler handler)
                                    throws IOException

  从类复制的说明: AbstractSockJsService
  Handle request for raw WebSocket communication, i.e. without any SockJS message framing.

  指定者:

  handleRawWebSocketRequest 在类中 AbstractSockJsService

  抛出:

  IOException

• handleTransportRequest

  protected void handleTransportRequest​(ServerHttpRequest request,
                                        ServerHttpResponse response,
                                        WebSocketHandler handler,
                                        String sessionId,
                                        String transport)
                                 throws SockJsException

  从类复制的说明: AbstractSockJsService
  Handle a SockJS session URL (i.e. transport-specific request).

  指定者:

  handleTransportRequest 在类中 AbstractSockJsService

  抛出:

  SockJsException

• validateRequest

  protected boolean validateRequest​(String serverId,
                                    String sessionId,
                                    String transport)

  覆盖:

  validateRequest 在类中 AbstractSockJsService