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

public class WebSocketClient
extends ContainerLifeCycle

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

Method Summary

Methods

Modifier and Type	Method and Description
Future<Session>	connect(Object websocket, URI toUri)
Future<Session>	connect(Object websocket, URI toUri, ClientUpgradeRequest request)
protected void	doStart() Starts the managed lifecycle beans in the order they were added.
protected void	doStop() Stops the managed lifecycle beans in the reverse order they were added.
SocketAddress	getBindAddress()
ByteBufferPool	getBufferPool()
ConnectionManager	getConnectionManager()
long	getConnectTimeout()
CookieStore	getCookieStore()
Executor	getExecutor()
ExtensionFactory	getExtensionFactory()
Masker	getMasker()
long	getMaxIdleTimeout() Get the max idle timeout for new connections.
WebSocketPolicy	getPolicy()
Scheduler	getScheduler()
SslContextFactory	getSslContextFactory()
List<Extension>	initExtensions(List<ExtensionConfig> requested)
protected ConnectionManager	newConnectionManager() Factory method for new ConnectionManager (used by other projects like cometd)
void	setBindAdddress(SocketAddress bindAddress)
void	setBufferPool(ByteBufferPool bufferPool)
void	setConnectTimeout(long timeoutMilliseconds) Set the timeout for connecting to the remote server.
void	setCookieStore(CookieStore cookieStore)
void	setExecutor(Executor executor)
void	setMasker(Masker masker)
void	setMaxIdleTimeout(long milliseconds) Set the max idle timeout for new connections.

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

addBean, addBean, addBean, contains, destroy, dump, dump, dump, dump, dump, dumpBeans, dumpObject, dumpStdErr, dumpThis, getBean, getBeans, getBeans, isManaged, manage, removeBean, removeBeans, setBeans, setStopTimeout, start, unmanage, 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(SslContextFactory sslContextFactory)

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

doStart

protected void doStart()
                throws Exception

Description copied from class: ContainerLifeCycle

Starts the managed lifecycle beans in the order they were added.

Overrides:

doStart in class ContainerLifeCycle

Throws:

Exception

doStop

protected void doStop()
               throws Exception

Description copied from class: ContainerLifeCycle

Stops the managed lifecycle beans in the reverse order they were added.

Overrides:

doStop in class ContainerLifeCycle

Throws:

Exception

getBindAddress

public SocketAddress getBindAddress()

getBufferPool

public ByteBufferPool getBufferPool()

getConnectionManager

public ConnectionManager getConnectionManager()

getConnectTimeout

public long getConnectTimeout()

getCookieStore

public CookieStore getCookieStore()

getExecutor

public Executor getExecutor()

getExtensionFactory

public ExtensionFactory getExtensionFactory()

getMasker

public Masker getMasker()

getMaxIdleTimeout

public long getMaxIdleTimeout()

Get the max idle timeout for new connections.

Returns:

the max idle timeout in milliseconds for new connections.

getPolicy

public WebSocketPolicy getPolicy()

getScheduler

public Scheduler getScheduler()

getSslContextFactory

public SslContextFactory getSslContextFactory()

Returns:

the SslContextFactory that manages TLS encryption

See Also:

WebSocketClient(SslContextFactory)

initExtensions

public List<Extension> initExtensions(List<ExtensionConfig> requested)

newConnectionManager

protected ConnectionManager newConnectionManager()

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

Returns:

the ConnectionManager instance to use

setBindAdddress

public void setBindAdddress(SocketAddress bindAddress)

setBufferPool

public void setBufferPool(ByteBufferPool bufferPool)

setConnectTimeout

public void setConnectTimeout(long timeoutMilliseconds)

Set the timeout for connecting to the remote server.

Parameters:

timeoutMilliseconds - the timeout in milliseconds

setCookieStore

public void setCookieStore(CookieStore cookieStore)

setExecutor

public void setExecutor(Executor executor)

setMasker

public void setMasker(Masker masker)

setMaxIdleTimeout

public void setMaxIdleTimeout(long milliseconds)

Set the max idle timeout for new connections.

Existing connections will not have their max idle timeout adjusted.

Parameters:

milliseconds - the timeout in milliseconds