类 JettyWebSocketClient

构造器详细资料

• JettyWebSocketClient

  public JettyWebSocketClient()

  Default constructor that creates an instance of WebSocketClient.

• JettyWebSocketClient

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

  Constructor that accepts an existing WebSocketClient instance.

方法详细资料

• setTaskExecutor

  public void setTaskExecutor​(AsyncListenableTaskExecutor taskExecutor)

  Set an AsyncListenableTaskExecutor to use when opening connections. If this property is set to null, calls to any of the doHandshake methods will block until the connection is established.

  By default an instance of SimpleAsyncTaskExecutor is used.

• getTaskExecutor

  public AsyncListenableTaskExecutor getTaskExecutor()

  Return the configured TaskExecutor.

• 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

• doHandshake

  public ListenableFuture<WebSocketSession> doHandshake​(WebSocketHandler webSocketHandler,
                                                        String uriTemplate,
                                                        Object... uriVars)

  指定者:

  doHandshake 在接口中 WebSocketClient

  覆盖:

  doHandshake 在类中 AbstractWebSocketClient

• doHandshakeInternal

  public ListenableFuture<WebSocketSession> doHandshakeInternal​(WebSocketHandler wsHandler,
                                                                HttpHeaders headers,
                                                                URI uri,
                                                                List<String> protocols,
                                                                List<WebSocketExtension> extensions,
                                                                Map<String,​Object> attributes)

  从类复制的说明: AbstractWebSocketClient
  Perform the actual handshake to establish a connection to the server.

  指定者:

  doHandshakeInternal 在类中 AbstractWebSocketClient

  参数:

  wsHandler - the client-side handler for WebSocket messages

  headers - HTTP headers to use for the handshake, with unwanted (forbidden) headers filtered out, never null

  uri - the target URI for the handshake, never null

  protocols - requested sub-protocols, or an empty list

  extensions - requested WebSocket extensions, or an empty list

  attributes - attributes to associate with the WebSocketSession, i.e. via WebSocketSession.getAttributes(); currently always an empty map.

  返回:

  the established WebSocket session wrapped in a ListenableFuture.

• getUser

  protected Principal getUser()

  返回:

  the user to make available through WebSocketSession.getPrincipal(); by default this method returns null