Interface WebSocketContainerScope
-
- All Known Implementing Classes:
DelegatedContainerScope,SimpleContainerScope
public interface WebSocketContainerScopeDefined Scope for a WebSocketContainer.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description org.eclipse.jetty.io.ByteBufferPoolgetBufferPool()The configured Container Buffer Pool.ExecutorgetExecutor()Executor in use by the container.org.eclipse.jetty.util.DecoratedObjectFactorygetObjectFactory()Object Factory used to create objects.org.eclipse.jetty.websocket.api.WebSocketPolicygetPolicy()The policy the container is running on.org.eclipse.jetty.util.ssl.SslContextFactorygetSslContextFactory()The SslContextFactory in use by the container.booleanisRunning()Test for if the container has been started.voidonSessionClosed(WebSocketSession session)A Session has been closedvoidonSessionOpened(WebSocketSession session)A Session has been opened
-
-
-
Method Detail
-
getBufferPool
org.eclipse.jetty.io.ByteBufferPool getBufferPool()
The configured Container Buffer Pool.- Returns:
- the buffer pool (never null)
-
getExecutor
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
org.eclipse.jetty.websocket.api.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
-
onSessionOpened
void onSessionOpened(WebSocketSession session)
A Session has been opened- Parameters:
session- the session that was opened
-
onSessionClosed
void onSessionClosed(WebSocketSession session)
A Session has been closed- Parameters:
session- the session that was closed
-
-