Interface WebSocketContainerScope
-
- All Known Implementing Classes:
ClientContainer,DelegatedContainerScope,ServerContainer,SimpleContainerScope,WebSocketClient,WebSocketServerFactory
public interface WebSocketContainerScopeDefined Scope for a WebSocketContainer.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description voidaddSessionListener(WebSocketSessionListener listener)ByteBufferPoolgetBufferPool()The configured Container Buffer Pool.java.util.concurrent.ExecutorgetExecutor()Executor in use by the container.DecoratedObjectFactorygetObjectFactory()Object Factory used to create objects.WebSocketPolicygetPolicy()The policy the container is running on.java.util.Collection<WebSocketSessionListener>getSessionListeners()SslContextFactorygetSslContextFactory()The SslContextFactory in use by the container.booleanisRunning()Test for if the container has been started.voidremoveSessionListener(WebSocketSessionListener listener)
-
-
-
Method Detail
-
getBufferPool
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
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
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()
-
-