ATLAS Offline Software
Loading...
Searching...
No Matches
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, DbDatabaseObjBase
 Type definitions.
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.
virtual ~DbDomainObj ()
 Standard destructor.
IDbDomaininfo ()
 Access to technology dependent implementation.
const IDbDomaininfo () const
DbSessionsession ()
 Access session handle.
const DbSessionsession () const
void setAgeLimit (int value)
 Set the maximal allowed age limit for files in this domain.
int ageLimit () const
 Access the maximal age limit.
bool existsDbase (const std::string &nam)
 Check for Database existence within domain.
StatusCode open (DbAccessMode mode)
 Open domain with possible change of access mode.
StatusCode open ()
 Open domain in default access mode.
StatusCode close ()
 Close domain.
StatusCode ageOpenDbs ()
 Increase the age of all open databases.
StatusCode closeAgedDbs ()
 Check if databases are present, which aged a lot and need to be closed.
StatusCode setOption (const DbOption &refOpt)
 Set domain specific options.
StatusCode getOption (DbOption &refOpt) const
 Access domain specific options.
const std::string & name () const
 Access the instance name.
void setName (const std::string &n)
 Access the instance name.
DbAccessMode mode () const
 Access mode.
void setMode (DbAccessMode m)
 Set Access mode.
const DbTypetype () const
const IOODatabasedb () const
 Allow access to the Database implementation.
int refCount () const
 Access reference counter.
int addRef () const
 Add reference count.
int release () const
 Remove reference count.
size_t size () const
 Object size.
void clearEntries ()
 Object cleanup: remove all entries.
const DbDatabaseObjfind (const std::string &key) const
 Find object by key (CONST)
StatusCode add (const std::string &key, DbDatabaseObj *val)
 Add entry to container.
StatusCode remove (const DbDatabaseObj *val)
 Remove entry from container.
iterator begin ()
iterator end ()
bool msgLvl (const MSG::Level lvl) const
 Test the output level.
MsgStream & msg () const
 The standard message stream.
MsgStream & msg (const MSG::Level lvl) const
 The standard message stream.
void setLevel (MSG::Level lvl)
 Change the current logging level.

Private Member Functions

void initMessaging () const
 Initialize our message level and MessageSvc.

Private Attributes

DbSession m_session
 Handle to session.
int m_maxAge
 Maximal age of files allowed.
IDbDomainm_info
 Technology dependent stuff.
std::atomic< int > m_refCount
 Reference counter.
DbAccessMode m_mode
 Access mode.
std::string m_name
 Name of the instance.
DbType m_type
 Database type.
Keys m_keys
 Key entry buffer.
IOODatabasem_pool
 Pointer to specific pool implementation.
std::string m_nm
 Message source name.
boost::thread_specific_ptr< MsgStream > m_msg_tls
 MsgStream instance (a std::cout like with print-out levels)
std::atomic< IMessageSvc * > m_imsg { nullptr }
 MessageSvc pointer.
std::atomic< MSG::Level > m_lvl { MSG::NIL }
 Current logging level.
std::atomic_flag m_initialized ATLAS_THREAD_SAFE = ATOMIC_FLAG_INIT
 Messaging initialized (initMessaging)

Detailed Description

Db objects: DbDomainObj.

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

Author
M.Frank
Version
1.0

Definition at line 40 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()

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

Add entry to container.

Definition at line 138 of file DbAccessObj.h.

138 {
140 if ( m_keys.end() == i ) {
141 m_keys.insert(std::make_pair(key, val));
142 val->addRef();
143 return StatusCode::SUCCESS;
144 }
145 return StatusCode::FAILURE;
146 }
Description:
Definition DbAccessObj.h:47
int addRef() const
Add reference count.
Definition DbAccessObj.h:91
const TYPE * find(const KEY &key) const
Find object by key (CONST)

◆ addRef()

int pool::DbAccessObj< std::string, DbDatabaseObj >::addRef ( ) const
inlineinherited

Add reference count.

Definition at line 91 of file DbAccessObj.h.

91 {
92#ifdef DEBUG_REFCOUNTS
93 std::cout << typeid(*this).name()
94 << " "
95 << m_name
96 << " Refcount:"
97 << m_refCount+1
98 << std::endl;
99#endif
100 return ++m_refCount;
101 }
const std::string & name() const
Access the instance name.
Definition DbAccessObj.h:76

◆ ageLimit()

int pool::DbDomainObj::ageLimit ( ) const
inline

Access the maximal age limit.

Definition at line 64 of file DbDomainObj.h.

64{ return m_maxAge; }
int m_maxAge
Maximal age of files allowed.
Definition DbDomainObj.h:45

◆ ageOpenDbs()

StatusCode pool::DbDomainObj::ageOpenDbs ( )

Increase the age of all open databases.

◆ begin()

iterator pool::DbAccessObj< std::string, DbDatabaseObj >::begin ( )
inlineinherited

Definition at line 159 of file DbAccessObj.h.

159{ return m_keys.begin(); }

◆ clearEntries()

void pool::DbAccessObj< std::string, DbDatabaseObj >::clearEntries ( )
inlineinherited

Object cleanup: remove all entries.

Definition at line 123 of file DbAccessObj.h.

123 {
124 for( const auto & k : m_keys ) k.second->release();
125 m_keys.clear();
126 }
int release() const
Remove reference count.

◆ close()

StatusCode pool::DbDomainObj::close ( )

Close domain.

◆ closeAgedDbs()

StatusCode pool::DbDomainObj::closeAgedDbs ( )

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

◆ db()

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

Allow access to the Database implementation.

Definition at line 86 of file DbAccessObj.h.

86{ return m_pool; }

◆ end()

iterator pool::DbAccessObj< std::string, DbDatabaseObj >::end ( )
inlineinherited

Definition at line 161 of file DbAccessObj.h.

161{ return m_keys.end(); }

◆ existsDbase()

bool pool::DbDomainObj::existsDbase ( const std::string & nam)

Check for Database existence within domain.

◆ find()

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

Find object by key (CONST)

Definition at line 128 of file DbAccessObj.h.

128 {
130 return (m_keys.end() == i) ? 0 : (*i).second;
131 }

◆ getOption()

StatusCode pool::DbDomainObj::getOption ( DbOption & refOpt) const

Access domain specific options.

Parameters
refOpt[IN] Reference to option object
Returns
StatusCode indicating success or failure.

◆ info() [1/2]

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

Access to technology dependent implementation.

Definition at line 56 of file DbDomainObj.h.

56{ return m_info; }
IDbDomain * m_info
Technology dependent stuff.
Definition DbDomainObj.h:47

◆ info() [2/2]

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

Definition at line 57 of file DbDomainObj.h.

57{ return m_info; }

◆ initMessaging()

void AthMessaging::initMessaging ( ) const
privateinherited

Initialize our message level and MessageSvc.

This method should only be called once.

Definition at line 39 of file AthMessaging.cxx.

40{
42 // If user did not set an explicit level, set a default
43 if (m_lvl == MSG::NIL) {
44 m_lvl = m_imsg ?
45 static_cast<MSG::Level>( m_imsg.load()->outputLevel(m_nm) ) :
46 MSG::INFO;
47 }
48}
std::string m_nm
Message source name.
std::atomic< IMessageSvc * > m_imsg
MessageSvc pointer.
std::atomic< MSG::Level > m_lvl
Current logging level.
IMessageSvc * getMessageSvc(bool quiet=false)

◆ mode()

DbAccessMode pool::DbAccessObj< std::string, DbDatabaseObj >::mode ( ) const
inlineinherited

Access mode.

Definition at line 80 of file DbAccessObj.h.

80{ return m_mode; }

◆ msg() [1/2]

MsgStream & AthMessaging::msg ( ) const
inlineinherited

The standard message stream.

Returns a reference to the default message stream May not be invoked before sysInitialize() has been invoked.

Definition at line 167 of file AthMessaging.h.

168{
169 MsgStream* ms = m_msg_tls.get();
170 if (!ms) {
171 if (!m_initialized.test_and_set()) initMessaging();
172 ms = new MsgStream(m_imsg,m_nm);
173 m_msg_tls.reset( ms );
174 }
175
176 ms->setLevel (m_lvl);
177 return *ms;
178}
boost::thread_specific_ptr< MsgStream > m_msg_tls
MsgStream instance (a std::cout like with print-out levels)
void initMessaging() const
Initialize our message level and MessageSvc.

◆ msg() [2/2]

MsgStream & AthMessaging::msg ( const MSG::Level lvl) const
inlineinherited

The standard message stream.

Returns a reference to the default message stream May not be invoked before sysInitialize() has been invoked.

Definition at line 182 of file AthMessaging.h.

183{ return msg() << lvl; }
MsgStream & msg() const
The standard message stream.

◆ msgLvl()

bool AthMessaging::msgLvl ( const MSG::Level lvl) const
inlineinherited

Test the output level.

Parameters
lvlThe message level to test against
Returns
boolean Indicating if messages at given level will be printed
Return values
trueMessages at level "lvl" will be printed

Definition at line 151 of file AthMessaging.h.

152{
153 // If user did not set explicit message level we have to initialize
154 // the messaging and retrieve the default via the MessageSvc.
155 if (m_lvl==MSG::NIL && !m_initialized.test_and_set()) initMessaging();
156
157 if (m_lvl <= lvl) {
158 msg() << lvl;
159 return true;
160 } else {
161 return false;
162 }
163}

◆ name()

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

Access the instance name.

Definition at line 76 of file DbAccessObj.h.

76{ return m_name; }

◆ open() [1/2]

StatusCode pool::DbDomainObj::open ( )

Open domain in default access mode.

◆ open() [2/2]

StatusCode pool::DbDomainObj::open ( DbAccessMode mode)

Open domain with possible change of access mode.

◆ refCount()

int pool::DbAccessObj< std::string, DbDatabaseObj >::refCount ( ) const
inlineinherited

Access reference counter.

Definition at line 89 of file DbAccessObj.h.

89{ return m_refCount; }

◆ release()

int pool::DbAccessObj< std::string, DbDatabaseObj >::release ( ) const
inlineinherited

Remove reference count.

Definition at line 103 of file DbAccessObj.h.

103 {
104 int count = --m_refCount;
105#ifdef DEBUG_REFCOUNTS
106 std::cout << typeid(*this).name()
107 << " "
108 << m_name
109 << " Refcount:"
110 << count
111 << std::endl;
112#endif
113 if ( count == 0 ) {
114 delete this;
115 }
116 return count;
117 }

◆ remove()

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

Remove entry from container.

Definition at line 148 of file DbAccessObj.h.

148 {
149 for (iterator j = m_keys.begin(); j != m_keys.end(); ++j ) {
150 if ( (*j).second == val ) {
151 TYPE* p = (*j).second;
152 m_keys.erase(j);
153 p->release();
154 return StatusCode::SUCCESS;
155 }
156 }
157 return StatusCode::FAILURE;
158 }

◆ session() [1/2]

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

Access session handle.

Definition at line 59 of file DbDomainObj.h.

59{ return m_session; }
DbSession m_session
Handle to session.
Definition DbDomainObj.h:43

◆ session() [2/2]

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

Definition at line 60 of file DbDomainObj.h.

60{ 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 62 of file DbDomainObj.h.

62{ m_maxAge = value; }

◆ setLevel()

void AthMessaging::setLevel ( MSG::Level lvl)
inherited

Change the current logging level.

Use this rather than msg().setLevel() for proper operation with MT.

Definition at line 28 of file AthMessaging.cxx.

29{
30 m_lvl = lvl;
31}

◆ setMode()

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

Set Access mode.

Definition at line 82 of file DbAccessObj.h.

82{ 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.

78{ m_name = n; }

◆ setOption()

StatusCode pool::DbDomainObj::setOption ( const DbOption & refOpt)

Set domain specific options.

Parameters
refOpt[IN] Reference to option object
Returns
StatusCode indicating success or failure.

◆ size()

size_t pool::DbAccessObj< std::string, DbDatabaseObj >::size ( ) const
inlineinherited

Object size.

Definition at line 119 of file DbAccessObj.h.

119 {
120 return m_keys.size();
121 }
size_t size() const
Object size.

◆ type()

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

Definition at line 84 of file DbAccessObj.h.

84{ return m_type; }

Member Data Documentation

◆ ATLAS_THREAD_SAFE

std::atomic_flag m_initialized AthMessaging::ATLAS_THREAD_SAFE = ATOMIC_FLAG_INIT
mutableprivateinherited

Messaging initialized (initMessaging)

Definition at line 141 of file AthMessaging.h.

◆ m_imsg

std::atomic<IMessageSvc*> AthMessaging::m_imsg { nullptr }
mutableprivateinherited

MessageSvc pointer.

Definition at line 135 of file AthMessaging.h.

135{ nullptr };

◆ m_info

IDbDomain* pool::DbDomainObj::m_info
private

Technology dependent stuff.

Definition at line 47 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_lvl

std::atomic<MSG::Level> AthMessaging::m_lvl { MSG::NIL }
mutableprivateinherited

Current logging level.

Definition at line 138 of file AthMessaging.h.

138{ MSG::NIL };

◆ m_maxAge

int pool::DbDomainObj::m_maxAge
private

Maximal age of files allowed.

Definition at line 45 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_msg_tls

boost::thread_specific_ptr<MsgStream> AthMessaging::m_msg_tls
mutableprivateinherited

MsgStream instance (a std::cout like with print-out levels)

Definition at line 132 of file AthMessaging.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_nm

std::string AthMessaging::m_nm
privateinherited

Message source name.

Definition at line 129 of file AthMessaging.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 43 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: