cluster::ApplicationDataManager Class Reference

#include <ApplicationDataManager.h>

Inheritance diagram for cluster::ApplicationDataManager:

[legend]Collaboration diagram for cluster::ApplicationDataManager:

[legend]List of all members.

Public Member Functions
	ApplicationDataManager ()
virtual	~ApplicationDataManager ()
vpr::GUID	getHandlerGUID ()
	Get the GUID associated with this plugin.
void	handlePacket (Packet *packet, gadget::Node *node)
	Handle a incoming packet.
virtual void	preDraw ()
	Called each frame by the kernel to update all application level data(ApplicationData).
virtual void	postPostFrame ()
	Called each frame by the kernel to update the cluster after the InputManager has updated it's data.
virtual void	sendRequests ()
	Send all pending requests for ApplicationData to other Nodes.
virtual bool	isPluginReady ()
	Is this ClusterPlugin ready for the cluster to start the application.
virtual std::string	getPluginName ()
	Return the name of this ClusterPlugin.
virtual std::string	getHandlerName ()
virtual void	recoverFromLostNode (gadget::Node *lost_node)
	Virtual function used to inform all handlers that the network has lost its connection to the given Node.
bool	configAdd (jccl::ConfigElementPtr element)
	Add the pending element to the configuration.
bool	configRemove (jccl::ConfigElementPtr element)
	Remove the pending element from the current configuration.
bool	configCanHandle (jccl::ConfigElementPtr element)
	Checks if this handler can process element.
virtual void	addSerializableObject (vpr::SerializableObject *object)
	Add a ApplicationData object to the current configuration.
void	removeApplicationData (ApplicationData *old_user_data)
	Remove the ApplicationData object from the current configuration.
void	dumpApplicationData ()
	Print a list of all ApplicationData objects currently in the configuration.

---

Detailed Description

Definition at line 56 of file ApplicationDataManager.h.

---

Constructor & Destructor Documentation

cluster::ApplicationDataManager::ApplicationDataManager

(

)

Definition at line 74 of file ApplicationDataManager.cpp.

      : mHandlerGUID("cc6ca39f-03f2-4779-aa4b-048f774ff9a5")
      , mFrameNumber(0)
   {;}

cluster::ApplicationDataManager::~ApplicationDataManager

(

)

[virtual]

Definition at line 79 of file ApplicationDataManager.cpp.

   {;}

---

Member Function Documentation

vpr::GUID cluster::ApplicationDataManager::getHandlerGUID

(

)

[inline, virtual]

Get the GUID associated with this plugin.

Implements gadget::PacketHandler.

Definition at line 68 of file ApplicationDataManager.h.

Referenced by addSerializableObject(), configAdd(), and handlePacket().

   {
      return mHandlerGUID;
   }

void cluster::ApplicationDataManager::handlePacket	(	Packet *	packet,
		gadget::Node *	node
	)			[virtual]

Handle a incoming packet.

Implements gadget::PacketHandler.

Definition at line 90 of file ApplicationDataManager.cpp.

References cluster::ApplicationDataServer::addClient(), gadgetDBG_RIM(), cluster::ApplicationDataAck::getAck(), getHandlerGUID(), cluster::ApplicationDataAck::getId(), cluster::ApplicationDataRequest::getId(), cluster::Packet::getPacketType(), cluster::Header::RIM_APPDATA_ACK, cluster::Header::RIM_APPDATA_REQ, cluster::Header::RIM_DATA_PACKET, and gadget::Node::send().

   {
      if ( NULL != packet && NULL != node )
      {
         switch ( packet->getPacketType() )
         {
         case cluster::Header::RIM_DATA_PACKET:
         {
            DataPacket* temp_data_packet = dynamic_cast<DataPacket*>(packet);
            vprASSERT(NULL != temp_data_packet && "Dynamic cast failed!");

            // Find the ApplicationData Object that we have received data
            // for.
            ApplicationData* user_data =
               getRemoteApplicationData(temp_data_packet->getObjectId());
            if (user_data != NULL)
            {
               // Create a object reader to parse the object's data with
               vpr::BufferObjectReader* temp_reader =
                  new vpr::BufferObjectReader(temp_data_packet->getDeviceData());

               // Parse the object's data using the temporary ObjectReader
               user_data->readObject(temp_reader);
            }
            break;
         }
         case cluster::Header::RIM_APPDATA_REQ:
         {
            ApplicationDataRequest* temp_request =
               dynamic_cast<ApplicationDataRequest*>(packet);
            vprASSERT(NULL != temp_request && "Dynamic cast failed!");

            // Find the ApplicationDataServer that is serving the data for
            // this requested object.
            ApplicationDataServer* temp_app_data_server =
               getApplicationDataServer(temp_request->getId());
            ApplicationDataAck* temp_ack(NULL);

            // -If a ApplicationDataServer for this object exists
            //   -Add the requesting node as a client
            //   -Respond with an ACK
            // -Else
            //   -Respond with an NACK
            // -Free the memory used be the ACK/NACK

            if (temp_app_data_server != NULL)
            {
               temp_app_data_server->addClient(node);
               temp_ack = new ApplicationDataAck(getHandlerGUID(),
                                                 temp_request->getId(), true);
            }
            else
            {
               temp_ack = new ApplicationDataAck(getHandlerGUID(),
                                                 temp_request->getId(), false);
            }
            node->send(temp_ack);
            delete temp_ack;
            break;
         }
         case cluster::Header::RIM_APPDATA_ACK:
         {
            ApplicationDataAck* temp_ack =
               dynamic_cast<ApplicationDataAck*>(packet);
            vprASSERT(NULL != temp_ack && "Dynamic cast failed!");

            // -If we received an ACK
            //   -Remove the coresponding ApplicationDataRequest from the
            //    pending list
            if (temp_ack->getAck())
            {
               removePendingApplicationDataRequest(temp_ack->getId());
            }
            break;
         }
         default:
            vprDEBUG(gadgetDBG_RIM,vprDBG_WARNING_LVL)
               << clrOutBOLD(clrCYAN,"[ApplicationDataManager] ")
               << "Don't know how to handle a packet of type: "
               << packet->getPacketType() << std::endl << vprDEBUG_FLUSH;
            break;
         } // End switch
      } // End if
   }

void cluster::ApplicationDataManager::preDraw

(

)

[virtual]

Called each frame by the kernel to update all application level data(ApplicationData).

Implements cluster::ClusterPlugin.

Definition at line 337 of file ApplicationDataManager.cpp.

References gadgetDBG_RIM().

   {
      //mFrameNumber++;

      // Send ApplicationData
      vprDEBUG(gadgetDBG_RIM, vprDBG_HVERB_LVL)
         << clrOutBOLD(clrMAGENTA,"[ApplicationDataManager::preDraw()]")
         << "Sending ApplicationData.\n" << vprDEBUG_FLUSH;

      vpr::Guard<vpr::Mutex> guard(mApplicationDataServersLock);

      std::map<vpr::GUID, ApplicationDataServer*>::iterator application_data_servers_begin = mApplicationDataServers.begin();
      std::map<vpr::GUID, ApplicationDataServer*>::iterator application_data_servers_end = mApplicationDataServers.end();

      // For each ApplicationDataServer on this node, serialize the data and send it to each of it's clients.
      for (std::map<vpr::GUID, ApplicationDataServer*>::iterator i = application_data_servers_begin;
           i != application_data_servers_end;
           ++i)
      {
       (*i).second->serializeAndSend();
      }
   }

void cluster::ApplicationDataManager::postPostFrame

(

)

[virtual]

Called each frame by the kernel to update the cluster after the InputManager has updated it's data.

Implements cluster::ClusterPlugin.

Definition at line 334 of file ApplicationDataManager.cpp.

   {;}

void cluster::ApplicationDataManager::sendRequests

(

)

[virtual]

Send all pending requests for ApplicationData to other Nodes.

Reimplemented from cluster::ClusterPlugin.

Definition at line 360 of file ApplicationDataManager.cpp.

References gadget::Node::CONNECTED, gadget::Node::NEWCONNECTION, and gadget::Node::PENDING.

   {
      // Send ApplicationData Requests
      vpr::Guard<vpr::Mutex> guard(mPendingApplicationDataRequestsLock);

      std::map<ApplicationDataRequest*, std::string>::iterator begin = mPendingApplicationDataRequests.begin();
      std::map<ApplicationDataRequest*, std::string>::iterator end   = mPendingApplicationDataRequests.end();
      std::map<ApplicationDataRequest*, std::string>::iterator i;

      // For each pending ApplicationData request
      for (i = begin ; i != end ; ++i)
      {
         // Get the Node that the request is for.
         gadget::Node* temp_node =
            ClusterManager::instance()->getNetwork()->getNodeByHostname((*i).second);

         // If the node exists in the ClusterNetwork
         if (temp_node != NULL)
         {
            // If the Node is connected
            if ( gadget::Node::CONNECTED == temp_node->getStatus() || 
                 gadget::Node::NEWCONNECTION == temp_node->getStatus() )
            {
               // Send the request
               temp_node->send((*i).first);
            }
            else
            {
               // Else add the Node to the list of pending Nodes so that we
               // will connect to it.
               temp_node->setStatus(gadget::Node::PENDING);
            } // End if
         } // End if
      } // End for
   }

bool cluster::ApplicationDataManager::isPluginReady

(

)

[virtual]

Is this ClusterPlugin ready for the cluster to start the application.

Reimplemented from cluster::ClusterPlugin.

Definition at line 82 of file ApplicationDataManager.cpp.

   {
      // This plugin will be ready when it does not have any more
      // PendingApplicationDataRequests
      vpr::Guard<vpr::Mutex> guard(mPendingApplicationDataRequestsLock);
      return(0 == mPendingApplicationDataRequests.size());
   }

virtual std::string cluster::ApplicationDataManager::getPluginName

(

)

[inline, virtual]

Return the name of this ClusterPlugin.

Implements cluster::ClusterPlugin.

Definition at line 101 of file ApplicationDataManager.h.

   {
      return(std::string("ApplicationDataManager"));
   }

virtual std::string cluster::ApplicationDataManager::getHandlerName

(

)

[inline, virtual]

Implements gadget::PacketHandler.

Definition at line 105 of file ApplicationDataManager.h.

   {
      return(std::string("ApplicationDataManager"));
   }

virtual void cluster::ApplicationDataManager::recoverFromLostNode

(

gadget::Node *

lost_node

)

[inline, virtual]

Virtual function used to inform all handlers that the network has lost its connection to the given Node.

Implements gadget::PacketHandler.

Definition at line 110 of file ApplicationDataManager.h.

   {
      boost::ignore_unused_variable_warning(lost_node);
   }

bool cluster::ApplicationDataManager::configAdd

(

jccl::ConfigElementPtr

element

)

[virtual]

Add the pending element to the configuration.

Precondition:

configCanHandle (element) == true.

Returns:

true iff element was successfully added to configuration.

Implements cluster::ClusterPlugin.

Definition at line 184 of file ApplicationDataManager.cpp.

References gadgetDBG_RIM(), getHandlerGUID(), and gadget::AbstractNetworkManager::isLocalHost().

   {
      if (recognizeApplicationDataManagerConfig(element))
      {
         vprDEBUG(gadgetDBG_RIM,vprDBG_WARNING_LVL)
            << clrOutBOLD(clrCYAN,"[ApplicationDataManager] ")
            << "The ApplicationDataMananger does not currently support a "
            << "need for configuration element: " << element->getName()
            << "\n" << vprDEBUG_FLUSH;
         return(true);
      }
      else if (recognizeApplicationDataConfig(element))
      {
         std::string guid_string = element->getProperty<std::string>("guid");
         vpr::GUID guid(guid_string);
         std::string hostname = element->getProperty<std::string>("hostname");

         vpr::Guard<vpr::Mutex> guard(mNeedsConfigedLock);
         std::vector<ApplicationData*>::iterator begin = mNeedsConfiged.begin();
         std::vector<ApplicationData*>::iterator end = mNeedsConfiged.end();
         std::vector<ApplicationData*>::iterator i;

         for (i = begin ; i != end ; ++i)
         {
            if ((*i)->getId() == guid)
            {
               vprDEBUG(gadgetDBG_RIM,vprDBG_CONFIG_LVL)
                  << "[ApplicationDataManager::configAdd()] "
                  << "Configuring ApplicationData object " << guid.toString()
                  << " on host: " << hostname << std::endl << vprDEBUG_FLUSH;

               (*i)->setHostname(hostname);

               if (ClusterNetwork::isLocalHost(hostname))
               {
                  // This application data is local.
                  (*i)->setIsLocal(true);

                  // Adding a new ApplicationData server.
                  vpr::Guard<vpr::Mutex> guard(mApplicationDataServersLock);
                  ApplicationDataServer* new_appdata_server =
                     new ApplicationDataServer(guid, (*i), mHandlerGUID);
                  mApplicationDataServers[guid] = new_appdata_server;
               }
               else
               {
                  // This application data is not local.
                  (*i)->setIsLocal(false);

                  // Create a ApplicationDataRequest.
                  ApplicationDataRequest* new_appdata_req =
                     new ApplicationDataRequest(getHandlerGUID(), guid);

                  // Add ApplicationData request to pending list.
                  addPendingApplicationDataRequest(new_appdata_req, hostname);

                  // Add ApplicationData to Remote Vector.
                  vpr::Guard<vpr::Mutex> guard(mRemoteApplicationDataLock);
                  mRemoteApplicationData[guid] = (*i);
               }
            }
            mNeedsConfiged.erase(i);
            return true;
         }

         vprDEBUG(gadgetDBG_RIM, vprDBG_CONFIG_LVL)
            << "[ApplicationDataManager::configAdd()] "
            << "No unconfigured ApplicationData object found"
            << std::endl << vprDEBUG_FLUSH;

         return false;
      }
      else
      {
         vprDEBUG(gadgetDBG_RIM,vprDBG_WARNING_LVL)
            << "[ApplicationDataManager::configAdd()] "
            << clrOutBOLD(clrRED, "WARNING: ")
            << "Don't know how to handle the configuration element: "
            << element->getName() << std::endl << vprDEBUG_FLUSH;
         return(false);
      }
   }

bool cluster::ApplicationDataManager::configRemove

(

jccl::ConfigElementPtr

element

)

[virtual]

Remove the pending element from the current configuration.

Precondition:

configCanHandle (element) == true.

Returns:

true iff the element (and any objects it represented) were successfully removed.

Implements cluster::ClusterPlugin.

Definition at line 273 of file ApplicationDataManager.cpp.

References gadgetDBG_RIM().

   {
      if (recognizeApplicationDataManagerConfig(element))
      {
         vprDEBUG(gadgetDBG_RIM,vprDBG_WARNING_LVL)
            << clrOutBOLD(clrCYAN,"[ApplicationDataManager] ")
            << "The ApplicationDataMananger does not currently support a "
            << "need for configuration element: " << element->getName()
            << "\n" << vprDEBUG_FLUSH;
         return(true);
      }
      else if (recognizeApplicationDataManagerConfig(element))
      {
         vprDEBUG(gadgetDBG_RIM,vprDBG_WARNING_LVL)
            << clrOutBOLD(clrCYAN,"[ApplicationDataManager] ")
            << "The ApplicationDataMananger does not currently support a "
            << "need for configuration element: " << element->getName()
            << "\n" << vprDEBUG_FLUSH;
         return(true);
      }
      else
      {
         vprDEBUG(gadgetDBG_RIM,vprDBG_WARNING_LVL)
            << "[ApplicationDataManager::ConfigRemove()] "
            << clrOutBOLD(clrRED, "WARNING: ")
            << "Don't know how to handle the configuration element: "
            << element->getName() << std::endl << vprDEBUG_FLUSH;
         return(false);
      }
   }

bool cluster::ApplicationDataManager::configCanHandle

(

jccl::ConfigElementPtr

element

)

[virtual]

Checks if this handler can process element.

Typically, an implementation of handler will check the element's description name/token to decide if it knows how to deal with it.

Returns:

true iff this handler can process element.

Implements cluster::ClusterPlugin.

Definition at line 310 of file ApplicationDataManager.cpp.

   {
      return( recognizeApplicationDataManagerConfig(element) ||
              recognizeApplicationDataConfig(element) );
   }

void cluster::ApplicationDataManager::addSerializableObject

(

vpr::SerializableObject *

object

)

[virtual]

Add a ApplicationData object to the current configuration.

Precondition:

This should only be called by the ApplicationData constructor

Reimplemented from cluster::ClusterPlugin.

Definition at line 448 of file ApplicationDataManager.cpp.

References gadgetDBG_RIM(), getHandlerGUID(), cluster::ApplicationData::getHostname(), cluster::ApplicationData::getId(), gadget::AbstractNetworkManager::isLocalHost(), cluster::ClusterPlugin::setActive(), and cluster::ApplicationData::setIsLocal().

   {
      ApplicationData* new_app_data = static_cast<ApplicationData*>(object);

      vpr::GUID id = new_app_data->getId();
      std::string hostname = new_app_data->getHostname();

      vprDEBUG(gadgetDBG_RIM,vprDBG_CONFIG_LVL)
         << clrOutBOLD(clrMAGENTA,"[ApplicationDataManager]")
         << " Adding ApplicationData: " << id.toString()
         << std::endl << vprDEBUG_FLUSH;

      // This plugin is now being used(active)
      setActive(true);

      if ("" == hostname)
      {
         vpr::Guard<vpr::Mutex> guard(mNeedsConfigedLock);
         mNeedsConfiged.push_back(new_app_data);
      }
      else
      {
         if (ClusterNetwork::isLocalHost(hostname))
         {
            // This application data is local.
            new_app_data->setIsLocal(true);

            // Adding a new ApplicationData server.
            vpr::Guard<vpr::Mutex> guard(mApplicationDataServersLock);
            ApplicationDataServer* new_appdata_server = new ApplicationDataServer(id, new_app_data, mHandlerGUID);
            mApplicationDataServers[id] = new_appdata_server;
         }
         else
         {
            // This application data is not local.
            new_app_data->setIsLocal(false);

            // Create a ApplicationDataRequest.
            ApplicationDataRequest* new_appdata_req = new ApplicationDataRequest(getHandlerGUID() ,id);

            // Add ApplicationData request to pending list.
            addPendingApplicationDataRequest(new_appdata_req, hostname);

            // Add ApplicationData to Remote Vector.
            vpr::Guard<vpr::Mutex> guard(mRemoteApplicationDataLock);
            mRemoteApplicationData[id] = new_app_data;
         }
      }
   }

void cluster::ApplicationDataManager::removeApplicationData

(

ApplicationData *

old_user_data

)

Remove the ApplicationData object from the current configuration.

Precondition:

This should only be called by the ApplicationData destructor

Definition at line 498 of file ApplicationDataManager.cpp.

References gadgetDBG_RIM(), cluster::ApplicationData::getHostname(), and cluster::ApplicationData::getId().

   {
      vpr::GUID id = old_app_data->getId();
      std::string hostname = old_app_data->getHostname();

      vprDEBUG(gadgetDBG_RIM,vprDBG_CONFIG_LVL)
         << clrOutBOLD(clrMAGENTA,"[ApplicationDataManager]")
         << " Removing ApplicationData: " << id.toString()
         << std::endl << vprDEBUG_FLUSH;

      // Remove Pending ApplicationData
      removePendingApplicationDataRequest(old_app_data->getId());
      /*
      // Remove Active ApplicationData
      vpr::Guard<vpr::Mutex> guard(mApplicationDataLock);
      for (std::vector<cluster::ApplicationData*>::iterator i = mApplicationData.begin();
           i != mApplicationData.end();
           ++i)
      {
         if ((*i) == old_user_data)
         {
            mApplicationData.erase(i);
            return;
         }
      }
      */
   }

void cluster::ApplicationDataManager::dumpApplicationData

(

)

Print a list of all ApplicationData objects currently in the configuration.

Definition at line 526 of file ApplicationDataManager.cpp.

References gadgetDBG_RIM().

   {
      vprDEBUG(gadgetDBG_RIM,vprDBG_CONFIG_LVL)
         << clrOutBOLD(clrMAGENTA,"[ApplicationDataManager]")
         << " Listing All Application Level ApplicationData"
         << std::endl << vprDEBUG_FLUSH;

      vpr::Guard<vpr::Mutex> ads_guard(mApplicationDataServersLock);

      std::map<vpr::GUID, ApplicationDataServer*>::iterator ads_begin =
         mApplicationDataServers.begin();
      std::map<vpr::GUID, ApplicationDataServer*>::iterator ads_end =
         mApplicationDataServers.end();
      std::map<vpr::GUID, ApplicationDataServer*>::iterator ads;

      vprDEBUG(gadgetDBG_RIM,vprDBG_CONFIG_LVL)
         << "ApplicationDataServers:" << std::endl << vprDEBUG_FLUSH;

      for (ads = ads_begin ; ads != ads_end ; ++ads)
      {
         vprDEBUG(gadgetDBG_RIM,vprDBG_CONFIG_LVL)
            << "     Server: " << (*ads).first << std::endl << vprDEBUG_FLUSH;
      }

      vpr::Guard<vpr::Mutex> rad_guard(mRemoteApplicationDataLock);

      std::map<vpr::GUID, ApplicationData*>::iterator rad_begin =
        mRemoteApplicationData.begin();
      std::map<vpr::GUID, ApplicationData*>::iterator rad_end =
        mRemoteApplicationData.end();
      std::map<vpr::GUID, ApplicationData*>::iterator rad;

      vprDEBUG(gadgetDBG_RIM,vprDBG_CONFIG_LVL)
        << "Remote ApplicationData Objects:" << std::endl << vprDEBUG_FLUSH;

      for (rad = rad_begin ; rad != rad_end ; ++rad)
      {
         vprDEBUG(gadgetDBG_RIM,vprDBG_CONFIG_LVL)
            << "Hostname: " << (*rad).second->getHostname()
            << "GUID: " << (*rad).second->getId()
            << std::endl << vprDEBUG_FLUSH;
      }
   }

---

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

• ApplicationDataManager.h
• ApplicationDataManager.cpp

---