pool::DbDomainObj Class Reference

Db objects: DbDomainObj. More...

#include <DbDomainObj.h>

Inheritance diagram for pool::DbDomainObj:

Collaboration diagram for pool::DbDomainObj:

Public Types
typedef DbAccessObj< std::string, DbDatabaseObj >	Base
	Type definitions. More...
typedef std::map< std::string, DbDatabaseObj * >	Keys
typedef Keys::iterator	iterator
typedef Keys::const_iterator	const_iterator

Public Member Functions
	DbDomainObj (DbSession &session, const DbType &typ, DbAccessMode mode=pool::READ)
	Constructor. More...
virtual	~DbDomainObj ()
	Standard destructor. More...
IDbDomain *	info ()
	Access to technology dependent implementation. More...
const IDbDomain *	info () const
DbSession &	session ()
	Access session handle. More...
const DbSession &	session () const
void	setAgeLimit (int value)
	Set the maximal allowed age limit for files in this domain. More...
int	ageLimit () const
	Access the maximal age limit. More...
bool	existsDbase (const std::string &nam)
	Check for Database existence within domain. More...
DbStatus	open (DbAccessMode mode)
	Open domain with possible change of access mode. More...
DbStatus	open ()
	Open domain in default access mode. More...
DbStatus	close ()
	Close domain. More...
DbStatus	ageOpenDbs ()
	Increase the age of all open databases. More...
DbStatus	closeAgedDbs ()
	Check if databases are present, which aged a lot and need to be closed. More...
DbStatus	setOption (const DbOption &refOpt)
	Set domain specific options. More...
DbStatus	getOption (DbOption &refOpt) const
	Access domain specific options. More...
const std::string &	name () const
	Access the instance name. More...
void	setName (const std::string &n)
	Access the instance name. More...
DbAccessMode	mode () const
	Access mode. More...
void	setMode (DbAccessMode m)
	Set Access mode. More...
const DbType &	type () const
const IOODatabase *	db () const
	Allow access to the Database implementation. More...
IOODatabase *	db ()
int	refCount () const
	Access reference counter. More...
int	addRef () const
	Add reference count. More...
int	release () const
	Remove reference count. More...
size_t	size () const
	Object size. More...
DbStatus	clearEntries ()
	Object cleanup: remove all entries. More...
const DbDatabaseObj *	find (const std::string &key) const
	Find object by key (CONST) More...
DbDatabaseObj *	find (const std::string &key)
	Find object by key. More...
DbStatus	add (const std::string &key, DbDatabaseObj *val)
	Add entry to container. More...
DbStatus	remove (const DbDatabaseObj *val)
	Remove entry from container. More...
iterator	begin ()
const_iterator	begin () const
iterator	end ()
const_iterator	end () const

Private Attributes
DbSession	m_session
	Handle to session. More...
int	m_maxAge
	Maximal age of files allowed. More...
IDbDomain *	m_info
	Technology dependent stuff. More...
std::atomic< int >	m_refCount
	Reference counter. More...
DbAccessMode	m_mode
	Access mode. More...
std::string	m_name
	Name of the instance. More...
DbType	m_type
	Database type. More...
Keys	m_keys
	Key entry buffer. More...
IOODatabase *	m_pool
	Pointer to specific pool implementation. More...

Detailed Description

Db objects: DbDomainObj.

Description: Implementation independent part of a Database domain object objects.

Author

M.Frank

Version

1.0

Definition at line 39 of file DbDomainObj.h.

Member Typedef Documentation

Base

typedef DbAccessObj< std::string , DbDatabaseObj > pool::DbAccessObj< std::string , DbDatabaseObj >::Base

inherited

Type definitions.

Definition at line 50 of file DbAccessObj.h.

const_iterator

typedef Keys::const_iterator pool::DbAccessObj< std::string , DbDatabaseObj >::const_iterator

inherited

Definition at line 53 of file DbAccessObj.h.

iterator

typedef Keys::iterator pool::DbAccessObj< std::string , DbDatabaseObj >::iterator

inherited

Definition at line 52 of file DbAccessObj.h.

Keys

typedef std::map< std::string , DbDatabaseObj * > pool::DbAccessObj< std::string , DbDatabaseObj >::Keys

inherited

Definition at line 51 of file DbAccessObj.h.

Constructor & Destructor Documentation

DbDomainObj()

pool::DbDomainObj::DbDomainObj	(	DbSession &	session,
		const DbType &	typ,
		DbAccessMode	mode = pool::READ
	)

Constructor.

~DbDomainObj()

virtual pool::DbDomainObj::~DbDomainObj ( )

virtual

Standard destructor.

Member Function Documentation

add()

DbStatus pool::DbAccessObj< std::string , DbDatabaseObj >::add ( const std::string &  key, DbDatabaseObj *  val  )

inlineinherited

Add entry to container.

Definition at line 142 of file DbAccessObj.h.

                                              {
      iterator i = m_keys.find(key);
      if ( m_keys.end() == i )    {
        m_keys.insert(std::make_pair(key, val));
        val->addRef();
        return Success;
      }
      return Error;
    }

addRef()

int pool::DbAccessObj< std::string , DbDatabaseObj >::addRef

inlineinherited

Add reference count.

Definition at line 91 of file DbAccessObj.h.

                        {
#ifdef DEBUG_REFCOUNTS
      std::cout << typeid(*this).name() 
                << "  " 
                << m_name 
                << " Refcount:" 
                << m_refCount+1  
                << std::endl;
#endif
      return ++m_refCount;
    }

ageLimit()

int pool::DbDomainObj::ageLimit ( ) const

inline

Access the maximal age limit.

Definition at line 63 of file DbDomainObj.h.

{    return m_maxAge;   }

ageOpenDbs()

DbStatus pool::DbDomainObj::ageOpenDbs

(

)

Increase the age of all open databases.

begin() [1/2]

iterator pool::DbAccessObj< std::string , DbDatabaseObj >::begin

inlineinherited

Definition at line 163 of file DbAccessObj.h.

{      return m_keys.begin();   }

begin() [2/2]

const_iterator pool::DbAccessObj< std::string , DbDatabaseObj >::begin

inlineinherited

Definition at line 164 of file DbAccessObj.h.

{      return m_keys.begin();   }

clearEntries()

DbStatus pool::DbAccessObj< std::string , DbDatabaseObj >::clearEntries

inlineinherited

Object cleanup: remove all entries.

Definition at line 123 of file DbAccessObj.h.

                              {
      Keys k = m_keys;
      for(iterator j = k.begin(); j != k.end(); ++j )  {
        (*j).second->release();
      }
      m_keys.clear();
      return Success;
    }

close()

DbStatus pool::DbDomainObj::close

(

)

Close domain.

closeAgedDbs()

DbStatus pool::DbDomainObj::closeAgedDbs

(

)

Check if databases are present, which aged a lot and need to be closed.

db() [1/2]

IOODatabase* pool::DbAccessObj< std::string , DbDatabaseObj >::db

inlineinherited

Definition at line 87 of file DbAccessObj.h.

{      return m_pool;           }

db() [2/2]

const IOODatabase* pool::DbAccessObj< std::string , DbDatabaseObj >::db

inlineinherited

Allow access to the Database implementation.

Definition at line 86 of file DbAccessObj.h.

{      return m_pool;           }

end() [1/2]

iterator pool::DbAccessObj< std::string , DbDatabaseObj >::end

inlineinherited

Definition at line 165 of file DbAccessObj.h.

{      return m_keys.end();     }

end() [2/2]

const_iterator pool::DbAccessObj< std::string , DbDatabaseObj >::end

inlineinherited

Definition at line 166 of file DbAccessObj.h.

{      return m_keys.end();     }

existsDbase()

bool pool::DbDomainObj::existsDbase

(

const std::string &

nam

)

Check for Database existence within domain.

find() [1/2]

DbDatabaseObj * pool::DbAccessObj< std::string , DbDatabaseObj >::find ( const std::string &  key )

inlineinherited

Find object by key.

Definition at line 137 of file DbAccessObj.h.

                                  {
      iterator i = m_keys.find(key);
      return (m_keys.end() == i) ? 0 : (*i).second;
    }

find() [2/2]

const DbDatabaseObj * pool::DbAccessObj< std::string , DbDatabaseObj >::find ( const std::string &  key ) const

inlineinherited

Find object by key (CONST)

Definition at line 132 of file DbAccessObj.h.

                                              {
      const_iterator i = m_keys.find(key);
      return (m_keys.end() == i) ? 0 : (*i).second;
    }

getOption()

DbStatus pool::DbDomainObj::getOption

(

DbOption &

refOpt

)

const

Access domain specific options.

Parameters

refOpt

[IN] Reference to option object

Returns

DbStatus code indicating success or failure.

info() [1/2]

IDbDomain* pool::DbDomainObj::info ( )

inline

Access to technology dependent implementation.

Definition at line 55 of file DbDomainObj.h.

{    return m_info;     }

info() [2/2]

const IDbDomain* pool::DbDomainObj::info ( ) const

inline

Definition at line 56 of file DbDomainObj.h.

{    return m_info;     }

mode()

DbAccessMode pool::DbAccessObj< std::string , DbDatabaseObj >::mode

inlineinherited

Access mode.

Definition at line 80 of file DbAccessObj.h.

{      return m_mode;           }

name()

const std::string& pool::DbAccessObj< std::string , DbDatabaseObj >::name

inlineinherited

Access the instance name.

Definition at line 76 of file DbAccessObj.h.

{      return m_name;           }

open() [1/2]

DbStatus pool::DbDomainObj::open

(

)

Open domain in default access mode.

open() [2/2]

DbStatus pool::DbDomainObj::open

(

DbAccessMode

mode

)

Open domain with possible change of access mode.

refCount()

int pool::DbAccessObj< std::string , DbDatabaseObj >::refCount

inlineinherited

Access reference counter.

Definition at line 89 of file DbAccessObj.h.

{      return m_refCount;       }

release()

int pool::DbAccessObj< std::string , DbDatabaseObj >::release

inlineinherited

Remove reference count.

Definition at line 103 of file DbAccessObj.h.

                           {
      int count = --m_refCount;
#ifdef DEBUG_REFCOUNTS
      std::cout << typeid(*this).name() 
                << "  " 
                << m_name 
                << " Refcount:" 
                << count  
                << std::endl;
#endif
      if ( count == 0 )    {
        delete this;
      }
      return count;
    }

remove()

DbStatus pool::DbAccessObj< std::string , DbDatabaseObj >::remove ( const DbDatabaseObj *  val )

inlineinherited

Remove entry from container.

Definition at line 152 of file DbAccessObj.h.

                                        {
      for (iterator j = m_keys.begin(); j != m_keys.end(); ++j )    {
        if ( (*j).second == val ) {
          TYPE* p = (*j).second;
          m_keys.erase(j);
          p->release();
          return Success;
        }
      }
      return Error;
    }

session() [1/2]

DbSession& pool::DbDomainObj::session ( )

inline

Access session handle.

Definition at line 58 of file DbDomainObj.h.

{    return m_session;  }

session() [2/2]

const DbSession& pool::DbDomainObj::session ( ) const

inline

Definition at line 59 of file DbDomainObj.h.

{    return m_session;  }

setAgeLimit()

void pool::DbDomainObj::setAgeLimit ( int  value )

inline

Set the maximal allowed age limit for files in this domain.

Definition at line 61 of file DbDomainObj.h.

{    m_maxAge = value;  }

setMode()

void pool::DbAccessObj< std::string , DbDatabaseObj >::setMode ( DbAccessMode  m )

inlineinherited

Set Access mode.

Definition at line 82 of file DbAccessObj.h.

{      m_mode = m;              }

setName()

void pool::DbAccessObj< std::string , DbDatabaseObj >::setName ( const std::string &  n )

inlineinherited

Access the instance name.

Definition at line 78 of file DbAccessObj.h.

{      m_name = n;              }

setOption()

DbStatus pool::DbDomainObj::setOption

(

const DbOption &

refOpt

)

Set domain specific options.

Parameters

refOpt

[IN] Reference to option object

Returns

DbStatus code indicating success or failure.

size()

size_t pool::DbAccessObj< std::string , DbDatabaseObj >::size

inlineinherited

Object size.

Definition at line 119 of file DbAccessObj.h.

                            {
      return m_keys.size();
    }

type()

const DbType& pool::DbAccessObj< std::string , DbDatabaseObj >::type

inlineinherited

Definition at line 84 of file DbAccessObj.h.

{      return m_type;           }

Member Data Documentation

m_info

IDbDomain* pool::DbDomainObj::m_info

private

Technology dependent stuff.

Definition at line 46 of file DbDomainObj.h.

m_keys

Keys pool::DbAccessObj< std::string , DbDatabaseObj >::m_keys

privateinherited

Key entry buffer.

Definition at line 64 of file DbAccessObj.h.

m_maxAge

int pool::DbDomainObj::m_maxAge

private

Maximal age of files allowed.

Definition at line 44 of file DbDomainObj.h.

m_mode

DbAccessMode pool::DbAccessObj< std::string , DbDatabaseObj >::m_mode

privateinherited

Access mode.

Definition at line 58 of file DbAccessObj.h.

m_name

std::string pool::DbAccessObj< std::string , DbDatabaseObj >::m_name

privateinherited

Name of the instance.

Definition at line 60 of file DbAccessObj.h.

m_pool

IOODatabase* pool::DbAccessObj< std::string , DbDatabaseObj >::m_pool

privateinherited

Pointer to specific pool implementation.

Definition at line 66 of file DbAccessObj.h.

m_refCount

std::atomic<int> pool::DbAccessObj< std::string , DbDatabaseObj >::m_refCount

mutableprivateinherited

Reference counter.

Definition at line 56 of file DbAccessObj.h.

m_session

DbSession pool::DbDomainObj::m_session

private

Handle to session.

Definition at line 42 of file DbDomainObj.h.

m_type

DbType pool::DbAccessObj< std::string , DbDatabaseObj >::m_type

privateinherited

Database type.

Definition at line 62 of file DbAccessObj.h.

---

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

• DbDomainObj.h