ch.rasc.wampspring

Class EventMessenger

java.lang.Object

ch.rasc.wampspring.EventMessenger

public class EventMessenger
extends Object

A messenger that allows the calling code to send EventMessages to either the broker or directly to client. The EventMessenger is by default configured as a spring managed bean and can be autowired into any other spring bean. e.g.

 @Service
 public class MyService {
        @Autowired
        EventMessenger eventMessenger;

        public void doSomething() {
                eventMessenger.sendToAll("aTopic", "the message");
        }
 }
 

Constructor Summary

Constructors

Constructor and Description
EventMessenger(org.springframework.messaging.MessageChannel brokerChannel, org.springframework.messaging.MessageChannel clientOutboundChannel)

Method Summary

Modifier and Type	Method and Description
void	send(EventMessage eventMessage) Send an EventMessage to the SimpleBrokerMessageHandler.
void	sendDirect(EventMessage eventMessage) Send an EventMessage directly to the client ( WampMessage.getWebSocketSessionId()).
void	sendTo(String topicURI, Object event, Set<String> eligibleWebSocketSessionIds) Send an EventMessage to every client that is currently subscribed to the given topicURI and is listed in the eligibleSessionIds set.
void	sendTo(String topicURI, Object event, String eligibleWebSocketSessionId) Send an EventMessage to one client that is subscribed to the given topicURI.
void	sendToAll(String topicURI, Object event) Send an EventMessage to every client that is currently subscribed to the given topicURI
void	sendToAllExcept(String topicURI, Object event, Set<String> excludeWebSocketSessionIds) Send an EventMessage to every client that is currently subscribed to the provided topicURI except the ones listed in the excludeSessionIds set.
void	sendToAllExcept(String topicURI, Object event, String excludeWebSocketSessionId) Send an EventMessage to every client that is currently subscribed to the provided topicURI except the one provided with the excludeSessionId parameter.
void	sendToDirect(String topicURI, Object event, Set<String> webSocketSessionIds) Send an EventMessage directly to each client listed in the webSocketSessionId set parameter.
void	sendToDirect(String topicURI, Object event, String webSocketSessionId) Send an EventMessage directly to the client specified with the webSocketSessionId parameter.
void	setSendTimeout(long sendTimeout)

Methods inherited from class java.lang.Object

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

Constructor Detail

EventMessenger

public EventMessenger(org.springframework.messaging.MessageChannel brokerChannel,
                      org.springframework.messaging.MessageChannel clientOutboundChannel)

Method Detail

sendToAll

public void sendToAll(String topicURI,
                      Object event)

Send an EventMessage to every client that is currently subscribed to the given topicURI

Parameters:

topicURI - the name of the topic

event - the payload of the EventMessage

sendToAllExcept

public void sendToAllExcept(String topicURI,
                            Object event,
                            String excludeWebSocketSessionId)

Send an EventMessage to every client that is currently subscribed to the provided topicURI except the one provided with the excludeSessionId parameter.

Parameters:

topicURI - the name of the topic

event - the payload of the EventMessage

excludeWebSocketSessionId - a WebSocket session id that will be excluded

sendToAllExcept

public void sendToAllExcept(String topicURI,
                            Object event,
                            Set<String> excludeWebSocketSessionIds)

Send an EventMessage to every client that is currently subscribed to the provided topicURI except the ones listed in the excludeSessionIds set.

Parameters:

topicURI - the name of the topic

event - the payload of the EventMessage

excludeWebSocketSessionIds - a set of WebSocket session ids that will be excluded. If null or empty no client will be excluded.

sendTo

public void sendTo(String topicURI,
                   Object event,
                   Set<String> eligibleWebSocketSessionIds)

Send an EventMessage to every client that is currently subscribed to the given topicURI and is listed in the eligibleSessionIds set. If no session of the provided set is subscribed to the topicURI nothing happens.

Parameters:

topicURI - the name of the topic

event - the payload of the EventMessage

eligibleWebSocketSessionIds - only the WebSocket session ids listed here will receive the EVENT message. If null or empty nobody receives the message.

sendTo

public void sendTo(String topicURI,
                   Object event,
                   String eligibleWebSocketSessionId)

Send an EventMessage to one client that is subscribed to the given topicURI. If the client with the given WebSocket session id is not subscribed to the topicURI nothing happens.

Parameters:

topicURI - the name of the topic

event - the payload of the EventMessage

eligibleWebSocketSessionId - only the client with the WebSocket session id listed here will receive the EVENT message

sendToDirect

public void sendToDirect(String topicURI,
                         Object event,
                         Set<String> webSocketSessionIds)

Send an EventMessage directly to each client listed in the webSocketSessionId set parameter. If parameter webSocketSessionIds is null or empty no messages are sent.

In contrast to sendTo(String, Object, Set) this method does not check if the receivers are subscribed to the destination. The SimpleBrokerMessageHandler is not involved in sending these messages.

Parameters:

topicURI - the name of the topic

event - the payload of the EventMessage

webSocketSessionIds - list of receivers for the EVENT message

sendToDirect

public void sendToDirect(String topicURI,
                         Object event,
                         String webSocketSessionId)

Send an EventMessage directly to the client specified with the webSocketSessionId parameter.

In contrast to sendTo(String, Object, String) this method does not check if the receiver is subscribed to the destination. The SimpleBrokerMessageHandler is not involved in sending this message.

Parameters:

topicURI - the name of the topic

event - the payload of the EventMessage

webSocketSessionId - receiver of the EVENT message

setSendTimeout

public void setSendTimeout(long sendTimeout)

send

public void send(EventMessage eventMessage)

Send an EventMessage to the SimpleBrokerMessageHandler. The broker looks up if the receiver of the message (WampMessage.getWebSocketSessionId()) is subscribed to the destination (PubSubMessage.getDestination()). If the receiver is subscribed the broker sends the message to him.

Parameters:

eventMessage - The event message

sendDirect

public void sendDirect(EventMessage eventMessage)

Send an EventMessage directly to the client ( WampMessage.getWebSocketSessionId()).

In contrast to send(EventMessage) this method does not check if the receiver is subscribed to the destination. The SimpleBrokerMessageHandler is not involved in sending this message.

Parameters:

eventMessage - The event message

See Also:

send(EventMessage)