org.eclipse.jetty.websocket.client.internal

Class DefaultWebSocketClient

java.lang.Object

org.eclipse.jetty.util.FutureCallback<UpgradeResponse>

org.eclipse.jetty.websocket.client.internal.DefaultWebSocketClient

All Implemented Interfaces:

Future<UpgradeResponse>, Callback<UpgradeResponse>, WebSocketClient

public class DefaultWebSocketClient
extends FutureCallback<UpgradeResponse>
implements WebSocketClient

WebSocketClient for working with Upgrade (request and response), and establishing connections to the websocket URI of your choice.

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.jetty.util.Callback

Callback.Empty<C>

Constructor Summary

Constructors

Constructor and Description
DefaultWebSocketClient(WebSocketClientFactory factory, EventDriver websocket)

Method Summary

Methods

Modifier and Type	Method and Description
void	completed(UpgradeResponse context) Callback invoked when the operation completes.
FutureCallback<UpgradeResponse>	connect(URI websocketUri)
void	failed(UpgradeResponse context, Throwable cause) Callback invoked when the operation fails.
protected ClientUpgradeRequest	getClientUpgradeRequest()
WebSocketConnection	getConnection()
WebSocketClientFactory	getFactory()
Masker	getMasker()
WebSocketPolicy	getPolicy()
UpgradeRequest	getUpgradeRequest()
UpgradeResponse	getUpgradeResponse()
EventDriver	getWebSocket()
URI	getWebSocketUri()
void	setMasker(Masker masker)
void	setUpgradeResponse(ClientUpgradeResponse response)

Methods inherited from class org.eclipse.jetty.util.FutureCallback

cancel, get, get, isCancelled, isDone, rethrow, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultWebSocketClient

public DefaultWebSocketClient(WebSocketClientFactory factory,
                      EventDriver websocket)

Method Detail

completed

public void completed(UpgradeResponse context)

Description copied from interface: Callback

Callback invoked when the operation completes.

Specified by:

completed in interface Callback<UpgradeResponse>

Overrides:

completed in class FutureCallback<UpgradeResponse>

Parameters:

context - the context

See Also:

Callback.failed(Object, Throwable)

connect

public FutureCallback<UpgradeResponse> connect(URI websocketUri)
                                        throws IOException

Specified by:

connect in interface WebSocketClient

Throws:

IOException

failed

public void failed(UpgradeResponse context,
          Throwable cause)

Description copied from interface: Callback

Callback invoked when the operation fails.

Specified by:

failed in interface Callback<UpgradeResponse>

Overrides:

failed in class FutureCallback<UpgradeResponse>

Parameters:

context - the context

cause - the reason for the operation failure

getClientUpgradeRequest

protected ClientUpgradeRequest getClientUpgradeRequest()

getConnection

public WebSocketConnection getConnection()

Specified by:

getConnection in interface WebSocketClient

getFactory

public WebSocketClientFactory getFactory()

Specified by:

getFactory in interface WebSocketClient

getMasker

public Masker getMasker()

Specified by:

getMasker in interface WebSocketClient

getPolicy

public WebSocketPolicy getPolicy()

Specified by:

getPolicy in interface WebSocketClient

getUpgradeRequest

public UpgradeRequest getUpgradeRequest()

Specified by:

getUpgradeRequest in interface WebSocketClient

getUpgradeResponse

public UpgradeResponse getUpgradeResponse()

Specified by:

getUpgradeResponse in interface WebSocketClient

getWebSocket

public EventDriver getWebSocket()

Specified by:

getWebSocket in interface WebSocketClient

getWebSocketUri

public URI getWebSocketUri()

Specified by:

getWebSocketUri in interface WebSocketClient

setMasker

public void setMasker(Masker masker)

Specified by:

setMasker in interface WebSocketClient

setUpgradeResponse

public void setUpgradeResponse(ClientUpgradeResponse response)