org.springframework.web.socket.sockjs.client

## Class WebSocketTransport

- java.lang.Object
- - org.springframework.web.socket.sockjs.client.WebSocketTransport

- All Implemented Interfaces:
    Lifecycle, Transport

      public class WebSocketTransport
      extends Object
      implements Transport, Lifecycle

  A SockJS `Transport` that uses a `WebSocketClient`.
  Since:
    4.1
  Author:
    Rossen Stoyanchev

- - ### Constructor Summary

    Constructors
    Constructor and Description
    `WebSocketTransport(WebSocketClient webSocketClient)`

  - ### Method Summary

    All Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `ListenableFuture<WebSocketSession>` | `connect(TransportRequest request, WebSocketHandler handler)` Connect the transport.
    `List<TransportType>` | `getTransportTypes()` Return the SockJS transport types that this transport can be used for.
    `WebSocketClient` | `getWebSocketClient()` Return the configured `WebSocketClient`.
    `boolean` | `isRunning()` Check whether this component is currently running.
    `void` | `start()` Start this component.
    `void` | `stop()` Stop this component, typically in a synchronous fashion, such that the component is fully stopped upon return of this method.
    `String` | `toString()`

    - ### Methods inherited from class java.lang.Object

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

- - ### Constructor Detail

    - #### WebSocketTransport

          public WebSocketTransport(WebSocketClient webSocketClient)

  - ### Method Detail

    - #### getWebSocketClient

          public WebSocketClient getWebSocketClient()

      Return the configured `WebSocketClient`.

    - #### getTransportTypes

          public List<TransportType> getTransportTypes()

      Description copied from interface: `Transport`
      Return the SockJS transport types that this transport can be used for. In particular since from a client perspective there is no difference between XHR and XHR streaming, an `XhrTransport` could do both.
      Specified by:
        `getTransportTypes` in interface `Transport`

    - #### connect

          public ListenableFuture<WebSocketSession> connect(TransportRequest request,
                                                            WebSocketHandler handler)

      Description copied from interface: `Transport`
      Connect the transport.
      Specified by:
        `connect` in interface `Transport`
      Parameters:
        `request` - the transport request.
        `handler` - the application handler to delegate lifecycle events to.
      Returns:
        a future to indicate success or failure to connect.

    - #### start

          public void start()

      Description copied from interface: `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.

      Specified by:
        `start` in interface `Lifecycle`
      See Also:
        `SmartLifecycle.isAutoStartup()`

    - #### stop

          public void stop()

      Description copied from interface: `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.

      Specified by:
        `stop` in interface `Lifecycle`
      See Also:
        `SmartLifecycle.stop(Runnable)`, `DisposableBean.destroy()`

    - #### isRunning

          public boolean isRunning()

      Description copied from interface: `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.

      Specified by:
        `isRunning` in interface `Lifecycle`
      Returns:
        whether the component is currently running

    - #### toString

          public String toString()

      Overrides:
        `toString` in class `Object`