ConnectionManager.hpp

Go to the documentation of this file.

/*
---------------------------------------------------------------------------
 
    This file is part of uHAL.
 
    uHAL is a hardware access library and programming framework
    originally developed for upgrades of the Level-1 trigger of the CMS
    experiment at CERN.
 
    uHAL is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.
 
    uHAL is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.
 
    You should have received a copy of the GNU General Public License
    along with uHAL.  If not, see <http://www.gnu.org/licenses/>.
 
 
      Andrew Rose, Imperial College, London
      email: awr01 <AT> imperial.ac.uk
 
      Marc Magrans de Abril, CERN
      email: marc.magrans.de.abril <AT> cern.ch
 
---------------------------------------------------------------------------
*/
 
#ifndef _uhal_ConnectionManager_hpp_
#define _uhal_ConnectionManager_hpp_
 
 
#include <map>
#include <set>
#include <unordered_map>
#include <vector>
 
#include <boost/filesystem/path.hpp>
 
#include "uhal/log/exception.hpp"
#include "uhal/HwInterface.hpp"
 
 
// Forward declarations
namespace pugi
{
  class xml_node;
}
 
namespace boost
{
  class mutex;
}
 
 
namespace uhal
{
  namespace exception
  {
    UHAL_DEFINE_EXCEPTION_CLASS ( DuplicatedUID , "Exception class to handle the case where the supposedly unique ID is duplicated." )
    UHAL_DEFINE_EXCEPTION_CLASS ( ConnectionUIDDoesNotExist , "Exception class to handle the case where the UID requested does not exists in the map of connections." )
  }
 
  class ConnectionManager
  {
    public:
      struct ConnectionDescriptor
      {
        ConnectionDescriptor ( const pugi::xml_node& aNode , const boost::filesystem::path& aConnectionFile , bool& aSuccess );
 
        bool operator== ( const ConnectionDescriptor& aConnectionDescriptor ) const;
 
        std::string id;
        std::string uri;
        std::string address_table;
        boost::filesystem::path connection_file;
      };
 
    public:
 
      ConnectionManager(const ConnectionManager&) = delete;
      ConnectionManager& operator=(const ConnectionManager&) = delete;
 
      ConnectionManager ( const std::string& aFilenameExpr );
 
      ConnectionManager ( const std::string& aFilenameExpr , const std::vector<std::string>& aUserClientActivationList );
 
      virtual ~ConnectionManager ();
 
      HwInterface getDevice ( const std::string& aId );
 
      std::vector<std::string> getDevices ( ) const;
 
      std::vector<std::string> getDevices ( const std::string& aRegex ) const;
 
      static HwInterface getDevice ( const std::string& aId , const std::string& aUri , const std::string& aAddressFileExpr );
 
      static HwInterface getDevice ( const std::string& aId , const std::string& aUri , const std::string& aAddressFileExpr , const std::vector<std::string>& aUserClientActivationList );
 
      static void clearAddressFileCache();
 
    private:
      static std::mutex mMutex;
 
      void CallBack ( const std::string& aProtocol , const boost::filesystem::path& aPath , std::vector<uint8_t>& aFile );
 
      const std::vector<std::string> mUserClientActivationList;
 
      std::map< std::string, ConnectionDescriptor >  mConnectionDescriptors;    //connection identifier, parsed descriptor (also contains the connection identifier)
 
      std::set< std::string > mPreviouslyOpenedFiles;
  };
 
}
 
#endif