org.eclipse.jetty.websocket.client

Class WebSocketClient

java.lang.Object

org.eclipse.jetty.util.component.AbstractLifeCycle

org.eclipse.jetty.util.component.ContainerLifeCycle

org.eclipse.jetty.websocket.client.WebSocketClient

All Implemented Interfaces:

Container, Destroyable, Dumpable, LifeCycle, WebSocketContainerScope

public class WebSocketClient
extends ContainerLifeCycle
implements WebSocketContainerScope

WebSocketClient provides a means of establishing connections to remote websocket endpoints.

Nested Class Summary

Nested classes/interfaces inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

AbstractLifeCycle.AbstractLifeCycleListener

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

Container.InheritedListener, Container.Listener

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

LifeCycle.Listener

Field Summary

Fields inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

FAILED, RUNNING, STARTED, STARTING, STOPPED, STOPPING

Fields inherited from interface org.eclipse.jetty.util.component.Dumpable

KEY

Constructor Summary

Constructors

Constructor and Description
WebSocketClient() Instantiate a WebSocketClient with defaults.
WebSocketClient(ByteBufferPool bufferPool) Deprecated. use WebSocketClient(HttpClient) instead
WebSocketClient(Executor executor) Deprecated. use WebSocketClient(HttpClient) instead
WebSocketClient(HttpClient httpClient) Instantiate a WebSocketClient using provided HttpClient.
WebSocketClient(HttpClient httpClient, DecoratedObjectFactory decoratedObjectFactory) Instantiate a WebSocketClient using HttpClient for defaults
WebSocketClient(SslContextFactory sslContextFactory) Deprecated. use WebSocketClient(HttpClient) instead
WebSocketClient(SslContextFactory sslContextFactory, Executor executor) Deprecated. use WebSocketClient(HttpClient) instead
WebSocketClient(SslContextFactory sslContextFactory, Executor executor, ByteBufferPool bufferPool) Deprecated. use WebSocketClient(HttpClient) instead
WebSocketClient(WebSocketContainerScope scope) Deprecated. use WebSocketClient(HttpClient) instead
WebSocketClient(WebSocketContainerScope scope, EventDriverFactory eventDriverFactory, SessionFactory sessionFactory) Deprecated. use WebSocketClient(WebSocketContainerScope, EventDriverFactory, SessionFactory, HttpClient) instead
WebSocketClient(WebSocketContainerScope scope, EventDriverFactory eventDriverFactory, SessionFactory sessionFactory, HttpClient httpClient) Create WebSocketClient based on pre-existing Container Scope, to allow sharing of internal features like Executor, ByteBufferPool, SSLContextFactory, etc.
WebSocketClient(WebSocketContainerScope scope, SslContextFactory sslContextFactory) Deprecated. use WebSocketClient(HttpClient) instead

Method Summary

Modifier and Type	Method and Description
void	addSessionListener(WebSocketSessionListener listener)
Future<Session>	connect(Object websocket, URI toUri)
Future<Session>	connect(Object websocket, URI toUri, ClientUpgradeRequest request) Connect to remote websocket endpoint
Future<Session>	connect(Object websocket, URI toUri, ClientUpgradeRequest request, UpgradeListener upgradeListener) Connect to remote websocket endpoint
boolean	equals(Object o)
long	getAsyncWriteTimeout() Deprecated.
SocketAddress	getBindAddress()
ByteBufferPool	getBufferPool() The configured Container Buffer Pool.
ConnectionManager	getConnectionManager() Deprecated.
long	getConnectTimeout()
CookieStore	getCookieStore()
EventDriverFactory	getEventDriverFactory()
Executor	getExecutor() Executor in use by the container.
ExtensionFactory	getExtensionFactory()
HttpClient	getHttpClient() Get the internal HttpClient.
Masker	getMasker() Deprecated. not used, no replacement
int	getMaxBinaryMessageBufferSize() Get the maximum size for buffering of a binary message.
long	getMaxBinaryMessageSize() Get the maximum size for a binary message.
long	getMaxIdleTimeout() Get the max idle timeout for new connections.
int	getMaxTextMessageBufferSize() Get the maximum size for buffering of a text message.
long	getMaxTextMessageSize() Get the maximum size for a text message.
DecoratedObjectFactory	getObjectFactory() Object Factory used to create objects.
Set<WebSocketSession>	getOpenSessions()
WebSocketPolicy	getPolicy() The policy the container is running on.
Scheduler	getScheduler()
SessionFactory	getSessionFactory()
Collection<WebSocketSessionListener>	getSessionListeners()
SslContextFactory	getSslContextFactory() Get the in use SslContextFactory
int	hashCode()
boolean	isDispatchIO() Deprecated.
boolean	isStopAtShutdown()
void	removeSessionListener(WebSocketSessionListener listener)
void	setAsyncWriteTimeout(long ms)
void	setBindAdddress(SocketAddress bindAddress) Deprecated. (this is a bad bad bad typo, it has 3 { @ code " d " } characters in a row) use HttpClient.setBindAddress(SocketAddress) to the internal WebSocketClient(HttpClient)
void	setBindAddress(SocketAddress bindAddress) Sets the Bind Address on the internal HttpClient.
void	setBufferPool(ByteBufferPool bufferPool) Set's the Bind Address on the internal HttpClient.
void	setConnectTimeout(long ms) Set the timeout for connecting to the remote server on the internal HttpClient
void	setCookieStore(CookieStore cookieStore) Set the CookieStore to use on the internal HttpClient
void	setDaemon(boolean daemon) Deprecated. not used, configure threading in HttpClient instead
void	setDispatchIO(boolean dispatchIO) Deprecated. no longer used, this has no replacement
void	setEventDriverFactory(EventDriverFactory eventDriverFactory)
void	setExecutor(Executor executor) Sets the Executor in use on the internal HttpClient
void	setMasker(Masker masker) Deprecated. not used, no replacement
void	setMaxBinaryMessageBufferSize(int max)
void	setMaxIdleTimeout(long ms) Set the max idle timeout for new connections.
void	setMaxTextMessageBufferSize(int max)
void	setSessionFactory(SessionFactory sessionFactory)
void	setStopAtShutdown(boolean stop) Set JVM shutdown behavior.
String	toString()

Methods inherited from class org.eclipse.jetty.util.component.ContainerLifeCycle

addBean, addBean, addEventListener, addManaged, contains, destroy, dump, dump, dump, dump, dump, dumpObject, dumpStdErr, getBean, getBeans, getBeans, getContainedBeans, isAuto, isManaged, isUnmanaged, manage, removeBean, removeBeans, removeEventListener, setBeans, setStopTimeout, unmanage, updateBean, updateBean, updateBeans

Methods inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

addLifeCycleListener, getState, getState, getStopTimeout, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, removeLifeCycleListener, start, stop

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.eclipse.jetty.websocket.common.scopes.WebSocketContainerScope

isRunning

Methods inherited from interface org.eclipse.jetty.util.component.Dumpable

dumpContainer, dumpIterable, dumpMapEntries, dumpObjects, dumpSelf, named

Methods inherited from interface org.eclipse.jetty.util.component.LifeCycle

start, stop

Constructor Detail

WebSocketClient

public WebSocketClient()

Instantiate a WebSocketClient with defaults.

WebSocketClient

public WebSocketClient(HttpClient httpClient)

Instantiate a WebSocketClient using provided HttpClient.

Parameters:

httpClient - the HttpClient to use for WebSocketClient.

WebSocketClient

public WebSocketClient(HttpClient httpClient,
                       DecoratedObjectFactory decoratedObjectFactory)

Instantiate a WebSocketClient using HttpClient for defaults

Parameters:

httpClient - the HttpClient that underlying WebSocket client uses

decoratedObjectFactory - the DecoratedObjectFactory for all client instantiated classes

WebSocketClient

@Deprecated
public WebSocketClient(SslContextFactory sslContextFactory)

Deprecated. use WebSocketClient(HttpClient) instead

Create a new WebSocketClient

Parameters:

sslContextFactory - ssl context factory to use on the internal HttpClient

WebSocketClient

@Deprecated
public WebSocketClient(Executor executor)

Deprecated. use WebSocketClient(HttpClient) instead

Create a new WebSocketClient

Parameters:

executor - the executor to use on the internal HttpClient

WebSocketClient

@Deprecated
public WebSocketClient(ByteBufferPool bufferPool)

Deprecated. use WebSocketClient(HttpClient) instead

Create a new WebSocketClient

Parameters:

bufferPool - byte buffer pool to use on the internal HttpClient

WebSocketClient

@Deprecated
public WebSocketClient(SslContextFactory sslContextFactory,
                                   Executor executor)

Deprecated. use WebSocketClient(HttpClient) instead

Create a new WebSocketClient

Parameters:

sslContextFactory - ssl context factory to use on the internal HttpClient

executor - the executor to use on the internal HttpClient

WebSocketClient

@Deprecated
public WebSocketClient(WebSocketContainerScope scope)

Deprecated. use WebSocketClient(HttpClient) instead

Create WebSocketClient other Container Scope, to allow sharing of internal features like Executor, ByteBufferPool, SSLContextFactory, etc.

Parameters:

scope - the Container Scope

WebSocketClient

@Deprecated
public WebSocketClient(WebSocketContainerScope scope,
                                   SslContextFactory sslContextFactory)

Deprecated. use WebSocketClient(HttpClient) instead

Create WebSocketClient other Container Scope, to allow sharing of internal features like Executor, ByteBufferPool, SSLContextFactory, etc.

Parameters:

scope - the Container Scope

sslContextFactory - SSL ContextFactory to use in preference to one from WebSocketContainerScope.getSslContextFactory()

WebSocketClient

@Deprecated
public WebSocketClient(SslContextFactory sslContextFactory,
                                   Executor executor,
                                   ByteBufferPool bufferPool)

Deprecated. use WebSocketClient(HttpClient) instead

Create WebSocketClient using sharing instances of SSLContextFactory Executor, and ByteBufferPool

Parameters:

sslContextFactory - shared SSL ContextFactory

executor - shared Executor

bufferPool - shared ByteBufferPool

WebSocketClient

@Deprecated
public WebSocketClient(WebSocketContainerScope scope,
                                   EventDriverFactory eventDriverFactory,
                                   SessionFactory sessionFactory)

Deprecated. use WebSocketClient(WebSocketContainerScope, EventDriverFactory, SessionFactory, HttpClient) instead

Create WebSocketClient based on pre-existing Container Scope, to allow sharing of internal features like Executor, ByteBufferPool, SSLContextFactory, etc.

Parameters:

scope - the Container Scope

eventDriverFactory - the EventDriver Factory to use

sessionFactory - the SessionFactory to use

WebSocketClient

public WebSocketClient(WebSocketContainerScope scope,
                       EventDriverFactory eventDriverFactory,
                       SessionFactory sessionFactory,
                       HttpClient httpClient)

Create WebSocketClient based on pre-existing Container Scope, to allow sharing of internal features like Executor, ByteBufferPool, SSLContextFactory, etc.

Parameters:

scope - the Container Scope

eventDriverFactory - the EventDriver Factory to use

sessionFactory - the SessionFactory to use

httpClient - the httpClient to use

Method Detail

connect

public Future<Session> connect(Object websocket,
                               URI toUri)
                        throws IOException

Throws:

IOException

connect

public Future<Session> connect(Object websocket,
                               URI toUri,
                               ClientUpgradeRequest request)
                        throws IOException

Connect to remote websocket endpoint

Parameters:

websocket - the websocket object

toUri - the websocket uri to connect to

request - the upgrade request information

Returns:

the future for the session, available on success of connect

Throws:

IOException - if unable to connect

connect

public Future<Session> connect(Object websocket,
                               URI toUri,
                               ClientUpgradeRequest request,
                               UpgradeListener upgradeListener)
                        throws IOException

Connect to remote websocket endpoint

Parameters:

websocket - the websocket object

toUri - the websocket uri to connect to

request - the upgrade request information

upgradeListener - the upgrade listener

Returns:

the future for the session, available on success of connect

Throws:

IOException - if unable to connect

setEventDriverFactory

public void setEventDriverFactory(EventDriverFactory eventDriverFactory)

setSessionFactory

public void setSessionFactory(SessionFactory sessionFactory)

isDispatchIO

@Deprecated
public boolean isDispatchIO()

Deprecated.

getAsyncWriteTimeout

@Deprecated
public long getAsyncWriteTimeout()

Deprecated.

Return the number of milliseconds for a timeout of an attempted write operation.

Returns:

number of milliseconds for timeout of an attempted write operation

getBindAddress

public SocketAddress getBindAddress()

getBufferPool

public ByteBufferPool getBufferPool()

Description copied from interface: WebSocketContainerScope

The configured Container Buffer Pool.

Specified by:

getBufferPool in interface WebSocketContainerScope

Returns:

the buffer pool (never null)

getConnectionManager

@Deprecated
public ConnectionManager getConnectionManager()

Deprecated.

getConnectTimeout

public long getConnectTimeout()

getCookieStore

public CookieStore getCookieStore()

getEventDriverFactory

public EventDriverFactory getEventDriverFactory()

getExecutor

public Executor getExecutor()

Description copied from interface: WebSocketContainerScope

Executor in use by the container.

Specified by:

getExecutor in interface WebSocketContainerScope

Returns:

the Executor in use by the container.

getExtensionFactory

public ExtensionFactory getExtensionFactory()

getMasker

@Deprecated
public Masker getMasker()

Deprecated. not used, no replacement

Returns:

a RandomMasker instance

getMaxBinaryMessageBufferSize

public int getMaxBinaryMessageBufferSize()

Get the maximum size for buffering of a binary message.

Returns:

the maximum size of a binary message buffer.

getMaxBinaryMessageSize

public long getMaxBinaryMessageSize()

Get the maximum size for a binary message.

Returns:

the maximum size of a binary message.

getMaxIdleTimeout

public long getMaxIdleTimeout()

Get the max idle timeout for new connections.

Returns:

the max idle timeout in milliseconds for new connections.

getMaxTextMessageBufferSize

public int getMaxTextMessageBufferSize()

Get the maximum size for buffering of a text message.

Returns:

the maximum size of a text message buffer.

getMaxTextMessageSize

public long getMaxTextMessageSize()

Get the maximum size for a text message.

Returns:

the maximum size of a text message.

getObjectFactory

public DecoratedObjectFactory getObjectFactory()

Description copied from interface: WebSocketContainerScope

Object Factory used to create objects.

Specified by:

getObjectFactory in interface WebSocketContainerScope

Returns:

Object Factory used to create instances of objects.

getOpenSessions

public Set<WebSocketSession> getOpenSessions()

getPolicy

public WebSocketPolicy getPolicy()

Description copied from interface: WebSocketContainerScope

The policy the container is running on.

Specified by:

getPolicy in interface WebSocketContainerScope

Returns:

the websocket policy

getScheduler

public Scheduler getScheduler()

getSessionFactory

public SessionFactory getSessionFactory()

getSslContextFactory

public SslContextFactory getSslContextFactory()

Get the in use SslContextFactory

Specified by:

getSslContextFactory in interface WebSocketContainerScope

Returns:

the SslContextFactory that manages TLS encryption on the internal HttpClient

See Also:

WebSocketClient(SslContextFactory)

addSessionListener

public void addSessionListener(WebSocketSessionListener listener)

Specified by:

addSessionListener in interface WebSocketContainerScope

removeSessionListener

public void removeSessionListener(WebSocketSessionListener listener)

Specified by:

removeSessionListener in interface WebSocketContainerScope

getSessionListeners

public Collection<WebSocketSessionListener> getSessionListeners()

Specified by:

getSessionListeners in interface WebSocketContainerScope

setAsyncWriteTimeout

public void setAsyncWriteTimeout(long ms)

setBindAdddress

@Deprecated
public void setBindAdddress(SocketAddress bindAddress)

Deprecated. (this is a bad bad bad typo, it has 3 { @ code " d " } characters in a row) use HttpClient.setBindAddress(SocketAddress) to the internal WebSocketClient(HttpClient)

Parameters:

bindAddress - the address to bind to the internal HttpClient

setBindAddress

public void setBindAddress(SocketAddress bindAddress)

Sets the Bind Address on the internal HttpClient.

Parameters:

bindAddress - the local bind address for the internal HttpClient

setBufferPool

public void setBufferPool(ByteBufferPool bufferPool)

Set's the Bind Address on the internal HttpClient.

Parameters:

bufferPool - The buffer pool

setConnectTimeout

public void setConnectTimeout(long ms)

Set the timeout for connecting to the remote server on the internal HttpClient

Parameters:

ms - the timeout in milliseconds

setCookieStore

public void setCookieStore(CookieStore cookieStore)

Set the CookieStore to use on the internal HttpClient

Parameters:

cookieStore - The cookie store

setDaemon

@Deprecated
public void setDaemon(boolean daemon)

Deprecated. not used, configure threading in HttpClient instead

Parameters:

daemon - do nothing

setDispatchIO

@Deprecated
public void setDispatchIO(boolean dispatchIO)

Deprecated. no longer used, this has no replacement

Parameters:

dispatchIO - true to have IO operations be dispatched to Executor

setExecutor

public void setExecutor(Executor executor)

Sets the Executor in use on the internal HttpClient

Parameters:

executor - The executor to use

setMasker

@Deprecated
public void setMasker(Masker masker)

Deprecated. not used, no replacement

Parameters:

masker - does nothing

setMaxBinaryMessageBufferSize

public void setMaxBinaryMessageBufferSize(int max)

setMaxIdleTimeout

public void setMaxIdleTimeout(long ms)

Set the max idle timeout for new connections.

Existing connections will not have their max idle timeout adjusted.

Parameters:

ms - the timeout in milliseconds

setMaxTextMessageBufferSize

public void setMaxTextMessageBufferSize(int max)

getHttpClient

public HttpClient getHttpClient()

Get the internal HttpClient.

Note: this can result in a LinkageError if used within a WebApp that runs on a server that also has HttpClient on the server classpath.

Returns:

the internal HttpClient

setStopAtShutdown

public void setStopAtShutdown(boolean stop)

Set JVM shutdown behavior.

Parameters:

stop - If true, this client instance will be explicitly stopped when the JVM is shutdown. Otherwise the application is responsible for maintaining the WebSocketClient lifecycle.

See Also:

Runtime.addShutdownHook(Thread), ShutdownThread

isStopAtShutdown

public boolean isStopAtShutdown()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class AbstractLifeCycle