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, STOP_ON_FAILURE, STOPPED, STOPPING

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 HttpClient for defaults
WebSocketClient(HttpClient httpClient, DecoratedObjectFactory objectFactory) Instantiate a WebSocketClient using HttpClient for defaults
WebSocketClient(SslContextFactory sslContextFactory) Create a new WebSocketClient
WebSocketClient(SslContextFactory sslContextFactory, Executor executor) Deprecated. use WebSocketClient(HttpClient) instead
WebSocketClient(SslContextFactory sslContextFactory, Executor executor, ByteBufferPool bufferPool) Create WebSocketClient using sharing instances of SSLContextFactory Executor, and ByteBufferPool
WebSocketClient(WebSocketContainerScope scope) Create WebSocketClient other Container Scope, to allow sharing of internal features like Executor, ByteBufferPool, SSLContextFactory, etc.
WebSocketClient(WebSocketContainerScope scope, EventDriverFactory eventDriverFactory, SessionFactory sessionFactory) Create WebSocketClient based on pre-existing Container Scope, to allow sharing of internal features like Executor, ByteBufferPool, SSLContextFactory, etc.
WebSocketClient(WebSocketContainerScope scope, SslContextFactory sslContextFactory) Create WebSocketClient other Container Scope, to allow sharing of internal features like Executor, ByteBufferPool, SSLContextFactory, etc.

Method Summary

Modifier and Type	Method and Description
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
protected void	doStop()
void	dump(Appendable out, String indent)
long	getAsyncWriteTimeout() Return the number of milliseconds for a timeout of an attempted write operation.
SocketAddress	getBindAddress()
ByteBufferPool	getBufferPool()
ConnectionManager	getConnectionManager() Deprecated.
long	getConnectTimeout()
CookieStore	getCookieStore()
EventDriverFactory	getEventDriverFactory()
Executor	getExecutor()
ExtensionFactory	getExtensionFactory()
HttpClient	getHttpClient()
Masker	getMasker()
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()
Set<WebSocketSession>	getOpenSessions()
WebSocketPolicy	getPolicy()
Scheduler	getScheduler()
SessionFactory	getSessionFactory()
SslContextFactory	getSslContextFactory()
boolean	isDispatchIO() Deprecated.
protected ConnectionManager	newConnectionManager() Deprecated. use HttpClient instead
void	onSessionClosed(WebSocketSession session)
void	onSessionOpened(WebSocketSession session)
void	setAsyncWriteTimeout(long ms)
void	setBindAdddress(SocketAddress bindAddress) Deprecated. (this is a bad bad bad typo) use setBindAddress(SocketAddress) instead
void	setBindAddress(SocketAddress bindAddress)
void	setBufferPool(ByteBufferPool bufferPool)
void	setConnectTimeout(long ms) Set the timeout for connecting to the remote server.
void	setCookieStore(CookieStore cookieStore)
void	setDaemon(boolean daemon)
void	setDispatchIO(boolean dispatchIO) Deprecated.
void	setExecutor(Executor executor)
void	setMasker(Masker masker)
void	setMaxBinaryMessageBufferSize(int max)
void	setMaxIdleTimeout(long ms) Set the max idle timeout for new connections.
void	setMaxTextMessageBufferSize(int max)
String	toString()

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

addBean, addBean, addBean, addEventListener, addManaged, contains, destroy, doStart, dump, dump, dump, dump, dumpBeans, dumpObject, dumpStdErr, dumpThis, getBean, getBeans, getBeans, isManaged, manage, removeBean, removeBeans, removeEventListener, setBeans, setStopTimeout, start, stop, 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

clone, equals, finalize, getClass, hashCode, 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.LifeCycle

start, stop

Constructor Detail

WebSocketClient

public WebSocketClient()

Instantiate a WebSocketClient with defaults

WebSocketClient

public WebSocketClient(HttpClient httpClient)

Instantiate a WebSocketClient using HttpClient for defaults

Parameters:

httpClient - the HttpClient to base internal defaults off of

WebSocketClient

public WebSocketClient(HttpClient httpClient,
                       DecoratedObjectFactory objectFactory)

Instantiate a WebSocketClient using HttpClient for defaults

Parameters:

httpClient - the HttpClient to base internal defaults off of

objectFactory - the DecoratedObjectFactory for all client instantiated classes

WebSocketClient

@Deprecated
public WebSocketClient(Executor executor)

Deprecated. use WebSocketClient(HttpClient) instead

Create a new WebSocketClient

Parameters:

executor - the executor to use

WebSocketClient

@Deprecated
public WebSocketClient(ByteBufferPool bufferPool)

Deprecated. use WebSocketClient(HttpClient) instead

Create a new WebSocketClient

Parameters:

bufferPool - byte buffer pool to use

WebSocketClient

public WebSocketClient(SslContextFactory sslContextFactory)

Create a new WebSocketClient

Parameters:

sslContextFactory - ssl context factory to use

WebSocketClient

@Deprecated
public WebSocketClient(SslContextFactory sslContextFactory,
                                   Executor executor)

Deprecated. use WebSocketClient(HttpClient) instead

Create a new WebSocketClient

Parameters:

sslContextFactory - ssl context factory to use

executor - the executor to use

WebSocketClient

public WebSocketClient(WebSocketContainerScope scope)

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

Parameters:

scope - the Container Scope

WebSocketClient

public WebSocketClient(WebSocketContainerScope scope,
                       SslContextFactory sslContextFactory)

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

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

Create WebSocketClient using sharing instances of SSLContextFactory Executor, and ByteBufferPool

Parameters:

sslContextFactory - shared SSL ContextFactory

executor - shared Executor

bufferPool - shared ByteBufferPool

WebSocketClient

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

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

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

doStop

protected void doStop()
               throws Exception

Overrides:

doStop in class ContainerLifeCycle

Throws:

Exception

isDispatchIO

@Deprecated
public boolean isDispatchIO()

Deprecated.

getAsyncWriteTimeout

public long getAsyncWriteTimeout()

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()

Specified by:

getBufferPool in interface WebSocketContainerScope

getConnectionManager

@Deprecated
public ConnectionManager getConnectionManager()

Deprecated.

getConnectTimeout

public long getConnectTimeout()

getCookieStore

public CookieStore getCookieStore()

getEventDriverFactory

public EventDriverFactory getEventDriverFactory()

getExecutor

public Executor getExecutor()

Specified by:

getExecutor in interface WebSocketContainerScope

getExtensionFactory

public ExtensionFactory getExtensionFactory()

getMasker

public Masker getMasker()

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()

Specified by:

getObjectFactory in interface WebSocketContainerScope

getOpenSessions

public Set<WebSocketSession> getOpenSessions()

getPolicy

public WebSocketPolicy getPolicy()

Specified by:

getPolicy in interface WebSocketContainerScope

getScheduler

public Scheduler getScheduler()

getSessionFactory

public SessionFactory getSessionFactory()

getSslContextFactory

public SslContextFactory getSslContextFactory()

Specified by:

getSslContextFactory in interface WebSocketContainerScope

Returns:

the SslContextFactory that manages TLS encryption

See Also:

WebSocketClient(SslContextFactory)

newConnectionManager

@Deprecated
protected ConnectionManager newConnectionManager()

Deprecated. use HttpClient instead

Factory method for new ConnectionManager

Returns:

the ConnectionManager instance to use

onSessionClosed

public void onSessionClosed(WebSocketSession session)

Specified by:

onSessionClosed in interface WebSocketContainerScope

onSessionOpened

public void onSessionOpened(WebSocketSession session)

Specified by:

onSessionOpened in interface WebSocketContainerScope

setAsyncWriteTimeout

public void setAsyncWriteTimeout(long ms)

setBindAdddress

@Deprecated
public void setBindAdddress(SocketAddress bindAddress)

Deprecated. (this is a bad bad bad typo) use setBindAddress(SocketAddress) instead

Parameters:

bindAddress - the address to bind to

setBindAddress

public void setBindAddress(SocketAddress bindAddress)

setBufferPool

public void setBufferPool(ByteBufferPool bufferPool)

setConnectTimeout

public void setConnectTimeout(long ms)

Set the timeout for connecting to the remote server.

Parameters:

ms - the timeout in milliseconds

setCookieStore

public void setCookieStore(CookieStore cookieStore)

setDaemon

public void setDaemon(boolean daemon)

setDispatchIO

@Deprecated
public void setDispatchIO(boolean dispatchIO)

Deprecated.

setExecutor

public void setExecutor(Executor executor)

setMasker

public void setMasker(Masker masker)

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)

dump

public void dump(Appendable out,
                 String indent)
          throws IOException

Specified by:

dump in interface Dumpable

Overrides:

dump in class ContainerLifeCycle

Throws:

IOException

getHttpClient

public HttpClient getHttpClient()

toString

public String toString()

Overrides:

toString in class Object