org.eclipse.jetty.websocket.common.scopes

Interface WebSocketContainerScope

All Known Implementing Classes:

ClientContainer, ServerContainer, SimpleContainerScope, WebSocketClient, WebSocketServerFactory

public interface WebSocketContainerScope

Defined Scope for a WebSocketContainer.

Method Summary

Modifier and Type	Method and Description
ByteBufferPool	getBufferPool() The configured Container Buffer Pool.
Executor	getExecutor() Executor in use by the container.
DecoratedObjectFactory	getObjectFactory() Object Factory used to create objects.
WebSocketPolicy	getPolicy() The policy the container is running on.
SslContextFactory	getSslContextFactory() The SslContextFactory in use by the container.
void	onSessionClosed(WebSocketSession session) A Session has been closed
void	onSessionOpened(WebSocketSession session) A Session has been opened

Method Detail

getBufferPool

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

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)

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