cluster::RIMPlugin Class Reference

#include <RIMPlugin.h>

Inheritance diagram for cluster::RIMPlugin:

[legend]Collaboration diagram for cluster::RIMPlugin:

[legend]List of all members.

Public Member Functions
	RIMPlugin ()
virtual	~RIMPlugin ()
vpr::GUID	getHandlerGUID ()
	Get the GUID associated with this handler.
void	recoverFromLostNode (gadget::Node *lost_node)
	This function is called when the network losses a connection to a Node.
void	handlePacket (Packet *packet, gadget::Node *node)
	Handle a incoming packet.
virtual void	preDraw ()
	Calls any action needed by this plugin before draw().
virtual void	sendRequests ()
virtual void	postPostFrame ()
	Calls any action needed by this plugin before postFrame().
virtual bool	isPluginReady ()
	Returns the status of RIMPlugin.
virtual std::string	getPluginName ()
	Returns the name of the this plugin.
virtual std::string	getHandlerName ()
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.
jccl::ConfigElementPtr	getConfigElementPointer (std::string &name)

---

Detailed Description

Definition at line 63 of file RIMPlugin.h.

---

Constructor & Destructor Documentation

cluster::RIMPlugin::RIMPlugin

(

)

Definition at line 84 of file RIMPlugin.cpp.

      : mHandlerGUID("9c3fb301-b142-4c6f-8ca3-1570898974d0")
      , mRIM(mHandlerGUID)
   {;}

cluster::RIMPlugin::~RIMPlugin

(

)

[virtual]

Definition at line 89 of file RIMPlugin.cpp.

   {;}

---

Member Function Documentation

vpr::GUID cluster::RIMPlugin::getHandlerGUID

(

)

[inline, virtual]

Get the GUID associated with this handler.

Implements gadget::PacketHandler.

Definition at line 69 of file RIMPlugin.h.

Referenced by configAdd().

   {
      return mHandlerGUID;
   }

void cluster::RIMPlugin::recoverFromLostNode

(

gadget::Node *

lost_node

)

[virtual]

This function is called when the network losses a connection to a Node.

The RIMPlugin needs to handle this by removing all VirtualDevices on the lost node. And removing the node as a client from all DeviceServers.

Implements gadget::PacketHandler.

Definition at line 92 of file RIMPlugin.cpp.

   {
      boost::ignore_unused_variable_warning(lost_node);
      // Since we have lost a connection we need to set a flag so
      // that when we gain a new connection we will reconfigure.
      //setReconfigurationNeededOnConnection(true);
   }

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

Handle a incoming packet.

Implements gadget::PacketHandler.

Definition at line 103 of file RIMPlugin.cpp.

References gadget::RemoteInputManager::handlePacket().

   {
      mRIM.handlePacket(packet, node);
      // We do not handle packets, we are here only to sync.
   }

void cluster::RIMPlugin::preDraw

(

)

[virtual]

Calls any action needed by this plugin before draw().

This function was inherited from the ClusterPlugin abstract class.

Implements cluster::ClusterPlugin.

Definition at line 109 of file RIMPlugin.cpp.

   {
      // Do nothing we are only here to sync.
   }

void cluster::RIMPlugin::sendRequests

(

)

[virtual]

Reimplemented from cluster::ClusterPlugin.

Definition at line 119 of file RIMPlugin.cpp.

References gadget::RemoteInputManager::sendDeviceRequests().

   {
      mRIM.sendDeviceRequests();
   }

void cluster::RIMPlugin::postPostFrame

(

)

[virtual]

Calls any action needed by this plugin before postFrame().

This function was inherited from the ClusterPlugin abstract class.

Implements cluster::ClusterPlugin.

Definition at line 114 of file RIMPlugin.cpp.

References gadget::RemoteInputManager::sendDataAndSync().

   {
      mRIM.sendDataAndSync();
   }

bool cluster::RIMPlugin::isPluginReady

(

)

[virtual]

Returns the status of RIMPlugin.

Returns:

true If plugin is completly configured and has no pending tasks.

Reimplemented from cluster::ClusterPlugin.

Definition at line 234 of file RIMPlugin.cpp.

   {
      //XXX: Fix this to check for any pending devices. We might want to keep a local
      //     copy of this also so that we don't stall when we are waiting for pending
      //     RIM requests that are not in the cluster configuration.

      //vpr::Guard<vpr::Mutex> guard(mPendingDeviceRequestsLock);
      //return(0 == mPendingDeviceRequests.size());
      return true;
   }

virtual std::string cluster::RIMPlugin::getPluginName

(

)

[inline, virtual]

Returns the name of the this plugin.

Implements cluster::ClusterPlugin.

Definition at line 115 of file RIMPlugin.h.

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

virtual std::string cluster::RIMPlugin::getHandlerName

(

)

[inline, virtual]

Implements gadget::PacketHandler.

Definition at line 120 of file RIMPlugin.h.

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

bool cluster::RIMPlugin::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 132 of file RIMPlugin.cpp.

References gadget::RemoteInputManager::addPendingDeviceRequest(), gadgetDBG_RIM(), getHandlerGUID(), and cluster::ClusterPlugin::setActive().

   {
      // XXX: We may still use this to handle the configuration 
      //      of clustered RIM connections.
      if ( ClusterManager::instance()->recognizeRemoteDeviceConfig(element) )
      {
         std::string device_host = element->getProperty<std::string>("device_host");
         gadget::Node* node = ClusterManager::instance()->getNetwork()->getNodeByName(device_host);
         std::string device_name = element->getName();

         vprDEBUG(gadgetDBG_RIM,vprDBG_CONFIG_LVL)
            << clrOutBOLD(clrCYAN,"[RIMPlugin] ")
            << "Adding the Remote Device: " << device_name
            << " to the RIM Pending List"
            << std::endl << vprDEBUG_FLUSH;

         if ( node == NULL )
         {
            vprDEBUG(gadgetDBG_RIM,vprDBG_CONFIG_STATUS_LVL)
               << clrOutBOLD(clrCYAN,"[RIMPlugin] ")
               << clrOutBOLD(clrRED, "WARNING:") << " Cluster node: " << device_host
               << " does not exist, there must be an error in the ClusterDepChecker."
               << std::endl << vprDEBUG_FLUSH;
            return false;
         }
         else if ( !node->isConnected() )
         {
            vprDEBUG(gadgetDBG_RIM,vprDBG_CONFIG_LVL)
               << clrOutBOLD(clrCYAN,"[RIMPlugin] ")
               << clrOutBOLD(clrRED, "WARNING:") << " Cluster node: " << device_host
               << " is not connected, there must be an error in the ClusterDepChecker."
               << std::endl << vprDEBUG_FLUSH;
            return false;
         }

         DeviceRequest* device_req = new DeviceRequest(getHandlerGUID(), device_name);
         mRIM.addPendingDeviceRequest(device_req, node);
         setActive(true);
         return(true);
      }
      else
      {
         vprDEBUG(gadgetDBG_RIM,vprDBG_CRITICAL_LVL)
            << clrOutBOLD(clrCYAN,"[RIMPlugin] ")
            << clrOutBOLD(clrRED, "ERROR: ")
            << "recognizeRemoteDeviceConfig is broken."
            << std::endl << vprDEBUG_FLUSH;
         return(false);
      }
   }

bool cluster::RIMPlugin::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 189 of file RIMPlugin.cpp.

   {
      boost::ignore_unused_variable_warning(element);
      return false;

      // XXX: We may still use this to handle the configuration 
      //      of clustered RIM connections.
      /*
      if ( ClusterManager::instance()->recognizeRemoteDeviceConfig(element) )
      {
         vprDEBUG(gadgetDBG_RIM,vprDBG_CONFIG_LVL) << clrOutBOLD(clrCYAN,"[RIMPlugin] ")
         << "Removing the Remote Device: " << element->getName()
         << " from the active configuration \n" << vprDEBUG_FLUSH;

         removeVirtualDevice(element->getName());
         if ( this->mVirtualDevices.size()== 0 && mDeviceServers.size() == 0 )
         {
            setActive(false);
         }
         return(true);
      }
      else
      {
         vprDEBUG(gadgetDBG_RIM,vprDBG_CONFIG_LVL)
            << "[RIMPlugin::configRemove] ERROR, Something is seriously wrong, we should never get here\n"
            << vprDEBUG_FLUSH;
         return(false);
      }
      */
   }

bool cluster::RIMPlugin::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 227 of file RIMPlugin.cpp.

   {
      // XXX: We may still use this to handle the configuration 
      //      of clustered RIM connections.
      return ClusterManager::instance()->recognizeRemoteDeviceConfig(element);
   }

jccl::ConfigElementPtr cluster::RIMPlugin::getConfigElementPointer

(

std::string &

name

)

---

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

• RIMPlugin.h
• RIMPlugin.cpp

---