cluster::DeviceRequest Class Reference

Device request packet. More...

#include <cluster/Packets/DeviceRequest.h>

Inheritance diagram for cluster::DeviceRequest:

[legend]Collaboration diagram for cluster::DeviceRequest:

[legend]List of all members.

Public Member Functions
	DeviceRequest ()
	DeviceRequest (const vpr::GUID &plugin_guid, const std::string &device_name)
	Create a DeviceRequest packet to request a remote device.
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.
std::string	getDeviceName ()
	Return the name of the remote device being requested.
Static Public Member Functions
static vpr::Uint16	getPacketFactoryType ()
	Return the type of this packet.

---

Detailed Description

Device request packet.

Definition at line 53 of file DeviceRequest.h.

---

Constructor & Destructor Documentation

cluster::DeviceRequest::DeviceRequest

(

)

[inline]

Definition at line 56 of file DeviceRequest.h.

   {;}

cluster::DeviceRequest::DeviceRequest	(	const vpr::GUID &	plugin_guid,
		const std::string &	device_name
	)

Create a DeviceRequest packet to request a remote device.

Parameters:

	plugin_guid	GUID of the ClusterPlugin that should handle this packet.
	device_name	Name of the remote device being requested.

Definition at line 44 of file DeviceRequest.cpp.

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

   {
      // Set the local member variables using the given values.
      mDeviceName = device_name;
      mPluginId = plugin_guid;
      
      // Create a Header for this packet with the correect type and size.
      mHeader = new Header(Header::RIM_PACKET,
                                      Header::RIM_DEVICE_REQ,
                                      Header::RIM_PACKET_HEAD_SIZE 
                                      + 16 /*Plugin GUID*/
                                      + vpr::BufferObjectReader::STRING_LENGTH_SIZE
                                      + mDeviceName.size(),
                                      0/*Field not curently used*/);
      // Serialize the given data.
      serialize();
   }

---

Member Function Documentation

void cluster::DeviceRequest::serialize

(

)

Serializes member variables into a data stream.

Definition at line 62 of file DeviceRequest.cpp.

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

Referenced by DeviceRequest().

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

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

      // Serialize the name of the requested device.
      mPacketWriter->writeString(mDeviceName);
   }

void cluster::DeviceRequest::parse

(

vpr::BufferObjectReader *

reader

)

[virtual]

Parses the data stream into the local member variables.

Implements cluster::Packet.

Definition at line 77 of file DeviceRequest.cpp.

References cluster::Packet::mPluginId.

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

      // De-Serialize the name of the requested device.
      mDeviceName = reader->readString();
   }

void cluster::DeviceRequest::printData

(

int

debug_level

)

[virtual]

Print the data to the screen in a readable form.

Implements cluster::Packet.

Definition at line 86 of file DeviceRequest.cpp.

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

   {
      vprDEBUG_BEGIN(gadgetDBG_RIM,debug_level) 
         <<  clrOutBOLD(clrYELLOW,"==== Device Request Packet Data ====\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, "Device Name: ") << mDeviceName
         << std::endl << vprDEBUG_FLUSH;

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

static vpr::Uint16 cluster::DeviceRequest::getPacketFactoryType

(

)

[inline, static]

Return the type of this packet.

Definition at line 86 of file DeviceRequest.h.

References cluster::Header::RIM_DEVICE_REQ.

   {
       return(Header::RIM_DEVICE_REQ);
   }

std::string cluster::DeviceRequest::getDeviceName

(

)

[inline]

Return the name of the remote device being requested.

Definition at line 94 of file DeviceRequest.h.

   {
      return mDeviceName;
   }

---

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

• DeviceRequest.h
• DeviceRequest.cpp

---