act.ws

Class WebSocketConnectionManager

java.lang.Object

act.util.DestroyableBase

act.app.AppHolderBase<T>

act.app.AppServiceBase<WebSocketConnectionManager>

act.ws.WebSocketConnectionManager

All Implemented Interfaces:

AppHolder<WebSocketConnectionManager>, AppService<WebSocketConnectionManager>, Destroyable

public class WebSocketConnectionManager
extends AppServiceBase<WebSocketConnectionManager>

Manage WebSocketConnection through WebSocketConnectionRegistry

Nested Class Summary

Nested classes/interfaces inherited from interface act.Destroyable

Destroyable.Util

Constructor Summary

Constructors

Constructor and Description
WebSocketConnectionManager(App app)

Method Summary

Modifier and Type	Method and Description
void	registerNewConnection(WebSocketConnection connection, ActionContext context)
protected void	releaseResources()
void	sendJsonToTagged(Object data, Collection<String> labels) Send JSON representation of given data object to all connections tagged with all give tag labels
void	sendJsonToTagged(Object data, String... labels) Send JSON representation of given data object to all connections tagged with all give tag labels
void	sendJsonToTagged(Object data, String label) Send JSON representation of given data object to all connections tagged with given label
void	sendJsonToUrl(Object data, String url) Send JSON representation of given data object to all connections connected to given URL
void	sendJsonToUser(Object data, String username) Send JSON representation of given data object to all connections of a user
void	sendToTagged(String message, Collection<String> labels) Send message to all connections tagged with all given tags
void	sendToTagged(String message, String... labels) Send message to all connections tagged with all given tags
void	sendToTagged(String message, String label) Send message to all connections tagged with given label
void	sendToUrl(String message, String url) Send message to all connections connected to give URL
void	sendToUser(String message, String username) Send message to all connections of a user
WebSocketConnectionRegistry	sessionRegistry()
void	subscribe(org.osgl.http.H.Session session, String tag) Add tag to any websocket connection linked to the session specified
WebSocketConnectionRegistry	tagRegistry()
WebSocketConnectionRegistry	urlRegistry()
WebSocketConnectionRegistry	usernameRegistry()

Methods inherited from class act.app.AppServiceBase

app

Methods inherited from class act.app.AppHolderBase

app, me

Methods inherited from class act.util.DestroyableBase

addSubResource, destroy, isDestroyed, reload, scope

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface act.Destroyable

destroy, isDestroyed, scope

Methods inherited from interface act.app.AppHolder

app

Constructor Detail

WebSocketConnectionManager

public WebSocketConnectionManager(App app)

Method Detail

sessionRegistry

public WebSocketConnectionRegistry sessionRegistry()

usernameRegistry

public WebSocketConnectionRegistry usernameRegistry()

urlRegistry

public WebSocketConnectionRegistry urlRegistry()

tagRegistry

public WebSocketConnectionRegistry tagRegistry()

subscribe

public void subscribe(org.osgl.http.H.Session session,
                      String tag)

Add tag to any websocket connection linked to the session specified

Parameters:

session - the session used to find websocket connections

tag - the tag to subscribe

sendToUrl

public void sendToUrl(String message,
                      String url)

Send message to all connections connected to give URL

Parameters:

message - the message

url - the url

sendJsonToUrl

public void sendJsonToUrl(Object data,
                          String url)

Send JSON representation of given data object to all connections connected to given URL

Parameters:

data - the data object

url - the url

sendToTagged

public void sendToTagged(String message,
                         String label)

Send message to all connections tagged with given label

Parameters:

message - the message

label - the tag label

sendToTagged

public void sendToTagged(String message,
                         String... labels)

Send message to all connections tagged with all given tags

Parameters:

message - the message

labels - the tag labels

sendToTagged

public void sendToTagged(String message,
                         Collection<String> labels)

Send message to all connections tagged with all given tags

Parameters:

message - the message

labels - the tag labels

sendJsonToTagged

public void sendJsonToTagged(Object data,
                             String label)

Send JSON representation of given data object to all connections tagged with given label

Parameters:

data - the data object

label - the tag label

sendJsonToTagged

public void sendJsonToTagged(Object data,
                             String... labels)

Send JSON representation of given data object to all connections tagged with all give tag labels

Parameters:

data - the data object

labels - the tag labels

sendJsonToTagged

public void sendJsonToTagged(Object data,
                             Collection<String> labels)

Send JSON representation of given data object to all connections tagged with all give tag labels

Parameters:

data - the data object

labels - the tag labels

sendToUser

public void sendToUser(String message,
                       String username)

Send message to all connections of a user

Parameters:

message - the message

username - the username

sendJsonToUser

public void sendJsonToUser(Object data,
                           String username)

Send JSON representation of given data object to all connections of a user

Parameters:

data - the data object

username - the username

registerNewConnection

public void registerNewConnection(WebSocketConnection connection,
                                  ActionContext context)

releaseResources

protected void releaseResources()

Specified by:

releaseResources in class AppServiceBase<WebSocketConnectionManager>