IODataManager.h

Go to the documentation of this file.

/***********************************************************************************\
* (c) Copyright 1998-2025 CERN for the benefit of the LHCb and ATLAS collaborations *
*                                                                                   *
* This software is distributed under the terms of the Apache version 2 licence,     *
* copied verbatim in the file "LICENSE".                                            *
*                                                                                   *
* In applying this licence, CERN does not waive the privileges and immunities       *
* granted to it by virtue of its status as an Intergovernmental Organization        *
* or submit itself to any jurisdiction.                                             *
\***********************************************************************************/
#pragma once
 
// C++ include files
#include <map>
// Framework include files
#include <GaudiKernel/Service.h>
#include <GaudiUtils/IIODataManager.h>
 
class IIncidentSvc;
 
/*
 *  LHCb namespace declaration
 */
namespace Gaudi {
 
  // Forward declarations
  class IFileCatalog;
  class RawDataConnectionEntry;
 
  class IODataManager : public extends<Service, IIODataManager> {
  protected:
    typedef const std::string& CSTR;
    struct Entry               final {
      std::string      type;
      IoType           ioType;
      IDataConnection* connection;
      bool             keepOpen;
      Entry( CSTR tech, bool k, IoType iot, IDataConnection* con )
          : type( tech ), ioType( iot ), connection( con ), keepOpen( k ) {}
    };
    typedef std::map<std::string, Entry*>      ConnectionMap;
    typedef std::map<std::string, std::string> FidMap;
 
    Gaudi::Property<std::string> m_catalogSvcName{ this, "CatalogType", "Gaudi::MultiFileCatalog/FileCatalog",
                                                   "name of the file catalog service" };
    Gaudi::Property<bool>        m_useGFAL{ this, "UseGFAL", true, "flag for auto gfal data access" };
    Gaudi::Property<bool>        m_quarantine{ this, "QuarantineFiles", true,
                                        "if unaccessible files should be quarantines in job" };
    Gaudi::Property<int>         m_ageLimit{ this, "AgeLimit", 2, "age limit" };
    Gaudi::Property<bool>        m_disablePFNWarning{
        this, "DisablePFNWarning", false,
        "if set to True,  we will not report when a file is opened by its physical name" };
 
    ConnectionMap m_connectionMap;
    SmartIF<IFileCatalog> m_catalog;
    FidMap     m_fidMap;
    StatusCode connectDataIO( int typ, IoType rw, CSTR fn, CSTR technology, bool keep, Connection* con );
    StatusCode reconnect( Entry* e );
    StatusCode error( CSTR msg );
    StatusCode establishConnection( Connection* con );
 
    SmartIF<IIncidentSvc> m_incSvc; 
 
  public:
    using extends::extends;
 
    StatusCode initialize() override;
 
    StatusCode finalize() override;
 
    StatusCode connectRead( bool keep_open, Connection* ioDesc ) override;
    StatusCode connectWrite( Connection* con, IoType mode = Connection::CREATE, CSTR doctype = "UNKNOWN" ) override;
    StatusCode disconnect( Connection* ioDesc ) override;
    Connection* connection( const std::string& dsn ) const override;
    Connections connections( const IInterface* owner ) const override;
    StatusCode read( Connection* ioDesc, void* const data, size_t len ) override;
    StatusCode write( Connection* con, const void* data, int len ) override;
    long long int seek( Connection* ioDesc, long long int where, int origin ) override;
  };
} // End namespace Gaudi