cluster::ApplicationDataServer Class Reference

#include <ApplicationDataServer.h>

Collaboration diagram for cluster::ApplicationDataServer:

[legend]List of all members.

Public Member Functions
	ApplicationDataServer (const vpr::GUID &guid, ApplicationData *user_data, const vpr::GUID &plugin_id)
	Create a new ApplicationDataServer.
	~ApplicationDataServer ()
	Release all memory that is no longer needed.
void	serializeAndSend ()
	Send mDataPacket, which has been updated in updateLocalData, to each client.
void	addClient (gadget::Node *new_client_node)
	Add a Node to the list of clients that should receive data for this ApplicationData.
void	removeClient (const std::string &host_name)
	Remove a Node from the list of clients that should receive data for this ApplicationData.
void	debugDump (int debug_level)
	Print information about this ApplicationDataServer to the screen.
vpr::GUID	getId ()
	Return the GUID of the ApplicationData that this server is responsible for.

---

Detailed Description

Definition at line 53 of file ApplicationDataServer.h.

---

Constructor & Destructor Documentation

cluster::ApplicationDataServer::ApplicationDataServer	(	const vpr::GUID &	guid,
		ApplicationData *	user_data,
		const vpr::GUID &	plugin_id
	)

Create a new ApplicationDataServer.

Parameters:

	guid	GUID of the given ApplicationData.
	user_data	Pointer to the ApplicationData that we are sharing.
	plugin_id	GUID that should be placed at the beginning of each data packet so that the receiver knows which plugin the data is coming from.

Definition at line 48 of file ApplicationDataServer.cpp.

   {
      mApplicationData = user_data;

      // mDataPacket and mBufferObjectWriter both use mDeviceData as their data buffer.
      mDeviceData = new std::vector<vpr::Uint8>;
      
      // Create a DataPacket that will be updated and sent continually.
      mDataPacket = new DataPacket(plugin_guid, guid, mDeviceData);
      mBufferObjectWriter = new vpr::BufferObjectWriter(mDeviceData);
   }

cluster::ApplicationDataServer::~ApplicationDataServer

(

)

Release all memory that is no longer needed.

Definition at line 60 of file ApplicationDataServer.cpp.

   {
      delete mApplicationData;
      
      // mDataPacket will clean up the memory that mDeviceData points
      // to since mDataPacket contains a reference to the ame memory.
      delete mDataPacket;
      // vpr::BufferObjectWritter does not release mDeviceData
      delete mBufferObjectWriter;
      mDeviceData = NULL;   
   }

---

Member Function Documentation

void cluster::ApplicationDataServer::serializeAndSend

(

)

Send mDataPacket, which has been updated in updateLocalData, to each client.

Definition at line 72 of file ApplicationDataServer.cpp.

References debugDump(), gadget::Node::DISCONNECTED, gadgetDBG_RIM(), cluster::Packet::getHeader(), cluster::ClusterException::getMessage(), cluster::Header::RIM_PACKET_HEAD_SIZE, cluster::Header::serializeHeader(), and cluster::Header::setPacketLength().

   {
      // Clear old data and reset the position of mBufferObjectWriter
      mBufferObjectWriter->getData()->clear();
      mBufferObjectWriter->setCurPos(0);

      // This updates the mApplicationData which both mBufferedObjectReader and mDevicePacket point to
      vpr::ReturnStatus status = mApplicationData->writeObject(mBufferObjectWriter);

      // If we do not successfully serialize the object, don't send it.
      // This allows the developer to create a object that only gets
      // sent when a change occurs.
      if (!status.success())
      {
         return;
      }

      // We must update the size of the actual data that we are going to send
      mDataPacket->getHeader()->setPacketLength(Header::RIM_PACKET_HEAD_SIZE 
                                       + 16 /*Plugin GUID*/
                                       + 16 /*Plugin GUID*/
                                       + mDeviceData->size());

      // We must serialize the header again so that we can reset the size.
      mDataPacket->getHeader()->serializeHeader();



      // Send the serialized data to each client
      vpr::Guard<vpr::Mutex> guard(mClientsLock);
      
      // Send DataPacket to all nodes in mClients
      for (std::vector<gadget::Node*>::iterator i = mClients.begin();
           i != mClients.end() ; i++)
      {
         //vprDEBUG(gadgetDBG_RIM,vprDBG_CONFIG_LVL) << "Sending data to: "
         //   << (*i)->getName() << std::endl << vprDEBUG_FLUSH;
         try
         {
            (*i)->send(mDataPacket);
         }
         catch(cluster::ClusterException cluster_exception)
         {
            vprDEBUG(gadgetDBG_RIM,vprDBG_CONFIG_LVL) << "ApplicationDataServer::send() Caught an exception!"
               << std::endl << vprDEBUG_FLUSH;
            vprDEBUG(gadgetDBG_RIM,vprDBG_CONFIG_LVL) << clrSetBOLD(clrRED)
               << cluster_exception.getMessage() << clrRESET
               << std::endl << vprDEBUG_FLUSH;

            vprDEBUG(gadgetDBG_RIM,vprDBG_CONFIG_LVL) <<
               "ApplicationDataServer::send() We have lost our connection to: " << (*i)->getName() << ":" << (*i)->getPort()
               << std::endl << vprDEBUG_FLUSH;

            // If we receive an exception because we have lost the connection we need
            // to flag the Node as disconnected and print debug information
            (*i)->setStatus(gadget::Node::DISCONNECTED);
            debugDump(vprDBG_CONFIG_LVL);
         }
      }
   }

void cluster::ApplicationDataServer::addClient

(

gadget::Node *

new_client_node

)

Add a Node to the list of clients that should receive data for this ApplicationData.

Parameters:

new_client_node

Node that will be added to the list.

Definition at line 133 of file ApplicationDataServer.cpp.

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

   {
      vprASSERT(new_client_node != NULL && "You can not add a new client that is NULL");
      
      // Lock mutex to make this thread safe
      vpr::Guard<vpr::Mutex> guard(mClientsLock);

      mClients.push_back(new_client_node);
   }

void cluster::ApplicationDataServer::removeClient

(

const std::string &

host_name

)

Remove a Node from the list of clients that should receive data for this ApplicationData.

Parameters:

host_name

Hostname of the Node that will be removed from the list.

Definition at line 143 of file ApplicationDataServer.cpp.

   {
      vpr::Guard<vpr::Mutex> guard(mClientsLock);

      for (std::vector<gadget::Node*>::iterator i = mClients.begin() ;
            i!= mClients.end() ; i++)
      {
         if ((*i)->getHostname() == host_name)
         {
            mClients.erase(i);
            return;
         }
      }
   }

void cluster::ApplicationDataServer::debugDump

(

int

debug_level

)

Print information about this ApplicationDataServer to the screen.

Parameters:

debug_level

The debug level that the information will be displayed at.

Definition at line 158 of file ApplicationDataServer.cpp.

References gadgetDBG_RIM(), and getId().

Referenced by serializeAndSend().

   {
      vpr::Guard<vpr::Mutex> guard(mClientsLock);

      vpr::DebugOutputGuard dbg_output(gadgetDBG_RIM,debug_level,
                                 std::string("-------------- ApplicationDataServer --------------\n"),
                                 std::string("------------------------------------------\n"));

      vprDEBUG(gadgetDBG_RIM,debug_level) << "Name:     " << getId().toString() << std::endl << vprDEBUG_FLUSH;

      vpr::DebugOutputGuard dbg_output2(gadgetDBG_RIM,debug_level,
                        std::string("------------ Clients ------------\n"),
                        std::string("---------------------------------\n"));
      for (std::vector<gadget::Node*>::iterator i = mClients.begin() ;
            i!= mClients.end() ; i++)
      {
         vprDEBUG(gadgetDBG_RIM,debug_level) << "-------- " << (*i)->getName() << " --------" << std::endl << vprDEBUG_FLUSH;
         vprDEBUG(gadgetDBG_RIM,debug_level) << "       Hostname: " << (*i)->getHostname() << std::endl << vprDEBUG_FLUSH;
         vprDEBUG(gadgetDBG_RIM,debug_level) << "----------------------------------" << std::endl << vprDEBUG_FLUSH;
      }
   }

vpr::GUID cluster::ApplicationDataServer::getId

(

)

Return the GUID of the ApplicationData that this server is responsible for.

Definition at line 180 of file ApplicationDataServer.cpp.

References cluster::ApplicationData::getId().

Referenced by debugDump().

   { 
      return(mApplicationData->getId()); 
   }

---

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

• ApplicationDataServer.h
• ApplicationDataServer.cpp

---