UserSession is an implementation of the ISession interface. More...

#include <UserSession.h>

Inheritance diagram for pool::UserSession:

Collaboration diagram for pool::UserSession:

Public Member Functions
	UserSession (IFileCatalog &fileCatalog, int ageLimit)
	Constructor.
virtual	~UserSession ()
	Destructor.
	UserSession (const UserSession &)=delete
UserSession &	operator= (const UserSession &)=delete
virtual void *	readObject (const Token &token, void *object=0) override
	Retrieves an object from persistent store and return with type information The handle to the reflection class is necessary to later delete the object.
virtual Token *	registerForWrite (const Placement &place, const void *object, const RootType &type) override
	registerForWrite registers an object for writing to the persistent medium higher level interactions with the framework are necessary.
DatabaseRegistry &	registry ()
virtual bool	disconnectAll () override final
	Explicitly disconnects all the databases.
virtual bool	start (Io::IoFlag type=Io::READ) override final
	Starts a new transaction. Returns the success of the operation.
virtual bool	commit () override final
	Commits the transaction.
virtual bool	commitAndHold () override final
	Commits and holds the transaction.
virtual Io::IoFlag	type () const override final
	Returns the transaction type.
virtual std::unique_ptr< IDatabase >	databaseHandle (const std::string &dbName, DatabaseSpecification::NameType dbNameType) override final
	Creates and returns a new database handle object.
virtual IFileCatalog &	fileCatalog ()
	Returns the file catalog in use.
virtual ITechnologySpecificAttributes &	technologySpecificAttributes (long technology) override final
	Returns the object holding the technology specific attributes for a given technology domain.
MicroSessionManager &	microSessionManager (long technology)
	Returns the technology given a technology type.
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
IFileCatalog *	m_catalog
int	m_ageLimit
DatabaseRegistry *	m_registry
Io::IoFlag	m_transactionType
std::map< long, std::unique_ptr< MicroSessionManager > >	m_technologies
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

UserSession is an implementation of the ISession interface.

Definition at line 26 of file UserSession.h.

Constructor & Destructor Documentation

◆ UserSession() [1/2]

pool::UserSession::UserSession	(	pool::IFileCatalog &	fileCatalog,
		int	ageLimit )

explicit

Constructor.

Definition at line 22 of file UserSession.cxx.

                                                                         :
  APRMessaging( "APR Session" ),
  m_catalog( &fileCatalog ),
  m_ageLimit( ageLimit ),
  m_registry( 0 ),
  m_transactionType( Io::INVALID )
{
  m_registry = new pool::DatabaseRegistry();
}

◆ ~UserSession()

pool::UserSession::~UserSession ( )

virtual

Destructor.

Definition at line 32 of file UserSession.cxx.

{
  // order is important
  m_technologies.clear();
  delete m_registry;
}

◆ UserSession() [2/2]

pool::UserSession::UserSession ( const UserSession & )

delete

Member Function Documentation

◆ commit()

bool pool::UserSession::commit ( )

finaloverridevirtual

Commits the transaction.

Implements pool::ISession.

Definition at line 100 of file UserSession.cxx.

{
  if( m_transactionType != Io::INVALID ) {
    bool OK = true;
    for( auto db : *m_registry ) {
      bool bCommit = db->commitTransaction(); // This has to be replaced with a two phase commit
      if ( ! bCommit ) {
        ATH_MSG_ERROR("Could not commit the transaction for the database with:" << endmsg
                      << "FID = " << db->fid() << endmsg   << "PFN = " << db->pfn() );
      }
      OK = OK && bCommit;
    }
    m_transactionType = Io::INVALID;
    return OK;
  }
  return false;
}

◆ commitAndHold()

bool pool::UserSession::commitAndHold ( )

finaloverridevirtual

Commits and holds the transaction.

Implements pool::ISession.

Definition at line 120 of file UserSession.cxx.

{
  if( m_transactionType != Io::INVALID ) {
    bool OK = true;
    for( auto db : *m_registry ) {
      bool bCommit = db->commitAndHoldTransaction(); // This has to be replaced with a two phase commit
      if ( ! bCommit ) {
        ATH_MSG_ERROR("Could not commit and hold the transaction for the database with:" << endmsg
            << "FID = " << db->fid() << endmsg  << "PFN = " << db->pfn() );
      }
      OK = OK && bCommit;
    }
    return OK;
  }
  return false;
}

◆ databaseHandle()

std::unique_ptr< pool::IDatabase > pool::UserSession::databaseHandle	(	const std::string &	dbName,
		DatabaseSpecification::NameType	dbNameType )

finaloverridevirtual

Creates and returns a new database handle object.

Implements pool::ISession.

Definition at line 140 of file UserSession.cxx.

{
  if( m_transactionType != Io::INVALID ) {
     return std::make_unique<UserDatabase>( *this, dbName, dbNameType );
  }
  return nullptr;
}

◆ disconnectAll()

bool pool::UserSession::disconnectAll ( )

finaloverridevirtual

Explicitly disconnects all the databases.

If a transaction is active, then all the changes since the last commit are aborted.

Implements pool::ISession.

Definition at line 80 of file UserSession.cxx.

{
  bool ret = true;
  for( auto& iManager : m_technologies ) {
    if( !iManager.second->disconnectAll() ) ret = false;
  }
  return ret;
}

◆ fileCatalog()

pool::IFileCatalog & pool::UserSession::fileCatalog ( )

virtual

Returns the file catalog in use.

Definition at line 150 of file UserSession.cxx.

{
  return *m_catalog;
}

◆ 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.

{
  m_imsg = Athena::getMessageSvc();
  // If user did not set an explicit level, set a default
  if (m_lvl == MSG::NIL) {
    m_lvl = m_imsg ?
      static_cast<MSG::Level>( m_imsg.load()->outputLevel(m_nm) ) :
      MSG::INFO;
  }
}

◆ microSessionManager()

pool::MicroSessionManager & pool::UserSession::microSessionManager ( long technology )

Returns the technology given a technology type.

Definition at line 156 of file UserSession.cxx.

{
  pool::DbType dbType( technology );
  long majorType = dbType.majorType();
  auto iManager = m_technologies.find( majorType );
  if ( iManager != m_technologies.end() ) {
    return *(iManager->second);
  }
  // Technology does not exist. Create the new session.
  auto mgr = new pool::MicroSessionManager( *m_registry, majorType );
  m_technologies.insert( std::make_pair( majorType, mgr ) );
  mgr->connect( m_transactionType, m_ageLimit );
  return *mgr;
}

◆ 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.

{
  MsgStream* ms = m_msg_tls.get();
  if (!ms) {
    if (!m_initialized.test_and_set()) initMessaging();
    ms = new MsgStream(m_imsg,m_nm);
    m_msg_tls.reset( ms );
  }
 
  ms->setLevel (m_lvl);
  return *ms;
}

◆ 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; }

AthMessaging::msg

MsgStream & msg() const

The standard message stream.

Definition AthMessaging.h:167

◆ msgLvl()

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

inlineinherited

Test the output level.

Parameters

lvl	The message level to test against

Returns: boolean Indicating if messages at given level will be printed

Return values

true	Messages at level "lvl" will be printed

Definition at line 151 of file AthMessaging.h.

{
  // If user did not set explicit message level we have to initialize
  // the messaging and retrieve the default via the MessageSvc.
  if (m_lvl==MSG::NIL && !m_initialized.test_and_set()) initMessaging();
 
  if (m_lvl <= lvl) {
    msg() << lvl;
    return true;
  } else {
    return false;
  }
}

◆ operator=()

UserSession & pool::UserSession::operator= ( const UserSession & )

delete

◆ readObject()

void * pool::UserSession::readObject	(	const Token &	token,
		void *	object = 0 )

overridevirtual

Retrieves an object from persistent store and return with type information The handle to the reflection class is necessary to later delete the object.

The Guid of the transient class is assumed to be the classID of the token

Parameters

token	[IN] reference to the token for the object
object	[IN] pointer to memory for the object (created if 0)

Returns: void* The data.

In case of failure zero is returned.

Implements pool::ISession.

Definition at line 41 of file UserSession.cxx.

{
  void* result {};
  if( m_transactionType != Io::INVALID ) {
    UserDatabase db( *this, token.dbID().toString(), pool::DatabaseSpecification::FID );
    if ( db.openMode() == Io::INVALID ) {
      db.setTechnology( token.technology() );
      db.connectForRead();
    }
    result = db.readObject( token, object );
  }
  return result;
}

◆ registerForWrite()

Token * pool::UserSession::registerForWrite	(	const Placement &	place,
		const void *	object,
		const RootType &	type )

overridevirtual

registerForWrite registers an object for writing to the persistent medium higher level interactions with the framework are necessary.

Parameters

place	[IN] the placement hint
object	[IN] pointer to transient object which will be written
type	[IN] reflection class description with the layout of transient object

Returns: Token* the token address of the persistent object. I case of failure 0 is returned.

Implements pool::ISession.

Definition at line 56 of file UserSession.cxx.

{
  if( m_transactionType != Io::WRITE && m_transactionType != Io::APPEND ) {
    return 0;
  }
  UserDatabase db( *this, place.fileName(), pool::DatabaseSpecification::PFN );
  if ( db.openMode() == Io::INVALID ) {
    db.setTechnology( place.technology() );
    db.connectForWrite();
  }
  return db.writeObject( place.containerName(), place.technology(), object, type );
}

◆ registry()

pool::DatabaseRegistry & pool::UserSession::registry ( )

Definition at line 73 of file UserSession.cxx.

{
  return *m_registry;
}

◆ 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.

{
  m_lvl = lvl;
}

◆ start()

bool pool::UserSession::start ( Io::IoFlag type = Io::READ )

finaloverridevirtual

Starts a new transaction. Returns the success of the operation.

Implements pool::ISession.

Definition at line 91 of file UserSession.cxx.

{
  if( m_transactionType != Io::INVALID ) return false;
  m_transactionType = type;
  return true;
}

◆ technologySpecificAttributes()

pool::ITechnologySpecificAttributes & pool::UserSession::technologySpecificAttributes ( long technology )

finaloverridevirtual

Returns the object holding the technology specific attributes for a given technology domain.

Implements pool::ISession.

Definition at line 172 of file UserSession.cxx.

{
  pool::MicroSessionManager& mgr = microSessionManager( technology );
  mgr.connect( m_transactionType, m_ageLimit );
  return mgr;
}

◆ type()

virtual Io::IoFlag pool::UserSession::type ( ) const

inlinefinaloverridevirtual

Returns the transaction type.

Implements pool::ISession.

Definition at line 83 of file UserSession.h.

83{ return m_transactionType; }

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_ageLimit

int pool::UserSession::m_ageLimit

private

Definition at line 101 of file UserSession.h.

◆ m_catalog

IFileCatalog* pool::UserSession::m_catalog

private

Definition at line 100 of file UserSession.h.

◆ m_imsg

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

mutableprivateinherited

MessageSvc pointer.

Definition at line 135 of file AthMessaging.h.

135{ nullptr };

◆ 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_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_nm

std::string AthMessaging::m_nm

privateinherited

Message source name.

Definition at line 129 of file AthMessaging.h.

◆ m_registry

DatabaseRegistry* pool::UserSession::m_registry

private

Definition at line 102 of file UserSession.h.

◆ m_technologies

std::map< long, std::unique_ptr<MicroSessionManager> > pool::UserSession::m_technologies

private

Definition at line 104 of file UserSession.h.

◆ m_transactionType

Io::IoFlag pool::UserSession::m_transactionType

private

Definition at line 103 of file UserSession.h.

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

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ UserSession() [1/2]

◆ ~UserSession()

◆ UserSession() [2/2]

Member Function Documentation

◆ commit()

◆ commitAndHold()

◆ databaseHandle()

◆ disconnectAll()

◆ fileCatalog()

◆ initMessaging()

◆ microSessionManager()

◆ msg() [1/2]

◆ msg() [2/2]

◆ msgLvl()

◆ operator=()

◆ readObject()

◆ registerForWrite()

◆ registry()

◆ setLevel()

◆ start()

◆ technologySpecificAttributes()

◆ type()

Member Data Documentation

◆ ATLAS_THREAD_SAFE

◆ m_ageLimit

◆ m_catalog

◆ m_imsg

◆ m_lvl

◆ m_msg_tls

◆ m_nm

◆ m_registry

◆ m_technologies

◆ m_transactionType