org.hawkular.feedcomm.ws

Class WebSocketHelper

java.lang.Object

org.hawkular.feedcomm.ws.WebSocketHelper

public class WebSocketHelper
extends Object

Some convienence methods when working with WebSockets.

Constructor Summary

Constructors

Constructor and Description
WebSocketHelper()
WebSocketHelper(Long asyncTimeout) Creates a helper object.

Method Summary

Modifier and Type	Method and Description
void	sendBasicMessageAsync(Collection<javax.websocket.Session> sessions, BasicMessage msg) Converts the given message to JSON and sends that JSON text to clients asynchronously.
void	sendBasicMessageAsync(javax.websocket.Session session, BasicMessage msg)
void	sendBasicMessageSync(Collection<javax.websocket.Session> sessions, BasicMessage msg) Converts the given message to JSON and sends that JSON text to clients synchronously.
void	sendBasicMessageSync(javax.websocket.Session session, BasicMessage msg)
void	sendTextAsync(Collection<javax.websocket.Session> sessions, String text) Sends text to clients asynchronously.
void	sendTextAsync(javax.websocket.Session session, String text)
void	sendTextSync(Collection<javax.websocket.Session> sessions, String text) Sends text to clients synchronously.
void	sendTextSync(javax.websocket.Session session, String text)

Methods inherited from class java.lang.Object

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

Constructor Detail

WebSocketHelper

public WebSocketHelper()

WebSocketHelper

public WebSocketHelper(Long asyncTimeout)

Creates a helper object.

Parameters:

timeout - number of milliseconds before an asynchronous send will timeout. A negative number means no timeout, null means use the WebSocket default timeout.

Method Detail

sendBasicMessageAsync

public void sendBasicMessageAsync(Collection<javax.websocket.Session> sessions,
                                  BasicMessage msg)

Converts the given message to JSON and sends that JSON text to clients asynchronously.

Parameters:

sessions - the client sessions where the JSON message will be sent

msg - the message to be converted to JSON and sent

sendBasicMessageSync

public void sendBasicMessageSync(Collection<javax.websocket.Session> sessions,
                                 BasicMessage msg)
                          throws IOException

Converts the given message to JSON and sends that JSON text to clients synchronously. If you send to multiple sessions, but an error occurred trying to deliver to one of the sessions, this method aborts, throws an exception, and the rest of the sessions will not get the message.

Parameters:

sessions - the client sessions where the message will be sent

msg - the message to be converted to JSON and sent

Throws:

IOException - if a problem occurred during delivery of the message to a session.

sendTextAsync

public void sendTextAsync(Collection<javax.websocket.Session> sessions,
                          String text)

Sends text to clients asynchronously.

Parameters:

sessions - the client sessions where the message will be sent

text - the message

sendTextSync

public void sendTextSync(Collection<javax.websocket.Session> sessions,
                         String text)
                  throws IOException

Sends text to clients synchronously. If you send to multiple sessions, but an error occurred trying to deliver to one of the sessions, this method aborts, throws an exception, and the rest of the sessions will not get the message.

Parameters:

sessions - the client sessions where the message will be sent

text - the message

Throws:

IOException - if a problem occurred during delivery of the message to a session.

sendBasicMessageAsync

public void sendBasicMessageAsync(javax.websocket.Session session,
                                  BasicMessage msg)

sendBasicMessageSync

public void sendBasicMessageSync(javax.websocket.Session session,
                                 BasicMessage msg)
                          throws IOException

Throws:

IOException

sendTextAsync

public void sendTextAsync(javax.websocket.Session session,
                          String text)

sendTextSync

public void sendTextSync(javax.websocket.Session session,
                         String text)
                  throws IOException

Throws:

IOException