org.apache.wicket.protocol.ws.api
Interface IWebSocketConnectionRegistry

All Known Implementing Classes:

SimpleWebSocketConnectionRegistry

public interface IWebSocketConnectionRegistry

Tracks all currently connected WebSocket clients

Since:

6.0

Method Summary

IWebSocketConnection	getConnection(Application application, String sessionId, Integer pageId)
Collection<IWebSocketConnection>	getConnections(Application application)
void	removeConnection(Application application, String sessionId, Integer pageId) Removes a web socket connection from the registry at the specified coordinates (application+session+page)
void	setConnection(Application application, String sessionId, Integer pageId, IWebSocketConnection connection) Adds a new connection into the registry at the specified coordinates (application+session+page)

Method Detail

getConnection

IWebSocketConnection getConnection(Application application,
                                   String sessionId,
                                   Integer pageId)

Parameters:

application - the web application to look in

sessionId - the web socket client session id

pageId - the web socket client page id

Returns:

the web socket connection used by a client from the specified coordinates

getConnections

Collection<IWebSocketConnection> getConnections(Application application)

Parameters:

application - the web application to look in

Returns:

collection of web socket connection used by any client connected to specified application

setConnection

void setConnection(Application application,
                   String sessionId,
                   Integer pageId,
                   IWebSocketConnection connection)

Adds a new connection into the registry at the specified coordinates (application+session+page)

Parameters:

application - the web application to look in

sessionId - the web socket client session id

pageId - the web socket client page id

connection - the web socket connection to add

removeConnection

void removeConnection(Application application,
                      String sessionId,
                      Integer pageId)

Removes a web socket connection from the registry at the specified coordinates (application+session+page)

Parameters:

application - the web application to look in

sessionId - the web socket client session id

pageId - the web socket client page id