pool::DbSessionObj Class Reference

Db objects: DbSessionObj. More...

#include <DbSessionObj.h>

Inheritance diagram for pool::DbSessionObj:

Collaboration diagram for pool::DbSessionObj:

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

Public Member Functions
	DbSessionObj ()
	Standard constructor. More...
virtual	~DbSessionObj ()
	Standard destructor. More...
IOODatabase *	db (const DbType &typ)
	Allow access to the Database implementation. More...
DbStatus	open ()
	Open session. More...
DbStatus	close ()
	Close Database session. 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...
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 DbDomainObj *	find (const DbType &key) const
	Find object by key (CONST) More...
DbDomainObj *	find (const DbType &key)
	Find object by key. More...
DbStatus	add (const DbType &key, DbDomainObj *val)
	Add entry to container. More...
DbStatus	remove (const DbDomainObj *val)
	Remove entry from container. More...
iterator	begin ()
const_iterator	begin () const
iterator	end ()
const_iterator	end () const

Private Attributes
std::map< DbType, IOODatabase * >	m_dbTypes
	Known Implementation types. 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: DbSessionObj.

Description: Implementation independent part of a Database session object.

There is a ring of protection around the object. The object can only be accessed through its handle, the technology dependent code and the DbDatabaseObj object hosting the container. This should ensure proper reference counting and inhibit non existing references flying around.

Author

M.Frank

Version

1.0

Definition at line 45 of file DbSessionObj.h.

Member Typedef Documentation

Base

typedef DbAccessObj< DbType , DbDomainObj > pool::DbAccessObj< DbType , DbDomainObj >::Base

inherited

Type definitions.

Definition at line 50 of file DbAccessObj.h.

const_iterator

typedef Keys::const_iterator pool::DbAccessObj< DbType , DbDomainObj >::const_iterator

inherited

Definition at line 53 of file DbAccessObj.h.

iterator

typedef Keys::iterator pool::DbAccessObj< DbType , DbDomainObj >::iterator

inherited

Definition at line 52 of file DbAccessObj.h.

Keys

typedef std::map< DbType , DbDomainObj * > pool::DbAccessObj< DbType , DbDomainObj >::Keys

inherited

Definition at line 51 of file DbAccessObj.h.

Constructor & Destructor Documentation

DbSessionObj()

pool::DbSessionObj::DbSessionObj

(

)

Standard constructor.

~DbSessionObj()

virtual pool::DbSessionObj::~DbSessionObj ( )

virtual

Standard destructor.

Member Function Documentation

add()

DbStatus pool::DbAccessObj< DbType , DbDomainObj >::add ( const DbType &  key, DbDomainObj *  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< DbType , DbDomainObj >::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;
    }

begin() [1/2]

iterator pool::DbAccessObj< DbType , DbDomainObj >::begin

inlineinherited

Definition at line 163 of file DbAccessObj.h.

{      return m_keys.begin();   }

begin() [2/2]

const_iterator pool::DbAccessObj< DbType , DbDomainObj >::begin

inlineinherited

Definition at line 164 of file DbAccessObj.h.

{      return m_keys.begin();   }

clearEntries()

DbStatus pool::DbAccessObj< DbType , DbDomainObj >::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::DbSessionObj::close

(

)

Close Database session.

db() [1/2]

const IOODatabase* pool::DbAccessObj< DbType , DbDomainObj >::db

inlineinherited

Allow access to the Database implementation.

Definition at line 86 of file DbAccessObj.h.

{      return m_pool;           }

db() [2/2]

IOODatabase* pool::DbSessionObj::db

(

const DbType &

typ

)

Allow access to the Database implementation.

end() [1/2]

iterator pool::DbAccessObj< DbType , DbDomainObj >::end

inlineinherited

Definition at line 165 of file DbAccessObj.h.

{      return m_keys.end();     }

end() [2/2]

const_iterator pool::DbAccessObj< DbType , DbDomainObj >::end

inlineinherited

Definition at line 166 of file DbAccessObj.h.

{      return m_keys.end();     }

find() [1/2]

DbDomainObj * pool::DbAccessObj< DbType , DbDomainObj >::find ( const DbType &  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 DbDomainObj * pool::DbAccessObj< DbType , DbDomainObj >::find ( const DbType &  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;
    }

mode()

DbAccessMode pool::DbAccessObj< DbType , DbDomainObj >::mode

inlineinherited

Access mode.

Definition at line 80 of file DbAccessObj.h.

{      return m_mode;           }

name()

const std::string& pool::DbAccessObj< DbType , DbDomainObj >::name

inlineinherited

Access the instance name.

Definition at line 76 of file DbAccessObj.h.

{      return m_name;           }

open()

DbStatus pool::DbSessionObj::open

(

)

Open session.

refCount()

int pool::DbAccessObj< DbType , DbDomainObj >::refCount

inlineinherited

Access reference counter.

Definition at line 89 of file DbAccessObj.h.

{      return m_refCount;       }

release()

int pool::DbAccessObj< DbType , DbDomainObj >::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< DbType , DbDomainObj >::remove ( const DbDomainObj *  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;
    }

setMode()

void pool::DbAccessObj< DbType , DbDomainObj >::setMode ( DbAccessMode  m )

inlineinherited

Set Access mode.

Definition at line 82 of file DbAccessObj.h.

{      m_mode = m;              }

setName()

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

inlineinherited

Access the instance name.

Definition at line 78 of file DbAccessObj.h.

{      m_name = n;              }

size()

size_t pool::DbAccessObj< DbType , DbDomainObj >::size

inlineinherited

Object size.

Definition at line 119 of file DbAccessObj.h.

                            {
      return m_keys.size();
    }

type()

const DbType& pool::DbAccessObj< DbType , DbDomainObj >::type

inlineinherited

Definition at line 84 of file DbAccessObj.h.

{      return m_type;           }

Member Data Documentation

m_dbTypes

std::map<DbType, IOODatabase*> pool::DbSessionObj::m_dbTypes

private

Known Implementation types.

Definition at line 48 of file DbSessionObj.h.

m_keys

Keys pool::DbAccessObj< DbType , DbDomainObj >::m_keys

privateinherited

Key entry buffer.

Definition at line 64 of file DbAccessObj.h.

m_mode

DbAccessMode pool::DbAccessObj< DbType , DbDomainObj >::m_mode

privateinherited

Access mode.

Definition at line 58 of file DbAccessObj.h.

m_name

std::string pool::DbAccessObj< DbType , DbDomainObj >::m_name

privateinherited

Name of the instance.

Definition at line 60 of file DbAccessObj.h.

m_pool

IOODatabase* pool::DbAccessObj< DbType , DbDomainObj >::m_pool

privateinherited

Pointer to specific pool implementation.

Definition at line 66 of file DbAccessObj.h.

m_refCount

std::atomic<int> pool::DbAccessObj< DbType , DbDomainObj >::m_refCount

mutableprivateinherited

Reference counter.

Definition at line 56 of file DbAccessObj.h.

m_type

DbType pool::DbAccessObj< DbType , DbDomainObj >::m_type

privateinherited

Database type.

Definition at line 62 of file DbAccessObj.h.

---

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

• DbSessionObj.h