Transport.h

Go to the documentation of this file.

// $Id: Transport.h 3862 2018-05-11 10:06:18Z linev $
 
/************************************************************
 * The Data Acquisition Backbone Core (DABC)                *
 ************************************************************
 * Copyright (C) 2009 -                                     *
 * GSI Helmholtzzentrum fuer Schwerionenforschung GmbH      *
 * Planckstr. 1, 64291 Darmstadt, Germany                   *
 * Contact:  http://dabc.gsi.de                             *
 ************************************************************
 * This software can be used under the GPL license          *
 * agreements as stated in LICENSE.txt file                 *
 * which is part of the distribution.                       *
 ************************************************************/
 
#ifndef DABC_Transport
#define DABC_Transport
 
#ifndef DABC_ModuleAsync
#include "dabc/ModuleAsync.h"
#endif
 
#ifndef DABC_Device
#include "dabc/Device.h"
#endif
 
namespace dabc {
 
   extern const unsigned AcknoledgeQueueLength;
 
   class Transport : public ModuleAsync {
 
      friend class Device;
 
      protected:
         enum ETransportState {
            stInit,         
            stRunning,      
            stStopped,      
            stError         
         };
 
         DeviceRef        fTransportDevice;    
         ETransportState  fTransportState;
         bool             fIsInputTransport;
         bool             fIsOutputTransport;
         std::string      fTransportInfoName;
         double           fTransportInfoInterval;
         TimeStamp        fTransportInfoTm;
 
         ETransportState GetTransportState() const { return fTransportState; }
 
         bool isTransportRunning() const { return GetTransportState() == stRunning; }
         bool isTransportError() const { return GetTransportState() == stError; }
 
         virtual void ProcessConnectionActivated(const std::string &name, bool on);
 
         virtual void ProcessConnectEvent(const std::string &name, bool on);
 
         virtual int ExecuteCommand(Command cmd);
 
         bool InfoExpected() const;
 
         virtual void ModuleCleanup();
 
         virtual void TransportCleanup() {}
 
         void ProvideInfo(int lvl, const std::string &info);
 
         static std::string MakeName(const PortRef& inpport, const PortRef& outport);
 
      public:
         virtual const char* ClassName() const { return "Transport"; }
 
         Transport(dabc::Command cmd, const PortRef& inpport = 0, const PortRef& outport = 0);
         virtual ~Transport();
 
         virtual bool StartTransport();
         virtual bool StopTransport();
 
         bool IsInputTransport() const { return fIsInputTransport; }
         bool IsOutputTransport() const { return fIsOutputTransport; }
 
         // method must be called from the transport thread
         virtual void CloseTransport(bool witherr = false);
   };
 
   // __________________________________________________
 
 
   class TransportRef : public ModuleAsyncRef {
      DABC_REFERENCE(TransportRef, ModuleAsyncRef, Transport)
 
      PortRef OutputPort() { return (GetObject() && GetObject()->IsInputTransport()) ? FindPort("Output") : PortRef(); }
 
      PortRef InputPort() { return (GetObject() && GetObject()->IsOutputTransport()) ? FindPort("Input") : PortRef(); }
   };
 
};
 
#endif