edu.umass.cs.protocoltask.json

Class ProtocolPacket<NodeIDType,EventType>

java.lang.Object

edu.umass.cs.protocoltask.json.ProtocolPacket<NodeIDType,EventType>

Type Parameters:

NodeIDType -

EventType - This class is concretized to use integer node IDs, long keys, and JSON messages, but the PacketType is left generic. The reason is so that implementors can define and use their own packet types. Note that it is not possible to extend the enum Packet.PacketType and it is not modular to have to put *all* packet types in the Packet class.

All Implemented Interfaces:

ProtocolEvent<EventType,java.lang.String>, ThresholdProtocolEvent<NodeIDType,EventType,java.lang.String>, Keyable<java.lang.String>

Direct Known Subclasses:

PingPongPacket, ReconfigurationPacket

public abstract class ProtocolPacket<NodeIDType,EventType>
extends java.lang.Object
implements ThresholdProtocolEvent<NodeIDType,EventType,java.lang.String>

Author:

V. Arun

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ProtocolPacket.Keys

Field Summary

Fields

Modifier and Type	Field and Description
protected EventType	type

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ProtocolPacket(org.json.JSONObject json)
	ProtocolPacket(org.json.JSONObject json, Stringifiable<NodeIDType> unstringer)
	ProtocolPacket(NodeIDType initiator)
	ProtocolPacket(ProtocolPacket<NodeIDType,EventType> pkt)

Method Summary

Modifier and Type	Method and Description
protected NodeIDType	flip(NodeIDType rcvr)
NodeIDType	getInitiator()
java.lang.String	getKey()
java.lang.Object	getMessage()
abstract EventType	getPacketType(org.json.JSONObject json)
NodeIDType	getSender()
EventType	getType()
abstract void	putPacketType(org.json.JSONObject json, EventType type)
void	setKey(java.lang.String key) Sets the protocol key.
protected void	setSender(NodeIDType id)
void	setType(EventType type)
org.json.JSONObject	toJSONObject()
abstract org.json.JSONObject	toJSONObjectImpl()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

type

protected EventType type

Constructor Detail

ProtocolPacket

public ProtocolPacket(NodeIDType initiator)

ProtocolPacket

public ProtocolPacket(ProtocolPacket<NodeIDType,EventType> pkt)

ProtocolPacket

public ProtocolPacket(org.json.JSONObject json,
                      Stringifiable<NodeIDType> unstringer)
               throws org.json.JSONException

Throws:

org.json.JSONException

ProtocolPacket

protected ProtocolPacket(org.json.JSONObject json)
                  throws org.json.JSONException

Throws:

org.json.JSONException

Method Detail

getSender

public NodeIDType getSender()

Specified by:

getSender in interface ThresholdProtocolEvent<NodeIDType,EventType,java.lang.String>

Returns:

Sender node ID for this protocol event message.

setSender

protected void setSender(NodeIDType id)

getInitiator

public NodeIDType getInitiator()

flip

protected NodeIDType flip(NodeIDType rcvr)

getType

public EventType getType()

Specified by:

getType in interface ProtocolEvent<EventType,java.lang.String>

Returns:

Type of event.

setType

public void setType(EventType type)

toJSONObjectImpl

public abstract org.json.JSONObject toJSONObjectImpl()
                                              throws org.json.JSONException

Throws:

org.json.JSONException

getPacketType

public abstract EventType getPacketType(org.json.JSONObject json)
                                 throws org.json.JSONException

Throws:

org.json.JSONException

putPacketType

public abstract void putPacketType(org.json.JSONObject json,
                                   EventType type)
                            throws org.json.JSONException

Throws:

org.json.JSONException

toJSONObject

public org.json.JSONObject toJSONObject()
                                 throws org.json.JSONException

Throws:

org.json.JSONException

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getKey

public java.lang.String getKey()

Specified by:

getKey in interface Keyable<java.lang.String>

Returns:

The key.

setKey

public void setKey(java.lang.String key)

Description copied from interface: ProtocolEvent

Sets the protocol key.

Specified by:

setKey in interface ProtocolEvent<EventType,java.lang.String>

getMessage

public java.lang.Object getMessage()

Specified by:

getMessage in interface ProtocolEvent<EventType,java.lang.String>

Returns:

An object whose toString() method must serialize this event to a String.