org.diirt.pods.web.common

Class MessageSubscribe

java.lang.Object

org.diirt.pods.web.common.Message

org.diirt.pods.web.common.MessageSubscribe

public class MessageSubscribe
extends Message

Message to subscribe to a channel.

Author:

carcassi

Nested Class Summary

Nested classes/interfaces inherited from class org.diirt.pods.web.common.Message

Message.MessageType

Constructor Summary

Constructors

Constructor and Description
MessageSubscribe(int id, String channel, String type, int maxRate, boolean readOnly) Creates a new message based on the given parameters.
MessageSubscribe(javax.json.JsonObject obj) Creates a new message based on the JSON representation.

Method Summary

Modifier and Type	Method and Description
String	getChannel() The channel name.
int	getMaxRate() The maximum notification rate.
String	getType() The requested type for values.
boolean	isReadOnly() Whether the channel should be read-only.
void	toJson(Writer writer) Serializes this message as JSON onto the given writer.

Methods inherited from class org.diirt.pods.web.common.Message

getId, getMessage, readValueFromJson, writeValueToJson

Methods inherited from class java.lang.Object

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

Constructor Detail

MessageSubscribe

public MessageSubscribe(javax.json.JsonObject obj)
                 throws MessageDecodeException

Creates a new message based on the JSON representation.

Parameters:

obj - JSON object

Throws:

MessageDecodeException - if json format is incorrect

MessageSubscribe

public MessageSubscribe(int id,
                        String channel,
                        String type,
                        int maxRate,
                        boolean readOnly)

Creates a new message based on the given parameters.

Parameters:

id - the channel id

channel - the channel name

type - the type for the value

maxRate - the maximum notification rate

readOnly - whether it's read only

Method Detail

getChannel

public String getChannel()

The channel name.

Returns:

the channel name

getType

public String getType()

The requested type for values.

Returns:

the type name

getMaxRate

public int getMaxRate()

The maximum notification rate.

Returns:

min time in ms between sample

isReadOnly

public boolean isReadOnly()

Whether the channel should be read-only.

Returns:

true if read-only connection

toJson

public void toJson(Writer writer)

Description copied from class: Message

Serializes this message as JSON onto the given writer.

Overrides:

toJson in class Message

Parameters:

writer - the destination where to serialize the message