ch.rasc.wampspring.message

Class UnsubscribeMessage

java.lang.Object

ch.rasc.wampspring.message.WampMessage

ch.rasc.wampspring.message.PubSubMessage

ch.rasc.wampspring.message.UnsubscribeMessage

All Implemented Interfaces:

org.springframework.messaging.Message<Object>

public class UnsubscribeMessage
extends PubSubMessage

Calling unsubscribe on a topicURI informs the server to stop delivering messages to the client previously subscribed to that topicURI.

Client-to-Server message

See Also:

WAMP specification

Field Summary

Fields inherited from class ch.rasc.wampspring.message.WampMessage

EMPTY_OBJECT

Constructor Summary

Constructors

Constructor and Description
UnsubscribeMessage(com.fasterxml.jackson.core.JsonParser jp)
UnsubscribeMessage(com.fasterxml.jackson.core.JsonParser jp, WampSession wampSession)
UnsubscribeMessage(String topicURI)

Method Summary

Modifier and Type	Method and Description
static UnsubscribeMessage	createCleanupMessage(org.springframework.web.socket.WebSocketSession session) Creates an internal unsubscribe message.
boolean	isCleanup()
String	toJson(com.fasterxml.jackson.core.JsonFactory jsonFactory)
String	toString()

Methods inherited from class ch.rasc.wampspring.message.PubSubMessage

getDestination, getTopicURI, setTopicURI

Methods inherited from class ch.rasc.wampspring.message.WampMessage

fromJson, fromJson, fromJson, getHeader, getHeaders, getPayload, getPrincipal, getType, getWampSession, getWebSocketSessionId, replacePrefix, setDestinationTemplateVariables, setHeader, setWebSocketSessionId

Methods inherited from class java.lang.Object

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

Constructor Detail

UnsubscribeMessage

public UnsubscribeMessage(String topicURI)

UnsubscribeMessage

public UnsubscribeMessage(com.fasterxml.jackson.core.JsonParser jp)
                   throws IOException

Throws:

IOException

UnsubscribeMessage

public UnsubscribeMessage(com.fasterxml.jackson.core.JsonParser jp,
                          WampSession wampSession)
                   throws IOException

Throws:

IOException

Method Detail

createCleanupMessage

public static UnsubscribeMessage createCleanupMessage(org.springframework.web.socket.WebSocketSession session)

Creates an internal unsubscribe message. The system creates this message when the WebSocket session ends and sends it to the subscribed message handlers for cleaning up

Parameters:

sessionId - the WebSocket session id

isCleanup

public boolean isCleanup()

toJson

public String toJson(com.fasterxml.jackson.core.JsonFactory jsonFactory)
              throws IOException

Specified by:

toJson in class WampMessage

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object