This class provides a token that identifies in a unique way objects on the persistent storage. More...

#include <Token.h>

Inheritance diagram for Token:

Collaboration diagram for Token:

Classes
struct	OID_t

Public Member Functions
	Token ()
	Standard Constructor. More...

	Token (const Token *source)
	Constructor with data assignment. More...

	Token (Token &&source)
	Allow move. More...

virtual	~Token ()
	Standard destructor: release all allocated resources. More...

bool	operator< (const Token &refToken) const
	Operator < to allow ordering. More...

bool	operator> (const Token &refToken) const
	Operator > to allow ordering. More...

bool	operator== (const Token &refToken) const
	Equality operator. More...

bool	operator!= (const Token &refToken) const
	Equality operator. More...

virtual bool	less (const Token &pTok) const
	Fast token comparison: operator less. More...

virtual bool	equal (const Token &pTok) const
	Fast token comparison: operator equals. More...

int	release ()
	Release token: Decrease reference count and eventually delete. More...

int	addRef ()
	Increase reference count. More...

const Guid &	dbID () const
	Access database identifier. More...

Token &	setDb (const Guid &db)
	Set database name. More...

Token &	setDb (const std::string &db)

const std::string &	contID () const
	Access container identifier. More...

Token &	setCont (const std::string &cnt)
	Set container name. More...

const Guid &	classID () const
	Access database identifier. More...

Token &	setClassID (const Guid &cl_id)
	Access database identifier. More...

int	technology () const
	Access technology type. More...

Token &	setTechnology (int t)
	Set technology type. More...

const OID_t &	oid () const
	Access object identifier. More...

OID_t &	oid ()
	Access object identifier. More...

Token &	setOid (const OID_t &oid)
	Set object identifier. More...

int	type () const
	Access token type. More...

Token &	setType (int t)
	Set token type. More...

const std::string &	auxString () const
	Access auxiliary string. More...

Token &	setAuxString (const std::string &auxString)
	Set auxiliary string. More...

virtual const std::string	toString () const
	Retrieve the string representation of the token. More...

virtual const std::string	key () const
	Retrieve token key. More...

Token &	fromString (const std::string &from)
	Build from the string representation of a token. More...

const Token &	set (Token *pToken) const
	Set token information. More...

const Token &	setData (Token *pToken) const
	Set all the data part of the token. More...

Static Public Member Functions
static int	numInstances ()
	expose Token instance counter for debugging More...

Private Member Functions
	Token (const Token &copy)
	No copy allowed: put prototype to disable bit-wise copy. More...

Token &	operator= (const Token &copy)
	No assignment allowed: put prototype to disable bit-wise assignment. More...

Private Attributes
int	m_refCount
	Reference count. More...

unsigned int	m_technology
	Technology identifier. More...

Guid	m_dbID
	Database identifier. More...

std::string	m_cntID
	Container identifier. More...

Guid	m_classID
	Object global identifier. More...

OID_t	m_oid
	Persistent object identifier. More...

int	m_type
	Token type. More...

std::string	m_auxString
	Auxiliary string. More...

Detailed Description

This class provides a token that identifies in a unique way objects on the persistent storage.

Definition at line 21 of file Token.h.

Constructor & Destructor Documentation

◆ Token() [1/4]

Token::Token ( const Token & copy )

private

No copy allowed: put prototype to disable bit-wise copy.

Copy constructor.

Definition at line 32 of file Token.cxx.

                               : m_refCount(1),
     m_technology(copy.m_technology),
     m_dbID(copy.m_dbID),
     m_classID(copy.m_classID),
     m_oid(copy.m_oid),
     m_type(0) {
    copy.setData(this);
    s_numCount++;
 }

◆ Token() [2/4]

Token::Token ( )

Standard Constructor.

Standard Constructor(1): Empty constructor.

Definition at line 22 of file Token.cxx.

              : m_refCount(1),
     m_technology(0),
     m_dbID(Guid::null()),
     m_classID(Guid::null()),
     m_oid(OID_t(~0x0LL, ~0x0LL)),
     m_type(0) {
    s_numCount++;
 }

◆ Token() [3/4]

Token::Token ( const Token * source )

explicit

Constructor with data assignment.

Copy constructor.

Definition at line 43 of file Token.cxx.

                                 : m_refCount(1),
     m_technology(0),
     m_dbID(Guid::null()),
     m_classID(Guid::null()),
     m_oid(OID_t(~0x0LL, ~0x0LL)),
     m_type(0) {
    if (source != 0) {
       source->setData(this);
    }
    s_numCount++;
 }

◆ Token() [4/4]

Token::Token ( Token && source )

explicit

Allow move.

Move constructor.

Definition at line 56 of file Token.cxx.

   : m_refCount (1),
     m_technology (source.m_technology),
     m_dbID (std::move (source.m_dbID)),
     m_cntID (std::move (source.m_cntID)),
     m_classID (std::move (source.m_classID)),
     m_oid (std::move (source.m_oid)),
     m_type (source.m_type),
     m_auxString (std::move (source.m_auxString))
 {
    s_numCount++;
 }

◆ ~Token()

Token::~Token ( )

virtual

Standard destructor: release all allocated resources.

Definition at line 70 of file Token.cxx.

               {
    s_numCount--;
 }

Member Function Documentation

◆ addRef()

int Token::addRef ( )

inline

Increase reference count.

Definition at line 62 of file Token.h.

62 { return ++m_refCount; }

◆ auxString()

const std::string& Token::auxString ( ) const

inline

Access auxiliary string.

Definition at line 91 of file Token.h.

91 { return m_auxString; }

◆ classID()

const Guid& Token::classID ( ) const

inline

Access database identifier.

Definition at line 73 of file Token.h.

73 { return m_classID; }

◆ contID()

const std::string& Token::contID ( ) const

inline

Access container identifier.

Definition at line 69 of file Token.h.

69 { return m_cntID; }

◆ dbID()

const Guid& Token::dbID ( ) const

inline

Access database identifier.

Definition at line 64 of file Token.h.

64 { return m_dbID; }

◆ equal()

bool Token::equal ( const Token & pTok ) const

virtual

Fast token comparison: operator equals.

Equality operator.

Reimplemented in pool::DbToken.

Definition at line 92 of file Token.cxx.

                                          {
    if (&copy != this) {
       if (m_oid.second == copy.m_oid.second) {
          if (m_classID == copy.m_classID) {
             if (m_dbID == copy.m_dbID) {
                if (m_cntID == copy.m_cntID) {
                   return true;
                }
             }
          }
       }
       return false;
    }
    return true;
 }

◆ fromString()

Token & Token::fromString ( const std::string & from )

Build from the string representation of a token.

Definition at line 148 of file Token.cxx.

                                                    {
    m_auxString.clear();
    for (const char* p1 = source.c_str(); p1; p1 = ::strchr(++p1,'[')) {
       const char* p2 = ::strchr(p1, '=');
       const char* p3 = ::strchr(p1, ']');
       if (p2 != 0 && p3 != 0) {
          if (::strncmp("[DB=", p1, 4) == 0)  {
             m_dbID.fromString(p1 + 4);
          } else if (::strncmp("[CNT=", p1, 5) == 0) {
             m_cntID.assign (p2+1, p3-p2-1);
          } else if (::strncmp(fmt_oid, p1, 5) == 0) {
             long long unsigned int first, second;
             if (::strncmp("]", p1 + 22, 1) == 0) { // 5 + 8(int) + 1(minus) + 8(int) = 22
                ::sscanf(p1, fmt_oid_old, &first, &second);
                if (int(first) == ~0x0) first = ~0x0LL;
                if (int(second) == ~0x0) second = ~0x0LL;
             } else {
                ::sscanf(p1, fmt_oid, &first, &second);
             }
             m_oid.first = first;
             m_oid.second = second;
          } else if (::strncmp(fmt_clid, p1, 6) == 0) {
             m_classID.fromString(p1 + 6);
          } else if (::strncmp(fmt_tech, p1, 6) == 0) {
             ::sscanf(p1, fmt_tech, &m_technology);
          } else {
             while (*(p2 + 1) == '[' && p3 && *(++p3) != 0 && *p3 != ']') {
                p3 = ::strchr(p3, ']');
             }
             if (!p3) p3 = source.c_str() + source.size();
             m_auxString.append (p1, p3-p1);
             m_auxString += ']';
          }
       }
    }
    return *this;
 }

◆ key()

const std::string Token::key ( ) const

virtual

Retrieve token key.

Retrieve the string representation of the token.

Definition at line 187 of file Token.cxx.

                                  {
    char text[1024];
    int s = ::sprintf(text, "][TECH=%08X]", m_technology & KEY_MASK);
    std::string k = "[DB=";
    k += m_dbID.toString();
    k += "][CNT=";
    k += m_cntID;
    k += "][CLID=";
    k += m_classID.toString();
    k.append(text, s);
    return k;
 }

◆ less()

bool Token::less ( const Token & pTok ) const

virtual

Fast token comparison: operator less.

Operator to allow ordering.

Reimplemented in pool::DbToken.

Definition at line 109 of file Token.cxx.

                                         {
    if (&copy != this) {
       if (m_oid.second < copy.m_oid.second)
          return true;
       else if (m_oid.second > copy.m_oid.second)
          return false;
       if (!(m_classID == copy.m_classID)) {
          return (m_classID < copy.m_classID);
       }
       if (!(m_dbID == copy.m_dbID)) {
          return (m_dbID < copy.m_dbID);
       }
       int res = m_cntID.compare(copy.m_cntID);
       if (res != 0) {
          return (res < 0);
       }
    }
    return false;
 }

◆ numInstances()

int Token::numInstances ( )

static

expose Token instance counter for debugging

Definition at line 19 of file Token.cxx.

19 { return s_numCount; }

◆ oid() [1/2]

OID_t& Token::oid ( )

inline

Access object identifier.

Definition at line 83 of file Token.h.

83 { return m_oid; }

◆ oid() [2/2]

const OID_t& Token::oid ( ) const

inline

Access object identifier.

Definition at line 81 of file Token.h.

81 { return m_oid; }

◆ operator!=()

bool Token::operator!= ( const Token & refToken ) const

inline

Equality operator.

Definition at line 54 of file Token.h.

54 { return !equal(refToken); }

◆ operator<()

bool Token::operator< ( const Token & refToken ) const

inline

Operator < to allow ordering.

Definition at line 45 of file Token.h.

45 { return less(refToken); }

◆ operator=()

Token & Token::operator= ( const Token & copy )

private

No assignment allowed: put prototype to disable bit-wise assignment.

Assignment operator.

Definition at line 84 of file Token.cxx.

                                          {
   if (&copy != this) {
      copy.setData(this);
   }
   return *this;
 }

◆ operator==()

bool Token::operator== ( const Token & refToken ) const

inline

Equality operator.

Definition at line 52 of file Token.h.

52 { return equal(refToken); }

◆ operator>()

bool Token::operator> ( const Token & refToken ) const

inline

Operator > to allow ordering.

Definition at line 47 of file Token.h.

                                                { 
       if (less(refToken)) return false;
       return !equal(refToken);
    }

◆ release()

int Token::release ( )

Release token: Decrease reference count and eventually delete.

Definition at line 75 of file Token.cxx.

                    {
    int cnt = --m_refCount;
    if (0 >= cnt) {
       delete this;
    }
    return cnt;
 }

◆ set()

const Token & Token::set ( Token * pToken ) const

Set token information.

Definition at line 200 of file Token.cxx.

                                            {
    pToken->m_technology = m_technology;
    pToken->m_dbID = m_dbID;
    pToken->m_cntID = m_cntID;
    pToken->m_classID = m_classID;
    pToken->m_oid.first = m_oid.first;
    return *this;
 }

◆ setAuxString()

Token& Token::setAuxString ( const std::string & auxString )

inline

Set auxiliary string.

Definition at line 93 of file Token.h.

93 { m_auxString = auxString; return *this; }

◆ setClassID()

Token& Token::setClassID ( const Guid & cl_id )

inline

Access database identifier.

Definition at line 75 of file Token.h.

75 { m_classID = cl_id; return *this; }

◆ setCont()

Token& Token::setCont ( const std::string & cnt )

inline

Set container name.

Definition at line 71 of file Token.h.

71 { m_cntID = cnt; return *this; }

◆ setData()

const Token & Token::setData ( Token * pToken ) const

Set all the data part of the token.

Definition at line 209 of file Token.cxx.

                                                {
    this->set(pToken);
    pToken->m_oid.second = m_oid.second;
    pToken->m_type = m_type;
    pToken->m_auxString = m_auxString;
    return *this;
 }

◆ setDb() [1/2]

Token& Token::setDb ( const Guid & db )

inline

Set database name.

Definition at line 66 of file Token.h.

66 { m_dbID = db; return *this; }

◆ setDb() [2/2]

Token& Token::setDb ( const std::string & db )

inline

Definition at line 67 of file Token.h.

67 { m_dbID.fromString(db); return *this; }

◆ setOid()

Token& Token::setOid ( const OID_t & oid )

inline

Set object identifier.

Definition at line 85 of file Token.h.

85 { m_oid = oid; return *this; }

◆ setTechnology()

Token& Token::setTechnology ( int t )

inline

Set technology type.

Definition at line 79 of file Token.h.

79 { m_technology = t; return *this; }

◆ setType()

Token& Token::setType ( int t )

inline

Set token type.

Definition at line 89 of file Token.h.

89 { m_type = t; return *this; }

◆ technology()

int Token::technology ( ) const

inline

Access technology type.

Definition at line 77 of file Token.h.

77 { return m_technology; }

◆ toString()

const std::string Token::toString ( ) const

virtual

Retrieve the string representation of the token.

Definition at line 129 of file Token.cxx.

                                       {
    char text1[128];
    int s1 = sprintf(text1, fmt_tech, m_technology);
    char text2[128];
    int s2 = sprintf(text2, fmt_oid, m_oid.first, m_oid.second);
    std::string str = "[DB=";
    str.reserve(32);
    str += m_dbID.toString();
    str += "][CNT=";
    str += m_cntID;
    str += "][CLID=";
    str += m_classID.toString();
    str += ']';
    str.append(text1, s1);
    str.append(text2, s2);
    str += m_auxString;
    return str;
 }

◆ type()

int Token::type ( ) const

inline

Access token type.

Definition at line 87 of file Token.h.

87 { return m_type; }

Member Data Documentation

◆ m_auxString

std::string Token::m_auxString

private

Auxiliary string.

Definition at line 125 of file Token.h.

◆ m_classID

Guid Token::m_classID

private

Object global identifier.

Definition at line 119 of file Token.h.

◆ m_cntID

std::string Token::m_cntID

private

Container identifier.

Definition at line 117 of file Token.h.

◆ m_dbID

Guid Token::m_dbID

private

Database identifier.

Definition at line 115 of file Token.h.

◆ m_oid

OID_t Token::m_oid

private

Persistent object identifier.

Definition at line 121 of file Token.h.

◆ m_refCount

int Token::m_refCount

private

Reference count.

Definition at line 111 of file Token.h.

◆ m_technology

unsigned int Token::m_technology

private

Technology identifier.

Definition at line 113 of file Token.h.

◆ m_type

int Token::m_type

private

Token type.

Definition at line 123 of file Token.h.

The documentation for this class was generated from the following files:

Classes

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Token() [1/4]

◆ Token() [2/4]

◆ Token() [3/4]

◆ Token() [4/4]

◆ ~Token()

Member Function Documentation

◆ addRef()

◆ auxString()

◆ classID()

◆ contID()

◆ dbID()

◆ equal()

◆ fromString()

◆ key()

◆ less()

◆ numInstances()

◆ oid() [1/2]

◆ oid() [2/2]

◆ operator!=()

◆ operator<()

◆ operator=()

◆ operator==()

◆ operator>()

◆ release()

◆ set()

◆ setAuxString()

◆ setClassID()

◆ setCont()

◆ setData()

◆ setDb() [1/2]

◆ setDb() [2/2]

◆ setOid()

◆ setTechnology()

◆ setType()

◆ technology()

◆ toString()

◆ type()

Member Data Documentation

◆ m_auxString

◆ m_classID

◆ m_cntID

◆ m_dbID

◆ m_oid

◆ m_refCount

◆ m_technology

◆ m_type