cluster::ConnectionRequest Class Reference

Connection request packet. More...

#include <cluster/Packets/ConnectionRequest.h>

Inheritance diagram for cluster::ConnectionRequest:

[legend]Collaboration diagram for cluster::ConnectionRequest:

[legend]List of all members.

Public Member Functions
	ConnectionRequest ()
	ConnectionRequest (std::string host_name, vpr::Uint16 port)
	Create a ConnectionRequest packet to request a remote connection.
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	getHostname ()
	Return the hostname of the machine requesting the connection.
vpr::Uint16	getPort ()
	Return the port that the requesting machine is listening on.
Static Public Member Functions
static vpr::Uint16	getPacketFactoryType ()
	Return the type of this packet.

---

Detailed Description

Connection request packet.

Definition at line 53 of file ConnectionRequest.h.

---

Constructor & Destructor Documentation

cluster::ConnectionRequest::ConnectionRequest

(

)

[inline]

Definition at line 56 of file ConnectionRequest.h.

   {;}

cluster::ConnectionRequest::ConnectionRequest	(	std::string	host_name,
		vpr::Uint16	port
	)

Create a ConnectionRequest packet to request a remote connection.

Parameters:

	host_name	Hostname of the machine requesting the connection.
	port	Port that the requesting machine is listening on.

Definition at line 41 of file ConnectionRequest.cpp.

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

   {
      // Set the local member variables using the given values.
      mHostname = host_name;
      mPort = port;
            
      // Create a Header for this packet with the correect type and size.
      mHeader = new Header(Header::RIM_PACKET,
                                      Header::RIM_CONNECTION_REQ,
                                      Header::RIM_PACKET_HEAD_SIZE 
                                      + vpr::BufferObjectReader::STRING_LENGTH_SIZE
                                      + mHostname.size()
                                      + 2 /*mPort*/
                                      ,0/*Field not curently used*/);
      // Serialize the given data.
      serialize();
   }

---

Member Function Documentation

void cluster::ConnectionRequest::serialize

(

)

Serializes member variables into a data stream.

Definition at line 59 of file ConnectionRequest.cpp.

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

Referenced by ConnectionRequest().

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

      // Serialize the header.
      mHeader->serializeHeader();
      
      // Serialize the hostname of the requesting machine.
      mPacketWriter->writeString(mHostname);
               
      // Serialize the listening port of the requesting machine
      mPacketWriter->writeUint16(mPort);                  
   }

void cluster::ConnectionRequest::parse

(

vpr::BufferObjectReader *

reader

)

[virtual]

Parses the data stream into the local member variables.

Implements cluster::Packet.

Definition at line 75 of file ConnectionRequest.cpp.

   {
      // De-Serialize the hostname of the requesting machine.
      mHostname = reader->readString();
         
      // De-Serialize the listening port of the requesting machine
      mPort = reader->readUint16();
   }

void cluster::ConnectionRequest::printData

(

int

debug_level

)

[virtual]

Print the data to the screen in a readable form.

Implements cluster::Packet.

Definition at line 84 of file ConnectionRequest.cpp.

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

   {
      vprDEBUG_BEGIN(gadgetDBG_RIM,debug_level) 
         <<  clrOutBOLD(clrYELLOW,"==== Connection Request Packet Data ====\n") << vprDEBUG_FLUSH;
      
      Packet::printData(debug_level);

      vprDEBUG(gadgetDBG_RIM,debug_level) 
         << clrOutBOLD(clrYELLOW, "Host Name:    ") << mHostname
         << std::endl << vprDEBUG_FLUSH;
      vprDEBUG(gadgetDBG_RIM,debug_level) 
         << clrOutBOLD(clrYELLOW, "Port:         ") << mPort
         << std::endl << vprDEBUG_FLUSH;

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

static vpr::Uint16 cluster::ConnectionRequest::getPacketFactoryType

(

)

[inline, static]

Return the type of this packet.

Definition at line 85 of file ConnectionRequest.h.

References cluster::Header::RIM_CONNECTION_REQ.

   {
      return(Header::RIM_CONNECTION_REQ);
   }

std::string cluster::ConnectionRequest::getHostname

(

)

[inline]

Return the hostname of the machine requesting the connection.

Definition at line 93 of file ConnectionRequest.h.

   {
      return mHostname;
   }

vpr::Uint16 cluster::ConnectionRequest::getPort

(

)

[inline]

Return the port that the requesting machine is listening on.

Definition at line 101 of file ConnectionRequest.h.

   {
      return mPort;
   }

---

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

• ConnectionRequest.h
• ConnectionRequest.cpp

---