cluster::ApplicationDataAck Class Reference

Application-specific data acknowledgement packet. More...

#include <cluster/Packets/ApplicationDataAck.h>

Inheritance diagram for cluster::ApplicationDataAck:

[legend]Collaboration diagram for cluster::ApplicationDataAck:

[legend]List of all members.

Public Member Functions
	ApplicationDataAck ()
	ApplicationDataAck (const vpr::GUID &plugin_guid, const vpr::GUID &id, const bool ack)
	Create a ApplicationDataAck packet to acknowledge a ApplicationDataRequest.
void	serialize ()
	Serializes member variables into a data stream.
virtual void	parse (vpr::BufferObjectReader *reader)
	Parses the data stream into the local member variables.
virtual void	printData (int debug_level)
	Print the data to the screen in a readable form.
vpr::GUID	getId ()
	Return the GUID of the ApplicationData object being acknoledged.
bool	getAck ()
	Return a boolean determining if this is a positive(ACK) or a negative(NACK) responce.
Static Public Member Functions
static vpr::Uint16	getPacketFactoryType ()
	Return the type of this packet.

---

Detailed Description

Application-specific data acknowledgement packet.

Definition at line 53 of file ApplicationDataAck.h.

---

Constructor & Destructor Documentation

cluster::ApplicationDataAck::ApplicationDataAck

(

)

[inline]

Definition at line 56 of file ApplicationDataAck.h.

   {;}

cluster::ApplicationDataAck::ApplicationDataAck	(	const vpr::GUID &	plugin_guid,
		const vpr::GUID &	id,
		const bool	ack
	)

Create a ApplicationDataAck packet to acknowledge a ApplicationDataRequest.

Parameters:

	plugin_guid	GUID of the ClusterPlugin that should handle this packet.
	id	GUID of the ApplicationData object that we are acknowledging.
	ack	Boolean determining if this is a positive (ACK) or a negative (NACK) responce.

Definition at line 43 of file ApplicationDataAck.cpp.

References cluster::Packet::mHeader, cluster::Packet::mPluginId, cluster::Header::RIM_APPDATA_ACK, cluster::Header::RIM_PACKET, cluster::Header::RIM_PACKET_HEAD_SIZE, and serialize().

   {
      // Set the local member variables using the given values.
      mPluginId = plugin_guid;
      mId = id;
      mAck = ack;
      
      // Create a Header for this packet with the correect type and size.
      mHeader = new Header(Header::RIM_PACKET,
                                      Header::RIM_APPDATA_ACK,
                                      Header::RIM_PACKET_HEAD_SIZE 
                                      + 16/*Plugin GUID*/
                                      + 16/*Object GUID*/
                                      + 1 /*mAck*/,
                                      0/*Field not curently used*/);
      // Serialize the given data.
      serialize();
   }

---

Member Function Documentation

void cluster::ApplicationDataAck::serialize

(

)

Serializes member variables into a data stream.

Definition at line 63 of file ApplicationDataAck.cpp.

References cluster::Packet::mHeader, cluster::Packet::mPacketWriter, cluster::Packet::mPluginId, and cluster::Header::serializeHeader().

Referenced by ApplicationDataAck().

   {
      // Clear the data stream.
      mPacketWriter->getData()->clear();
      mPacketWriter->setCurPos(0);

      // Serialize the header.
      mHeader->serializeHeader();
      
      // Serialize plugin GUID
      mPluginId.writeObject(mPacketWriter);

      // Serialize ApplicationData object GUID
      mId.writeObject(mPacketWriter);

      // Serialize the Ack boolean
      mPacketWriter->writeBool(mAck);
   }

void cluster::ApplicationDataAck::parse

(

vpr::BufferObjectReader *

reader

)

[virtual]

Parses the data stream into the local member variables.

Implements cluster::Packet.

Definition at line 82 of file ApplicationDataAck.cpp.

References cluster::Packet::mPluginId.

   {
      // De-Serialize plugin GUID
      mPluginId.readObject(reader);
      
      // De-Serialize ApplicationData object GUID
      mId.readObject(reader);

      // De-Serialize the Ack boolean
      mAck = reader->readBool();
   }

void cluster::ApplicationDataAck::printData

(

int

debug_level

)

[virtual]

Print the data to the screen in a readable form.

Implements cluster::Packet.

Definition at line 94 of file ApplicationDataAck.cpp.

References gadgetDBG_RIM(), cluster::Packet::mPluginId, and cluster::Packet::printData().

   {
      vprDEBUG_BEGIN(gadgetDBG_RIM,debug_level) 
         <<  clrOutBOLD(clrYELLOW,"==== ApplicationData Ack Packet ====\n") << vprDEBUG_FLUSH;
      
      Packet::printData(debug_level);

      vprDEBUG(gadgetDBG_RIM,debug_level) 
         << clrOutBOLD(clrYELLOW, "Plugin GUID:        ") << mPluginId.toString()
         << std::endl << vprDEBUG_FLUSH;
      vprDEBUG(gadgetDBG_RIM,debug_level) 
         << clrOutBOLD(clrYELLOW, "Object GUID:        ") << mId.toString()
         << std::endl << vprDEBUG_FLUSH;
      vprDEBUG(gadgetDBG_RIM,debug_level) 
         << clrOutBOLD(clrYELLOW, "Ack or Nack:      ") << (mAck ? "Ack" : "Nack")  << std::endl
         << std::endl << vprDEBUG_FLUSH;

      vprDEBUG_END(gadgetDBG_RIM,debug_level) 
         <<  clrOutBOLD(clrYELLOW,"================================\n") << vprDEBUG_FLUSH;      
   }

static vpr::Uint16 cluster::ApplicationDataAck::getPacketFactoryType

(

)

[inline, static]

Return the type of this packet.

Definition at line 92 of file ApplicationDataAck.h.

References cluster::Header::RIM_APPDATA_ACK.

   {
       return(Header::RIM_APPDATA_ACK);
   }

vpr::GUID cluster::ApplicationDataAck::getId

(

)

[inline]

Return the GUID of the ApplicationData object being acknoledged.

Definition at line 100 of file ApplicationDataAck.h.

Referenced by cluster::ApplicationDataManager::handlePacket().

{ return mId; }

bool cluster::ApplicationDataAck::getAck

(

)

[inline]

Return a boolean determining if this is a positive(ACK) or a negative(NACK) responce.

Definition at line 106 of file ApplicationDataAck.h.

Referenced by cluster::ApplicationDataManager::handlePacket().

   {
      return mAck;
   }

---

The documentation for this class was generated from the following files:

• ApplicationDataAck.h
• ApplicationDataAck.cpp

---