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 back to the client. This is a spring bean that can be autowired into any other spring bean and allows any part of the application to send messages back to the client e.g.

 @Service
 public class MyService {
        @Autowired
        EventMessenger eventMessenger;
 
        public void doSomething() {
                eventMessenger.sendToAll("aTopic", "the message");
        }
 }
 

This is very similar to the org.springframework.messaging.simp.SimpMessagingTemplate class from Spring's STOMP support.

Constructor Summary

Constructors

Constructor and Description
EventMessenger(PubSubHandler pubSubHandler)

Method Summary

Methods

Modifier and Type	Method and Description
void	sendTo(String topicURI, Object event, Set<String> eligibleSessionIds) Send a EventMessage to the clients that are subscribed to the provided topicURI and are listed in the eligibleSessionIds set.
void	sendToAll(String topicURI, Object event) Send a EventMessage to every client that is currently subscribed to the provided topicURI
void	sendToAllExcept(String topicURI, Object event, Set<String> excludeSessionIds) Send a 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 excludeSessionId) Send a EventMessage to every client that is currently subscribed to the provided topicURI except the one provided with the excludeSessionId parameter.

Methods inherited from class java.lang.Object

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

Constructor Detail

EventMessenger

public EventMessenger(PubSubHandler pubSubHandler)

Method Detail

sendToAll

public void sendToAll(String topicURI,
             Object event)

Send a EventMessage to every client that is currently subscribed to the provided topicURI

Parameters:

topicURI - the name of the topic

event - the message

sendToAllExcept

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

Send a 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 message

excludeSessionIds - a set of session ids that will be excluded

sendToAllExcept

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

Send a 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 message

excludeSessionIds - a set of session ids that will be excluded

sendTo

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

Send a EventMessage to the clients that are subscribed to the provided topicURI and are 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 message

eligibleSessionIds - only the session ids listed here will receive the message