locker.hpp

/* locker.hpp */
/* $Id$ */
#ifndef __locker_hpp
#define __locker_hpp

#include <ctime>
#include <string>
#include <hds_db/base/defines.hpp>

namespace hds
{
  namespace db
  {
    enum LockType
      {
    LT_READ = 0, 
    LT_WRITE    
      };
    
    struct LockDescription
    {
      LockDescription():
    type(LT_READ), timestamp(0)
      {/* nothing to do. */}

      LockDescription(const std::string &i_name,
              const LockType &i_type,
              const std::string &i_project,
              const std::string &i_comment):
    name(i_name), type(i_type), project(i_project), comment(i_comment)
      {/* nothing to do. */}
      
      std::string name;    
      LockType type;       
      std::string project; 
      std::string comment; 
      time_t timestamp;    
    };

    typedef std::vector<LockDescription> LockDescriptionVec;
    
    class Locker
    {
    public:
      
      Locker();
            
      virtual ~Locker();
      
      virtual DbIndex lock(const LockDescription &ld) = 0;
      
      virtual void release(const DbIndex &id) = 0;

      virtual size_t releaseAll() = 0;
      
      
      virtual void list(LockDescriptionVec &locks) = 0;
      
      
      virtual ErrCode lastError() const = 0;
    };
  }; // db
};  // hds

#endif /* locker.hpp */