IStorageSvc.h

Go to the documentation of this file.

/*
  Copyright (C) 2002-2021 CERN for the benefit of the ATLAS collaboration
*/
 
// $Header: /cvs/PF/pool/StorageSvc/StorageSvc/IStorageSvc.h,v 1.33 2008/05/13 14:39:31 witoldp Exp $
#ifndef POOL_ISTORAGESVC_H
#define POOL_ISTORAGESVC_H
 
// Framework include files
#include "StorageSvc/DbStatus.h"
#include "StorageSvc/Transaction.h"
 
// STL include files
#include <string>
 
// Forward declarations
 
class Guid;
class Token;
 
/*
 *     pool namespace declaration
 */
namespace pool  {
 
  // Forward declarations
  class FileDescriptor;
  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 DbStatus 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 DbStatus allocate(    FileDescriptor&       refDB,
                                  const std::string&    refCont,
                                  int                   technology,
                                  const void*           object,
                                  ShapeH                shapeH,
                                  Token*&               refpTok) = 0;
 


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


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


    virtual DbStatus createShape( const FileDescriptor& refDB,
                                  const std::string&    cntName,
                                  const Guid&           shapeID,
                                  ShapeH&               shapeH) = 0;


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


    virtual DbStatus endSession(  const SessionH           session) = 0;


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


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


    virtual DbStatus disconnect(  FileDescriptor&     refDB) = 0;


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


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

    enum : unsigned {
      ISTORAGESVC_ERROR         = DbStatus::Error,
      INVALID_SESSION_TOKEN     = ISTORAGESVC_ERROR+2,
      INVALID_CONNECTION_TOKEN  = ISTORAGESVC_ERROR+4,
      INVALID_TRANSACTION_TOKEN = ISTORAGESVC_ERROR+6,
      INVALID_AUTHENTICATION    = ISTORAGESVC_ERROR+8,
      TRANSACTION_FAILED        = ISTORAGESVC_ERROR+10,
      INVALID_OBJECT            = ISTORAGESVC_ERROR+12,
      INVALID_OBJ_TOKEN         = ISTORAGESVC_ERROR+14,
      OBJ_NOT_LOADED            = ISTORAGESVC_ERROR+16,
      CONNECTION_NOT_EXISTING   = ISTORAGESVC_ERROR+18,
      ISTORAGESVC_LAST          = ISTORAGESVC_ERROR+20,
      ISTORAGESVC_INFO          = DbStatus::Info,
      SHAPE_NOT_AVAILIBLE       = ISTORAGESVC_INFO+2,
      IS_PERSISTENT_SHAPE       = ISTORAGESVC_INFO+4
    };
  };
 
  // Factory function
  IStorageSvc* createStorageSvc(const std::string& componentName);
  
}       // End namespace pool
#endif  // POOL_ISTORAGESVC_H