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, SessionListener

public class WebSocketClient
extends ContainerLifeCycle
implements SessionListener, 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

Constructor Summary

Constructors

Constructor and Description
WebSocketClient()
WebSocketClient(ByteBufferPool bufferPool)
WebSocketClient(Executor executor)
WebSocketClient(SslContextFactory sslContextFactory)
WebSocketClient(SslContextFactory sslContextFactory, Executor executor)
WebSocketClient(SslContextFactory sslContextFactory, Executor executor, ByteBufferPool bufferPool)
WebSocketClient(SslContextFactory sslContextFactory, Executor executor, ByteBufferPool bufferPool, DecoratedObjectFactory objectFactory)
WebSocketClient(WebSocketContainerScope scope)
WebSocketClient(WebSocketContainerScope scope, SslContextFactory sslContextFactory)

Method Summary

Modifier and Type	Method and Description
Future<Session>	connect(Object websocket, URI toUri)
Future<Session>	connect(Object websocket, URI toUri, ClientUpgradeRequest request)
Future<Session>	connect(Object websocket, URI toUri, ClientUpgradeRequest request, UpgradeListener upgradeListener)
protected void	doStart()
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()
long	getConnectTimeout()
CookieStore	getCookieStore()
EventDriverFactory	getEventDriverFactory()
Executor	getExecutor()
ExtensionFactory	getExtensionFactory()
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()
protected ConnectionManager	newConnectionManager() Factory method for new ConnectionManager (used by other projects like cometd)
void	onSessionClosed(WebSocketSession session)
void	onSessionOpened(WebSocketSession session)
void	setAsyncWriteTimeout(long ms)
void	setBindAdddress(SocketAddress bindAddress) Deprecated. 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)
void	setEventDriverFactory(EventDriverFactory factory)
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)
void	setSessionFactory(SessionFactory sessionFactory)

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

addBean, addBean, addBean, addEventListener, addManaged, contains, destroy, 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, toString, wait, wait, wait

Constructor Detail

WebSocketClient

public WebSocketClient()

WebSocketClient

public WebSocketClient(Executor executor)

WebSocketClient

public WebSocketClient(ByteBufferPool bufferPool)

WebSocketClient

public WebSocketClient(SslContextFactory sslContextFactory)

WebSocketClient

public WebSocketClient(SslContextFactory sslContextFactory,
                       Executor executor)

WebSocketClient

public WebSocketClient(WebSocketContainerScope scope)

WebSocketClient

public WebSocketClient(WebSocketContainerScope scope,
                       SslContextFactory sslContextFactory)

WebSocketClient

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

WebSocketClient

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

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

Throws:

IOException

connect

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

Throws:

IOException

doStart

protected void doStart()
                throws Exception

Overrides:

doStart in class ContainerLifeCycle

Throws:

Exception

doStop

protected void doStop()
               throws Exception

Overrides:

doStop in class ContainerLifeCycle

Throws:

Exception

isDispatchIO

public boolean isDispatchIO()

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

public ConnectionManager getConnectionManager()

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

protected ConnectionManager newConnectionManager()

Factory method for new ConnectionManager (used by other projects like cometd)

Returns:

the ConnectionManager instance to use

onSessionClosed

public void onSessionClosed(WebSocketSession session)

Specified by:

onSessionClosed in interface SessionListener

onSessionOpened

public void onSessionOpened(WebSocketSession session)

Specified by:

onSessionOpened in interface SessionListener

setAsyncWriteTimeout

public void setAsyncWriteTimeout(long ms)

setBindAdddress

@Deprecated
public void setBindAdddress(SocketAddress bindAddress)

Deprecated. 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

public void setDispatchIO(boolean dispatchIO)

setEventDriverFactory

public void setEventDriverFactory(EventDriverFactory factory)

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)

setSessionFactory

public void setSessionFactory(SessionFactory sessionFactory)

dump

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

Specified by:

dump in interface Dumpable

Overrides:

dump in class ContainerLifeCycle

Throws:

IOException