cluster::ApplicationDataRequest Class Reference

Application-specific request packet. More...

#include <cluster/Packets/ApplicationDataRequest.h>

Inheritance diagram for cluster::ApplicationDataRequest:

[legend]Collaboration diagram for cluster::ApplicationDataRequest:

[legend]List of all members.

Public Member Functions
	ApplicationDataRequest ()
	ApplicationDataRequest (const vpr::GUID plugin_guid, const vpr::GUID &id)
	Create a ApplicationDataRequest packet to request a remote ApplicationData object.
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 requested.
Static Public Member Functions
static vpr::Uint16	getPacketFactoryType ()
	Return the type of this packet.

---

Detailed Description

Application-specific request packet.

Definition at line 52 of file ApplicationDataRequest.h.

---

Constructor & Destructor Documentation

cluster::ApplicationDataRequest::ApplicationDataRequest

(

)

[inline]

Definition at line 55 of file ApplicationDataRequest.h.

   {;}

cluster::ApplicationDataRequest::ApplicationDataRequest	(	const vpr::GUID	plugin_guid,
		const vpr::GUID &	id
	)

Create a ApplicationDataRequest packet to request a remote ApplicationData object.

Parameters:

	plugin_guid	GUID of the ClusterPlugin that should handle this packet.
	id	GUID of the ApplicationData object that we are requesting.

Definition at line 42 of file ApplicationDataRequest.cpp.

References cluster::Packet::mHeader, cluster::Packet::mPluginId, cluster::Header::RIM_APPDATA_REQ, 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;

      // Create a Header for this packet with the correect type and size.
      mHeader = new Header(Header::RIM_PACKET,
                                      Header::RIM_APPDATA_REQ,
                                      Header::RIM_PACKET_HEAD_SIZE 
                                      + 16/*Plugin GUID*/
                                      + 16/*Object GUID*/,
                                      0/*Field not curently used*/);
      // Serialize the given data.
      serialize();
   }

---

Member Function Documentation

void cluster::ApplicationDataRequest::serialize

(

)

Serializes member variables into a data stream.

Definition at line 58 of file ApplicationDataRequest.cpp.

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

Referenced by ApplicationDataRequest().

   {
      // 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);
   }

void cluster::ApplicationDataRequest::parse

(

vpr::BufferObjectReader *

reader

)

[virtual]

Parses the data stream into the local member variables.

Implements cluster::Packet.

Definition at line 74 of file ApplicationDataRequest.cpp.

References cluster::Packet::mPluginId.

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

void cluster::ApplicationDataRequest::printData

(

int

debug_level

)

[virtual]

Print the data to the screen in a readable form.

Implements cluster::Packet.

Definition at line 83 of file ApplicationDataRequest.cpp.

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

   {
      vprDEBUG_BEGIN(gadgetDBG_RIM,debug_level) 
         <<  clrOutBOLD(clrYELLOW,"==== ApplicationData Request 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_END(gadgetDBG_RIM,debug_level) 
         <<  clrOutBOLD(clrYELLOW,"====================================\n") << vprDEBUG_FLUSH;
   }

static vpr::Uint16 cluster::ApplicationDataRequest::getPacketFactoryType

(

)

[inline, static]

Return the type of this packet.

Definition at line 87 of file ApplicationDataRequest.h.

References cluster::Header::RIM_APPDATA_REQ.

   {
       return(Header::RIM_APPDATA_REQ);
   }

vpr::GUID cluster::ApplicationDataRequest::getId

(

)

[inline]

Return the GUID of the ApplicationData object being requested.

Definition at line 95 of file ApplicationDataRequest.h.

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

   {
   return mId;
   }

---

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

• ApplicationDataRequest.h
• ApplicationDataRequest.cpp

---