IIODataManager.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
 
// Framework include files
#include <GaudiKernel/IInterface.h>
 
// C++ include files
#include <string>
#include <vector>
 
/*
 *  LHCb namespace declaration
 */
namespace Gaudi {

  class GAUDI_API IDataConnection {
  protected:
    std::string m_name;
    std::string m_fid;
    std::string m_pfn;
    int m_age = 0;
    const IInterface* m_owner = nullptr;
 
  public:
    enum IoType { READ = 1 << 1, UPDATE = 1 << 2, CREATE = 1 << 3, RECREATE = ( 1 << 4 ) + ( 1 << 3 ) };
    enum IoStatus { BAD_DATA_CONNECTION = 4 };
 
  public:
    IDataConnection( const IInterface* own, std::string nam ) : m_name( std::move( nam ) ), m_owner( own ) {}
    virtual ~IDataConnection() = default;
    const std::string& name() const { return m_name; }
    void setFID( std::string fid ) { m_fid = std::move( fid ); }
    const std::string& fid() const { return m_fid; }
    const std::string& pfn() const { return m_pfn; }
    void setPFN( std::string fn ) { m_pfn = std::move( fn ); }
    int ageFile() { return ++m_age; }
    void resetAge() { m_age = 0; }
    int age() const { return m_age; }
    const IInterface* owner() const { return m_owner; }
    virtual StatusCode connectRead() = 0;
    virtual StatusCode connectWrite( IoType type ) = 0;
    virtual StatusCode disconnect() = 0;
    virtual bool isConnected() const = 0;
    virtual StatusCode read( void* const data, size_t len ) = 0;
    virtual StatusCode write( const void* data, int len ) = 0;
    virtual long long int seek( long long int where, int origin ) = 0;
  };

  class GAUDI_API IIODataManager : virtual public IInterface {
  public:
    DeclareInterfaceID( IIODataManager, 2, 0 );

    typedef IDataConnection          Connection;
    typedef std::vector<Connection*> Connections;
    typedef Connection::IoType       IoType;
    enum FileType { UNKNOWN = 1, PFN, LFN, FID };

    virtual StatusCode connectRead( bool keep_open, IDataConnection* con ) = 0;
    virtual StatusCode connectWrite( IDataConnection* con, IoType mode = Connection::CREATE,
                                     const std::string& doctype = "UNKNOWN" ) = 0;
    virtual StatusCode disconnect( IDataConnection* con ) = 0;
    virtual Connection* connection( const std::string& dsn ) const = 0;
    virtual Connections connections( const IInterface* owner ) const = 0;
    virtual StatusCode read( IDataConnection* con, void* const data, size_t len ) = 0;
    virtual StatusCode write( IDataConnection* con, const void* data, int len ) = 0;
    virtual long long int seek( IDataConnection* con, long long int where, int origin ) = 0;
  };
} // End namespace Gaudi