#include <src/DbContainerObj.h>

Inheritance diagram for pool::DbContainerObj:

Collaboration diagram for pool::DbContainerObj:

Public Types
typedef DbAccessObj< DbObject *, DbObjectHolder >	Base
	Type definitions. More...

typedef std::map< DbObject , DbObjectHolder >	Keys

typedef Keys::iterator	iterator

typedef Keys::const_iterator	const_iterator

Public Member Functions
	DbContainerObj (DbDatabase &dbH, const std::string &nam, const DbType &dbtyp, DbAccessMode mod)
	Standard constructor of a container object using the Database handle as a clustering hint. More...

virtual	~DbContainerObj ()
	Standard destructor. More...

const IDbContainer *	info () const
	Access to internals. More...

IDbContainer *	info ()

const DbTypeInfo *	objectShape (const Guid &nam)
	Retrieve persistent type information by name. More...

DbStatus	addShape (const DbTypeInfo *typ)
	Add persistent type. Returns error if the type is not supported. More...

DbDatabase &	database ()
	Handle to Database (CONST) More...

const Token *	token () const
	Access the token of the container object. More...

bool	updatesPending () const
	Query the pending transaction stack. More...

bool	isOpen () const
	Flag if container was opened. More...

bool	isReadOnly () const
	Check if database is in read-only mode. More...

void	cancelTransaction ()
	Cancel transaction flag. More...

uint64_t	size ()
	Size of the Database container (=# of objects) More...

DbStatus	open (const DbTypeInfo *typ)
	Open the container. More...

DbStatus	close ()
	Close the container. More...

DbStatus	retire ()
	Retire the container. More...

DbStatus	transAct (Transaction::Action)
	Execute Database Transaction Action. More...

DbStatus	setOption (const DbOption &opt)
	Pass options to the implementation. More...

DbStatus	getOption (DbOption &refOpt)
	Access options. More...

DbStatus	remove (ObjHandle &objH)
	Remove the transient representation of the object from memory. More...

DbStatus	destroy (const Token::OID_t &linkH)
	Destroy an existing persistent object identified by its handle. More...

DbStatus	save (DbObjectHandle< DbObject > &objH, const DbTypeInfo *typ)
	Add an object to the container identified by its handle. More...

void *	allocate (unsigned long siz, DbContainer &cntH, ShapeH shape)
	In place allocation of raw memory. More...

DbStatus	allocate (DbContainer &cntH, const void *object, ShapeH shape, Token::OID_t &oid)
	In place allocation of object location. More...

DbStatus	free (void *ptr, DbContainer &cntH)
	In place free of raw memory. More...

DbStatus	save (DbContainer &cntH, const void *object, ShapeH shape, Token::OID_t &linkH)
	Save new object in the container and return its handle. More...

DbStatus	update (DbContainer &cntH, const void *object, ShapeH shape, const Token::OID_t &linkH)
	Update an object to the container identified by its handle. More...

DbStatus	update (DbContainer &cntH, const void *object, ShapeH shape, const DbObjectHandle< DbObject > &objH)
	Update existing object in the container. More...

DbStatus	load (void **ptr, ShapeH shape, const Token::OID_t &linkH, Token::OID_t &oid, bool any_next)
	Select object in the container identified by its handle. More...

DbStatus	update (DbSelect &sel)
	Perform UPDATE select. More...

DbStatus	destroy (DbSelect &sel)
	Perform DELETE statement. More...

DbStatus	select (DbSelect &sel)
	Perform selection. The statement belongs to the container afterwards. More...

DbStatus	fetch (DbSelect &sel)
	Fetch next object address of the selection to set token. 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...

DbStatus	clearEntries ()
	Object cleanup: remove all entries. More...

const DbObjectHolder *	find (const DbObject * &key) const
	Find object by key (CONST) More...

DbObjectHolder *	find (const DbObject * &key)
	Find object by key. More...

DbStatus	add (const DbObject * &key, DbObjectHolder *val)
	Add entry to container. More...

DbStatus	remove (const DbObjectHolder *val)
	Remove entry from container. More...

iterator	begin ()

const_iterator	begin () const

iterator	end ()

const_iterator	end () const

Private Types
typedef DbObjectHandle< DbObject >	ObjHandle

Private Member Functions
bool	hasAccess ()
	Check database access. More...

Private Attributes
IDbContainer *	m_info
	Pointer to interface of the technology dependent part. More...

const Token *	m_tokH
	Container token. More...

DbDatabase	m_dbH
	Handle to hosting Database. More...

bool	m_isOpen
	Flag indication DbStatus of technology dependent container. 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

Description:

Implementation independent part of a container object objects.

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 50 of file DbContainerObj.h.

Member Typedef Documentation

◆ Base

typedef DbAccessObj< DbObject * , DbObjectHolder > pool::DbAccessObj< DbObject * , DbObjectHolder >::Base

inherited

Type definitions.

Definition at line 50 of file DbAccessObj.h.

◆ const_iterator

typedef Keys::const_iterator pool::DbAccessObj< DbObject * , DbObjectHolder >::const_iterator

inherited

Definition at line 53 of file DbAccessObj.h.

◆ iterator

typedef Keys::iterator pool::DbAccessObj< DbObject * , DbObjectHolder >::iterator

inherited

Definition at line 52 of file DbAccessObj.h.

◆ Keys

typedef std::map< DbObject * , DbObjectHolder * > pool::DbAccessObj< DbObject * , DbObjectHolder >::Keys

inherited

Definition at line 51 of file DbAccessObj.h.

◆ ObjHandle

typedef DbObjectHandle<DbObject> pool::DbContainerObj::ObjHandle

private

Definition at line 52 of file DbContainerObj.h.

Constructor & Destructor Documentation

◆ DbContainerObj()

pool::DbContainerObj::DbContainerObj	(	DbDatabase &	dbH,
		const std::string &	nam,
		const DbType &	dbtyp,
		DbAccessMode	mod
	)

Standard constructor of a container object using the Database handle as a clustering hint.

Parameters

dbH	[IN] Valid handle to database object
nam	[IN] Name of the container to be opened.
dbtyp	[IN] Database type (including minor type)
mod	[IN] Access mode.

Returns: Status code indicating success or failure.

◆ ~DbContainerObj()

virtual pool::DbContainerObj::~DbContainerObj ( )

virtual

Standard destructor.

Member Function Documentation

◆ add()

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

◆ addShape()

DbStatus pool::DbContainerObj::addShape ( const DbTypeInfo * typ )

Add persistent type. Returns error if the type is not supported.

◆ allocate() [1/2]

DbStatus pool::DbContainerObj::allocate	(	DbContainer &	cntH,
		const void *	object,
		ShapeH	shape,
		Token::OID_t &	oid
	)

In place allocation of object location.

◆ allocate() [2/2]

void* pool::DbContainerObj::allocate	(	unsigned long	siz,
		DbContainer &	cntH,
		ShapeH	shape
	)

In place allocation of raw memory.

◆ begin() [1/2]

iterator pool::DbAccessObj< DbObject * , DbObjectHolder >::begin

inlineinherited

Definition at line 163 of file DbAccessObj.h.

163 { return m_keys.begin(); }

◆ begin() [2/2]

const_iterator pool::DbAccessObj< DbObject * , DbObjectHolder >::begin

inlineinherited

Definition at line 164 of file DbAccessObj.h.

164 { return m_keys.begin(); }

◆ cancelTransaction()

void pool::DbContainerObj::cancelTransaction ( )

inline

Cancel transaction flag.

Definition at line 99 of file DbContainerObj.h.

99 { }

◆ clearEntries()

DbStatus pool::DbAccessObj< DbObject * , DbObjectHolder >::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::DbContainerObj::close ( )

Close the container.

◆ database()

DbDatabase& pool::DbContainerObj::database ( )

inline

Handle to Database (CONST)

Definition at line 88 of file DbContainerObj.h.

88 { return m_dbH; }

◆ db() [1/2]

IOODatabase* pool::DbAccessObj< DbObject * , DbObjectHolder >::db

inlineinherited

Definition at line 87 of file DbAccessObj.h.

87 { return m_pool; }

◆ db() [2/2]

const IOODatabase* pool::DbAccessObj< DbObject * , DbObjectHolder >::db

inlineinherited

Allow access to the Database implementation.

Definition at line 86 of file DbAccessObj.h.

86 { return m_pool; }

◆ destroy() [1/2]

DbStatus pool::DbContainerObj::destroy ( const Token::OID_t & linkH )

Destroy an existing persistent object identified by its handle.

◆ destroy() [2/2]

DbStatus pool::DbContainerObj::destroy ( DbSelect & sel )

Perform DELETE statement.

◆ end() [1/2]

iterator pool::DbAccessObj< DbObject * , DbObjectHolder >::end

inlineinherited

Definition at line 165 of file DbAccessObj.h.

165 { return m_keys.end(); }

◆ end() [2/2]

const_iterator pool::DbAccessObj< DbObject * , DbObjectHolder >::end

inlineinherited

Definition at line 166 of file DbAccessObj.h.

166 { return m_keys.end(); }

◆ fetch()

DbStatus pool::DbContainerObj::fetch ( DbSelect & sel )

Fetch next object address of the selection to set token.

◆ find() [1/2]

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

◆ free()

DbStatus pool::DbContainerObj::free	(	void *	ptr,
		DbContainer &	cntH
	)

In place free of raw memory.

◆ getOption()

DbStatus pool::DbContainerObj::getOption ( DbOption & refOpt )

Access options.

◆ hasAccess()

bool pool::DbContainerObj::hasAccess ( )

private

Check database access.

◆ info() [1/2]

IDbContainer* pool::DbContainerObj::info ( )

inline

Definition at line 82 of file DbContainerObj.h.

82 { return m_info; }

◆ info() [2/2]

const IDbContainer* pool::DbContainerObj::info ( ) const

inline

Access to internals.

Definition at line 81 of file DbContainerObj.h.

81 { return m_info; }

◆ isOpen()

bool pool::DbContainerObj::isOpen ( ) const

inline

Flag if container was opened.

Definition at line 94 of file DbContainerObj.h.

94 { return m_isOpen; }

◆ isReadOnly()

bool pool::DbContainerObj::isReadOnly ( ) const

inline

Check if database is in read-only mode.

Definition at line 96 of file DbContainerObj.h.

97 { return !(mode()&pool::UPDATE) && !(mode()&pool::CREATE); }

◆ load()

DbStatus pool::DbContainerObj::load	(	void **	ptr,
		ShapeH	shape,
		const Token::OID_t &	linkH,
		Token::OID_t &	oid,
		bool	any_next
	)

Select object in the container identified by its handle.

◆ mode()

DbAccessMode pool::DbAccessObj< DbObject * , DbObjectHolder >::mode

inlineinherited

Access mode.

Definition at line 80 of file DbAccessObj.h.

80 { return m_mode; }

◆ name()

const std::string& pool::DbAccessObj< DbObject * , DbObjectHolder >::name

inlineinherited

Access the instance name.

Definition at line 76 of file DbAccessObj.h.

76 { return m_name; }

◆ objectShape()

const DbTypeInfo* pool::DbContainerObj::objectShape ( const Guid & nam )

Retrieve persistent type information by name.

◆ open()

DbStatus pool::DbContainerObj::open ( const DbTypeInfo * typ )

Open the container.

◆ refCount()

int pool::DbAccessObj< DbObject * , DbObjectHolder >::refCount

inlineinherited

Access reference counter.

Definition at line 89 of file DbAccessObj.h.

89 { return m_refCount; }

◆ release()

int pool::DbAccessObj< DbObject * , DbObjectHolder >::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() [1/2]

DbStatus pool::DbAccessObj< DbObject * , DbObjectHolder >::remove ( const DbObjectHolder * 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;
     }

◆ remove() [2/2]

DbStatus pool::DbContainerObj::remove ( ObjHandle & objH )

Remove the transient representation of the object from memory.

◆ retire()

DbStatus pool::DbContainerObj::retire ( )

Retire the container.

◆ save() [1/2]

DbStatus pool::DbContainerObj::save	(	DbContainer &	cntH,
		const void *	object,
		ShapeH	shape,
		Token::OID_t &	linkH
	)

Save new object in the container and return its handle.

Parameters

cntH	[IN] Handle to container object.
linkH	[OUT] Internal OID to identify object.

Returns: DbStatus code indicating success or failure.

◆ save() [2/2]

DbStatus pool::DbContainerObj::save	(	DbObjectHandle< DbObject > &	objH,
		const DbTypeInfo *	typ
	)

Add an object to the container identified by its handle.

◆ select()

DbStatus pool::DbContainerObj::select ( DbSelect & sel )

Perform selection. The statement belongs to the container afterwards.

◆ setMode()

void pool::DbAccessObj< DbObject * , DbObjectHolder >::setMode ( DbAccessMode m )

inlineinherited

Set Access mode.

Definition at line 82 of file DbAccessObj.h.

82 { m_mode = m; }

◆ setName()

void pool::DbAccessObj< DbObject * , DbObjectHolder >::setName ( const std::string & n )

inlineinherited

Access the instance name.

Definition at line 78 of file DbAccessObj.h.

78 { m_name = n; }

◆ setOption()

DbStatus pool::DbContainerObj::setOption ( const DbOption & opt )

Pass options to the implementation.

◆ size()

uint64_t pool::DbContainerObj::size ( )

Size of the Database container (=# of objects)

◆ token()

const Token* pool::DbContainerObj::token ( ) const

inline

Access the token of the container object.

Definition at line 90 of file DbContainerObj.h.

90 { return m_tokH; }

◆ transAct()

DbStatus pool::DbContainerObj::transAct ( Transaction::Action )

Execute Database Transaction Action.

◆ type()

const DbType& pool::DbAccessObj< DbObject * , DbObjectHolder >::type

inlineinherited

Definition at line 84 of file DbAccessObj.h.

84 { return m_type; }

◆ update() [1/3]

DbStatus pool::DbContainerObj::update	(	DbContainer &	cntH,
		const void *	object,
		ShapeH	shape,
		const DbObjectHandle< DbObject > &	objH
	)

Update existing object in the container.

Parameters

cntH	[IN] Valid handle to container
objH	[IN] Object handle

Returns: Status code indicating success or failure.

◆ update() [2/3]

DbStatus pool::DbContainerObj::update	(	DbContainer &	cntH,
		const void *	object,
		ShapeH	shape,
		const Token::OID_t &	linkH
	)

Update an object to the container identified by its handle.

Parameters

cntH	[IN] Handle to container object.
linkH	[IN] Internal OID to identify object.

Returns: DbStatus code indicating success or failure.

◆ update() [3/3]

DbStatus pool::DbContainerObj::update ( DbSelect & sel )

Perform UPDATE select.

◆ updatesPending()

bool pool::DbContainerObj::updatesPending ( ) const

Query the pending transaction stack.

Member Data Documentation

◆ m_dbH

DbDatabase pool::DbContainerObj::m_dbH

private

Handle to hosting Database.

Definition at line 59 of file DbContainerObj.h.

◆ m_info

IDbContainer* pool::DbContainerObj::m_info

private

Pointer to interface of the technology dependent part.

Definition at line 55 of file DbContainerObj.h.

◆ m_isOpen

bool pool::DbContainerObj::m_isOpen

private

Flag indication DbStatus of technology dependent container.

Definition at line 61 of file DbContainerObj.h.

◆ m_keys

Keys pool::DbAccessObj< DbObject * , DbObjectHolder >::m_keys

privateinherited

Key entry buffer.

Definition at line 64 of file DbAccessObj.h.

◆ m_mode

DbAccessMode pool::DbAccessObj< DbObject * , DbObjectHolder >::m_mode

privateinherited

Access mode.

Definition at line 58 of file DbAccessObj.h.

◆ m_name

std::string pool::DbAccessObj< DbObject * , DbObjectHolder >::m_name

privateinherited

Name of the instance.

Definition at line 60 of file DbAccessObj.h.

◆ m_pool

IOODatabase* pool::DbAccessObj< DbObject * , DbObjectHolder >::m_pool

privateinherited

Pointer to specific pool implementation.

Definition at line 66 of file DbAccessObj.h.

◆ m_refCount

std::atomic<int> pool::DbAccessObj< DbObject * , DbObjectHolder >::m_refCount

mutableprivateinherited

Reference counter.

Definition at line 56 of file DbAccessObj.h.

◆ m_tokH

const Token* pool::DbContainerObj::m_tokH

private

Container token.

Definition at line 57 of file DbContainerObj.h.

◆ m_type

DbType pool::DbAccessObj< DbObject * , DbObjectHolder >::m_type

privateinherited

Database type.

Definition at line 62 of file DbAccessObj.h.

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

DbContainerObj.h

Public Types

Public Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ Base

◆ const_iterator

◆ iterator

◆ Keys

◆ ObjHandle

Constructor & Destructor Documentation

◆ DbContainerObj()

◆ ~DbContainerObj()

Member Function Documentation

◆ add()

◆ addRef()

◆ addShape()

◆ allocate() [1/2]

◆ allocate() [2/2]

◆ begin() [1/2]

◆ begin() [2/2]

◆ cancelTransaction()

◆ clearEntries()

◆ close()

◆ database()

◆ db() [1/2]

◆ db() [2/2]

◆ destroy() [1/2]

◆ destroy() [2/2]

◆ end() [1/2]

◆ end() [2/2]

◆ fetch()

◆ find() [1/2]

◆ find() [2/2]

◆ free()

◆ getOption()

◆ hasAccess()

◆ info() [1/2]

◆ info() [2/2]

◆ isOpen()

◆ isReadOnly()

◆ load()

◆ mode()

◆ name()

◆ objectShape()

◆ open()

◆ refCount()

◆ release()

◆ remove() [1/2]

◆ remove() [2/2]

◆ retire()

◆ save() [1/2]

◆ save() [2/2]

◆ select()

◆ setMode()

◆ setName()

◆ setOption()

◆ size()

◆ token()

◆ transAct()

◆ type()

◆ update() [1/3]

◆ update() [2/3]

◆ update() [3/3]

◆ updatesPending()

Member Data Documentation

◆ m_dbH

◆ m_info

◆ m_isOpen

◆ m_keys

◆ m_mode

◆ m_name

◆ m_pool

◆ m_refCount

◆ m_tokH

◆ m_type