IStorageSvc.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2025 CERN for the benefit of the ATLAS collaboration
*/
 
#ifndef POOL_ISTORAGESVC_H
#define POOL_ISTORAGESVC_H
 
// Framework include files
#include "StorageSvc/Transaction.h"
 
// STL include files
#include <string>
 
// Forward declarations
class Guid;
class Token;
class StatusCode;
 
/*
 *     pool namespace declaration
 */
namespace pool  {
 
  // Forward declarations
  class FileDescriptor;
  class DbOption;
 
  typedef class Session            *SessionH;
  typedef class DatabaseConnection *ConnectionH;
  typedef const class Shape        *ShapeH;

  class IStorageSvc   {
  protected:
    virtual ~IStorageSvc()   {     }
 
  public:
    static const Guid& interfaceID();

    static const char* category()             { return "pool_IStorageSvc"; }

    virtual StatusCode queryInterface(const Guid& riid, void** ppvUnkn) = 0;

    virtual unsigned int addRef() = 0;

    virtual unsigned int release() = 0;


    virtual std::string getContName(FileDescriptor& refDB,
                                    Token&          pToken) = 0;


    virtual StatusCode allocate(  FileDescriptor&       refDB,
                                  const std::string&    refCont,
                                  int                   technology,
                                  const void*           object,
                                  ShapeH                shapeH,
                                  Token*&               refpTok) = 0;
 


    virtual StatusCode read(      const FileDescriptor& refDB,
                                  const Token&          pToken,
                                  ShapeH                shapeH,
                                  void**                object) = 0;


    virtual StatusCode getShape(  FileDescriptor&       refDB,
                                  const Guid&           objType,
                                  ShapeH&               shapeH) = 0;


    virtual ShapeH     createShape( const Guid& shapeID ) = 0;


    virtual StatusCode startSession(int                 mode,
                                    int                 tech,
                                    SessionH&           session) = 0;


    virtual StatusCode endSession(  const SessionH           session) = 0;


    virtual StatusCode existsConnection(const SessionH        sessionH,
                                        int                   mode,
                                        const FileDescriptor& refDB) = 0;


    virtual StatusCode connect(   const SessionH      sessionH,
                                  int                 mode,
                                  FileDescriptor&     refDB) = 0;


    virtual StatusCode disconnect(  FileDescriptor&     refDB) = 0;


    virtual StatusCode openMode(  FileDescriptor&     refDB,
                                  int&                mode ) = 0;


    virtual StatusCode endTransaction( ConnectionH conn, Transaction::Action typ) = 0;


    virtual StatusCode getDomainOption(const SessionH  sessionH, DbOption& opt) = 0;


    virtual StatusCode setDomainOption(const SessionH  sessionH, const DbOption& opt) = 0;
 
  };
 
  // Factory function
  IStorageSvc* createStorageSvc(const std::string& componentName);
  
}       // End namespace pool
#endif  // POOL_ISTORAGESVC_H