cluster::ConnectionAck Class Reference

Connection acknowledgement packet. More...

#include <cluster/Packets/ConnectionAck.h>

Inheritance diagram for cluster::ConnectionAck:

[legend]Collaboration diagram for cluster::ConnectionAck:

[legend]List of all members.

Public Member Functions
	ConnectionAck ()
	ConnectionAck (std::string host_name, vpr::Uint16 port, bool ack)
	Create a ConnectionAck packet to acknowledge a ConnectionRequest.
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 that is acknowledging the connection.
vpr::Uint16	getPort ()
	Return the port that the acknowledging machine is listening on.
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

Connection acknowledgement packet.

Definition at line 52 of file ConnectionAck.h.

---

Constructor & Destructor Documentation

cluster::ConnectionAck::ConnectionAck

(

)

[inline]

Definition at line 55 of file ConnectionAck.h.

      {;}

cluster::ConnectionAck::ConnectionAck	(	std::string	host_name,
		vpr::Uint16	port,
		bool	ack
	)

Create a ConnectionAck packet to acknowledge a ConnectionRequest.

Parameters:

	host_name	The hostname of the machine that is acknowledging the connection.
	port	The port that the acknowledging machine is listening on.
	ack	Boolean determining if this is a positive (ACK) or a negative (NACK) responce.

Definition at line 41 of file ConnectionAck.cpp.

References cluster::Packet::mHeader, cluster::Header::RIM_CONNECTION_ACK, 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;
      mAck = ack;
      
      // Create a Header for this packet with the correect type and size.
      mHeader = new Header(Header::RIM_PACKET,
                                      Header::RIM_CONNECTION_ACK,
                                      Header::RIM_PACKET_HEAD_SIZE 
                                      + vpr::BufferObjectReader::STRING_LENGTH_SIZE
                                      + mHostname.size()
                                      + 2 /*mPort*/
                                      + 1 /*mAck*/,
                                      0/*Field not curently used*/);
      // Serialize the given data.
      serialize();
   }

---

Member Function Documentation

void cluster::ConnectionAck::serialize

(

)

Serializes member variables into a data stream.

Definition at line 61 of file ConnectionAck.cpp.

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

Referenced by ConnectionAck().

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

      // Serialize the header.
      mHeader->serializeHeader();
      
      // Serialize the hostname of the acknowledging node
      mPacketWriter->writeString(mHostname);
               
      // Serialize the listening port of the acknowledging node
      mPacketWriter->writeUint16(mPort);
         
      // Serialize the Ack boolean
      mPacketWriter->writeBool(mAck);
   }

void cluster::ConnectionAck::parse

(

vpr::BufferObjectReader *

reader

)

[virtual]

Parses the data stream into the local member variables.

Implements cluster::Packet.

Definition at line 80 of file ConnectionAck.cpp.

   {
      // De-Serialize the hostname of the acknowledging node
      mHostname = reader->readString();
         
      // De-Serialize the listening port of the acknowledging node
      mPort = reader->readUint16();

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

void cluster::ConnectionAck::printData

(

int

debug_level

)

[virtual]

Print the data to the screen in a readable form.

Implements cluster::Packet.

Definition at line 92 of file ConnectionAck.cpp.

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

Referenced by gadget::Connector::attemptConnect().

   {
      vprDEBUG_BEGIN(gadgetDBG_RIM,debug_level) 
         <<  clrOutBOLD(clrYELLOW,"==== Connection Ack 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(gadgetDBG_RIM,debug_level) 
         << clrOutBOLD(clrYELLOW, "Ack or Nack:  ") << (mAck ? "Ack" : "Nack")
         << std::endl << vprDEBUG_FLUSH;

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

static vpr::Uint16 cluster::ConnectionAck::getPacketFactoryType

(

)

[inline, static]

Return the type of this packet.

Definition at line 88 of file ConnectionAck.h.

References cluster::Header::RIM_CONNECTION_ACK.

      {
         return(Header::RIM_CONNECTION_ACK);
      }

std::string cluster::ConnectionAck::getHostname

(

)

[inline]

Return the hostname of the machine that is acknowledging the connection.

Definition at line 97 of file ConnectionAck.h.

      {
         return mHostname;
      }

vpr::Uint16 cluster::ConnectionAck::getPort

(

)

[inline]

Return the port that the acknowledging machine is listening on.

Definition at line 105 of file ConnectionAck.h.

      {
         return mPort;
      }

bool cluster::ConnectionAck::getAck

(

)

[inline]

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

Definition at line 114 of file ConnectionAck.h.

Referenced by gadget::Connector::attemptConnect().

      {
         return mAck;
      }

---

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

• ConnectionAck.h
• ConnectionAck.cpp

---