org.jboss.aerogear.simplepush.protocol
Interface PingMessage

All Superinterfaces:

MessageType

All Known Implementing Classes:

PingMessageImpl

public interface PingMessage
extends MessageType

Represents the Ping message in the SimplePush specification protocol

This message can be send by the UserAgent to verify that the connection to the server is working. The Ping messge type does not follow the model of the other messages in the protocol which all have a 'messageType' field identifying the type of message. The Ping message is indended to be as small as possible. The actual payload is not specified but recommended to be a simple empty JavaScript object, '{}'

Nested Class Summary

Nested classes/interfaces inherited from interface org.jboss.aerogear.simplepush.protocol.MessageType

MessageType.Type

Field Summary

static String

PING_MESSAGE The default value for a Ping message body.

Fields inherited from interface org.jboss.aerogear.simplepush.protocol.MessageType

MESSSAGE_TYPE_FIELD

Method Summary

String

getPingMessage() Returns contents of the ping message, which should be '{}'.

Methods inherited from interface org.jboss.aerogear.simplepush.protocol.MessageType

getMessageType

Field Detail

PING_MESSAGE

static final String PING_MESSAGE

The default value for a Ping message body.

See Also:

Constant Field Values

Method Detail

getPingMessage

String getPingMessage()

Returns contents of the ping message, which should be '{}'.

Returns:

String the contents of the ping message.