Package org.eclipse.jetty.websocket.common.scopes

Interface WebSocketContainerScope

All Known Implementing Classes:

ClientContainer, DelegatedContainerScope, ServerContainer, SimpleContainerScope, WebSocketClient, WebSocketServerFactory

public interface WebSocketContainerScope

Defined Scope for a WebSocketContainer.

Method Summary

Modifier and Type	Method	Description
void	addSessionListener(WebSocketSessionListener listener)
org.eclipse.jetty.io.ByteBufferPool	getBufferPool()	The configured Container Buffer Pool.
java.util.concurrent.Executor	getExecutor()	Executor in use by the container.
org.eclipse.jetty.util.DecoratedObjectFactory	getObjectFactory()	Object Factory used to create objects.
WebSocketPolicy	getPolicy()	The policy the container is running on.
java.util.Collection<WebSocketSessionListener>	getSessionListeners()
org.eclipse.jetty.util.ssl.SslContextFactory	getSslContextFactory()	The SslContextFactory in use by the container.
boolean	isRunning()	Test for if the container has been started.
void	removeSessionListener(WebSocketSessionListener listener)

Method Detail

getBufferPool

org.eclipse.jetty.io.ByteBufferPool getBufferPool()

The configured Container Buffer Pool.

Returns:

the buffer pool (never null)

getExecutor

java.util.concurrent.Executor getExecutor()

Executor in use by the container.

Returns:

the Executor in use by the container.

getObjectFactory

org.eclipse.jetty.util.DecoratedObjectFactory getObjectFactory()

Object Factory used to create objects.

Returns:

Object Factory used to create instances of objects.

getPolicy

WebSocketPolicy getPolicy()

The policy the container is running on.

Returns:

the websocket policy

getSslContextFactory

org.eclipse.jetty.util.ssl.SslContextFactory getSslContextFactory()

The SslContextFactory in use by the container.

Returns:

the SslContextFactory in use by the container (can be null if no SSL context is defined)

isRunning

boolean isRunning()

Test for if the container has been started.

Returns:

true if container is started and running

addSessionListener

void addSessionListener(WebSocketSessionListener listener)

removeSessionListener

void removeSessionListener(WebSocketSessionListener listener)

getSessionListeners

java.util.Collection<WebSocketSessionListener> getSessionListeners()