exConnInterface.h

Go to the documentation of this file.

/******************************************************************************
** Copyright (c) 2015 MAK Technologies, Inc.
** All rights reserved.
******************************************************************************/

#pragma once

#include <vrvVrl/DtVrlinkDriver.h>
#include <vrfVrlSharedSource/vrfDriver.h>
#include <vrvVrl/DtVrlinkConnection.h>
#include <vl/exerciseConn.h>

//This class manages passing calls and data from the main (display engine) thread
//to the driver thread, which is what is ticking the DtExerciseConnection.
class DtExConnInterface
{
public:
   //Construction is done by the driver thread.
   DtExConnInterface(makVrv::DtVrlinkDriver* driver) 
      : myDriver(driver)
      , myExConn(0)
   {
      makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkConnection* connection =
         dynamic_cast<makVrv::DT_PROTOCOL_NAMESPACE::DtVrlinkConnection*>(driver->connection());
      if (connection)
      {
         myExConn = connection->exerciseConn();
      }
   }

   //These functions may be called from a thread other than the driver thread.
   void sendCommentInteraction(const DtString& data)
   {
      //Queue the execute function to be run by the driver thread.
      //This bind function puts the arguments into the queue as well, which
      //will then be processed by the execute function in the other thread.
      myDriver->queueConnectionFunction(
         boost::bind(&DtExConnInterface::executeSendCommentInteraction, this, data));
   }

   static DtExConnInterface* theExConnInterface;
protected:

   //This is the function will get called in the driver thread, and can
   //make the normal calls on the exercise connection.
   void executeSendCommentInteraction(DtString commentString);

   makVrv::DtVrlinkDriver* myDriver;
   DtExerciseConn* myExConn;
};