IDbContainer.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2025 CERN for the benefit of the ATLAS collaboration
*/
 
//
//  Package    : pool/StorageSvc (The pool framework)
//
//  @author      M.Frank
//
//====================================================================
#ifndef POOL_IDBCONTAINER_H
#define POOL_IDBCONTAINER_H
 
// Framework include files
#include "PersistentDataModel/Token.h"
#include "StorageSvc/pool.h"
#include "StorageSvc/Transaction.h"
 
#include <vector>
#include <cstdint>
 
/*
 *   POOL namespace declaration
 */
namespace pool    {
 
  // Forward declarations
  class DbTypeInfo;
  class DbDatabase;
  class DbContainer;
  class DbOption;
 
  typedef const class Shape        *ShapeH;

  class IDbContainer    {
  protected:
    virtual ~IDbContainer()   {     }
 
  public:
    virtual void release() = 0;
    virtual uint64_t size() = 0;
    virtual std::string name() const = 0;
    virtual StatusCode setOption(const DbOption& refOpt) = 0;
    virtual StatusCode getOption(DbOption& refOpt) = 0;
    virtual StatusCode store(const void* object,
                             DbContainer&  cntH,
                             ShapeH shape) = 0;
    virtual StatusCode allocate(DbContainer& cntH,
                                const void* object,
                                ShapeH shape,
                                Token::OID_t& oid) = 0;

    virtual uint64_t nextRecordId() = 0;
    virtual void useNextRecordId(uint64_t) = 0;

    virtual StatusCode close() = 0;
    virtual StatusCode open( DbDatabase&        dbH, 
                             const std::string& nam, 
                             const DbTypeInfo* info, 
                             DbAccessMode mode) = 0;
    virtual StatusCode checkAccess(DbDatabase&        dbH,
                                 const std::string& nam) const = 0;
    virtual StatusCode next(Token::OID_t& linkH) = 0;


    virtual StatusCode load( void** ptr, ShapeH shape,
                           const Token::OID_t& lnkH,
                           Token::OID_t&       oid,
                           bool                any_next=false) = 0;

    virtual StatusCode transAct(Transaction::Action) = 0;
  };
}      // End namespace pool
#endif // POOL_IDBCONTAINER_H