org.diirt.pods.web.common

Class MessageConnectionEvent

java.lang.Object

org.diirt.pods.web.common.Message

org.diirt.pods.web.common.MessageConnectionEvent

public class MessageConnectionEvent
extends Message

Message event for change of connection status.

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
MessageConnectionEvent(int id, boolean connected, boolean writeConnected) Creates a new message based on the given parameters.
MessageConnectionEvent(javax.json.JsonObject obj) Creates a new message based on the JSON representation.

Method Summary

Modifier and Type	Method and Description
boolean	isConnected() Whether the channel is connected.
boolean	isWriteConnected() Whether the channel can be written to.
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

MessageConnectionEvent

public MessageConnectionEvent(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

MessageConnectionEvent

public MessageConnectionEvent(int id,
                              boolean connected,
                              boolean writeConnected)

Creates a new message based on the given parameters.

Parameters:

id - the channel id

connected - whether it's connected

writeConnected - whether the write is connected

Method Detail

isConnected

public boolean isConnected()

Whether the channel is connected.

Returns:

true if connected

isWriteConnected

public boolean isWriteConnected()

Whether the channel can be written to.

Returns:

true if write connected

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