Package org.eclipse.jetty.websocket.api

Interface WebSocketContainer

All Known Implementing Classes:

JettyWebSocketServerContainer, WebSocketClient

public interface WebSocketContainer

Generic interface to the Container (server or client)

Method Summary

Modifier and Type	Method	Description
void	addSessionListener(WebSocketSessionListener listener)	Register a WebSocketSessionListener with the container
Executor	getExecutor()	The Container provided Executor.
Collection<Session>	getOpenSessions()	Get the collection of open Sessions being tracked by this container
void	notifySessionListeners(Consumer<WebSocketSessionListener> consumer)	Notify the Session Listeners of an event.
boolean	removeSessionListener(WebSocketSessionListener listener)	Remove a WebSocketSessionListener from the container

Method Details

getExecutor

Executor getExecutor()

The Container provided Executor.

getOpenSessions

Collection<Session> getOpenSessions()

Get the collection of open Sessions being tracked by this container

Returns:

the collection of open sessions

addSessionListener

void addSessionListener(WebSocketSessionListener listener)

Register a WebSocketSessionListener with the container

Parameters:

listener - the listener

removeSessionListener

boolean removeSessionListener(WebSocketSessionListener listener)

Remove a WebSocketSessionListener from the container

Parameters:

listener - the listener

Returns:

true if listener was present and removed

notifySessionListeners

void notifySessionListeners(Consumer<WebSocketSessionListener> consumer)

Notify the Session Listeners of an event.

Parameters:

consumer - the consumer to call for each tracked listener