类 JettyWebSocketClient

构造器详细资料

• JettyWebSocketClient

  public JettyWebSocketClient()

  Default constructor that creates and manages an instance of a Jetty WebSocketClient. The instance can be obtained with getJettyClient() for further configuration.

  Note: When this constructor is used Lifecycle methods of this class are delegated to the Jetty WebSocketClient.

• JettyWebSocketClient

  public JettyWebSocketClient​(org.eclipse.jetty.websocket.client.WebSocketClient jettyClient)

  Constructor that accepts an existing instance of a Jetty WebSocketClient.

  Note: Use of this constructor implies the Jetty WebSocketClient is externally managed and hence Lifecycle methods of this class are not delegated to it.

方法详细资料

• getJettyClient

  public org.eclipse.jetty.websocket.client.WebSocketClient getJettyClient()

  Return the underlying Jetty WebSocketClient.

• 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

• execute

  public reactor.core.publisher.Mono<Void> execute​(URI url,
                                                   WebSocketHandler handler)

  从接口复制的说明: WebSocketClient
  Execute a handshake request to the given url and handle the resulting WebSocket session with the given handler.

  指定者:

  execute 在接口中 WebSocketClient

  参数:

  url - the handshake url

  handler - the handler of the WebSocket session

  返回:

  completion Mono<Void> to indicate the outcome of the WebSocket session handling.

• execute

  public reactor.core.publisher.Mono<Void> execute​(URI url,
                                                   HttpHeaders headers,
                                                   WebSocketHandler handler)

  从接口复制的说明: WebSocketClient
  A variant of WebSocketClient.execute(URI, WebSocketHandler) with custom headers.

  指定者:

  execute 在接口中 WebSocketClient

  参数:

  url - the handshake url

  headers - custom headers for the handshake request

  handler - the handler of the WebSocket session

  返回:

  completion Mono<Void> to indicate the outcome of the WebSocket session handling.