Bdb packages | Design docs | Source docs | Guidelines | Recent releases

Search | Site Map .
Main Page   Modules   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

BdbImplDomainOODB Class Reference
[BdbDomainOODB]

#include <BdbImplDomainOODB.hh>

Inheritance diagram for BdbImplDomainOODB:

BdbApplDomain BdbObjyDomain List of all members.

Public Methods

 BdbImplDomainOODB ()
virtual ~BdbImplDomainOODB ()
virtual const char * label () const=0
virtual d_Boolean oodbIsInitialized () const=0
virtual d_ULong fileDescriptors () const=0
virtual d_ULong cacheInitPages () const=0
virtual d_ULong cacheMaxPages () const=0
virtual BdbAMSUsage amsUsage () const=0
virtual d_Boolean isStandalone () const=0
virtual d_Boolean isSingleFed () const=0
virtual d_Boolean checkVTablePointer () const=0
virtual const char * bootName () const=0
virtual const char * hostName () const=0
virtual const char * dirName () const=0
virtual BdbHandle (BdbFDObj)&fd() const=0
virtual d_Boolean isActive () const=0
virtual BdbStatus activate () const=0
virtual BdbStatus deactivate () const=0
virtual BdbDomainOODB * activeClient () const=0
virtual BdbIndexMode indexMode () const=0
virtual BdbMode mrowMode () const=0
virtual d_Boolean hasInhibitPolicy () const=0
virtual d_Boolean hotMode () const=0
virtual d_Long lockWait () const=0
virtual d_Long rpcTimeout () const=0
virtual BdbTransId transId () const=0
virtual BdbTransToken currentTransToken () const=0
virtual d_Boolean currentTransIsHeld () const=0
virtual BdbMode mode () const=0
virtual const char * modeName () const=0
virtual const char * modeName (BdbMode mode) const=0
virtual void setClient (BdbDomainOODB &client)=0
virtual void setFileDescriptors (d_ULong nFiles)=0
virtual void setCacheInitPages (d_ULong nPages)=0
virtual void setCacheMaxPages (d_ULong nPages)=0
virtual void setAMSUsage (BdbAMSUsage amsUsage)=0
virtual void setStandalone ()=0
virtual void setSingleFed ()=0
virtual void setDefaultBootName (const char *name)=0
virtual void setCheckVTablePointer (d_Boolean checkVptr)=0
virtual void setIgnoreErrors (d_Boolean ignoreError)=0
virtual void setBootName (const char *name)=0
virtual BdbHandleCacheMgr * currentHandleCache ()=0
virtual void setIndexMode (BdbIndexMode indexMode)=0
virtual void setMrowMode (BdbMode mrowMode)=0
virtual BdbStatus startRead (const char *label=0)=0
virtual BdbStatus startUpdate (const char *label=0)=0
virtual BdbStatus abort (const char *label=0)=0
virtual BdbStatus commit (const char *label=0)=0
virtual BdbStatus commitAndHold (const char *label=0)=0
virtual BdbStatus checkPoint (BdbCheckPointFunc &func, const char *theTag=0)=0
virtual BdbMode change (BdbMode mode, d_Boolean forceCommit=d_False, const char *label=0)=0
virtual BdbStatus closeAllAndReopen (BdbNoOpenTransFunc &func, const char *label=0)=0
virtual void setInhibitPolicy (const BdbInhibitPolicy *policy)=0
virtual void setHotMode (d_Boolean hotMode)=0
virtual void setLockWait (d_Long waitOption)=0
virtual void setRpcTimeout (d_Long rpcTimeout)=0
virtual void holdCurrentTrans ()=0
virtual void dropCurrentTrans ()=0
virtual void setCurrentTrans (const BdbTransToken &token)=0
virtual BdbTransToken newCurrentTrans ()=0
virtual BdbTransToken newCurrentTrans (const char *newBootName)=0
virtual BdbNestingOptToken issueOptToken ()=0
virtual void releaseOptToken (BdbNestingOptToken optToken=BdbcInValidNestingOptToken)=0
virtual BdbStatus startNestedRead (BdbNestingOptToken optToken=BdbcInValidNestingOptToken)=0
virtual BdbStatus startNestedUpdate (BdbNestingOptToken optToken=BdbcInValidNestingOptToken)=0
virtual BdbStatus commitNested (BdbNestingOptToken optToken=BdbcInValidNestingOptToken)=0

Private Methods

 BdbImplDomainOODB (const BdbImplDomainOODB &aRhs)
const BdbImplDomainOODB & operator= (const BdbImplDomainOODB &aRhs)

Detailed Description

The BdbImplDomainOODB class defines the interface used by BdbDOmainOODB to implement its responisibilies.

Definition at line 63 of file BdbImplDomainOODB.hh.

Constructor & Destructor Documentation

BdbImplDomainOODB::BdbImplDomainOODB (    ) 
 

Constructs an instanace of this class.

Definition at line 65 of file BdbImplDomainOODB.cc.

BdbImplDomainOODB::~BdbImplDomainOODB (    )  [virtual]
 

Destroys this instance.

Definition at line 77 of file BdbImplDomainOODB.cc.

BdbImplDomainOODB::BdbImplDomainOODB (  const BdbImplDomainOODB &    aRhs )  [private]
 

stops default

Member Function Documentation

virtual BdbStatus BdbImplDomainOODB::abort (  const char *    label = 0 )  [pure virtual]
 

Aborts the transaction

Implemented in BdbApplDomain, and BdbObjyDomain.

Referenced by BdbDomainOODB::abort().

virtual BdbStatus BdbImplDomainOODB::activate (    )  [pure virtual]
 

Make the Domain the currently active one, and pushing any proceeding Domain activation onto a LIFO stack

Implemented in BdbApplDomain, and BdbObjyDomain.

Referenced by BdbDomainOODB::activate().

virtual BdbDomainOODB* BdbImplDomainOODB::activeClient (    )  [pure virtual]
 

Returns:
client object for currently 'active' implmentation

Implemented in BdbApplDomain, and BdbObjyDomain.

Referenced by BdbDomainOODB::activeDomainOODB().

virtual BdbAMSUsage BdbImplDomainOODB::amsUsage (    )  [pure virtual]
 

Returns:
the AMS usage for the job

Implemented in BdbApplDomain, and BdbObjyDomain.

Referenced by BdbDomainOODB::amsUsage().

virtual BdbImplDomainOODB::BdbHandle (  BdbFDObj    )  const [pure virtual]
 

Returns:
a BdbHandle to the federation, this is null is a transaction is no in progress.

Implemented in BdbApplDomain, and BdbObjyDomain.

virtual const char* BdbImplDomainOODB::bootName (    )  [pure virtual]
 

Returns:
a pointer to the name of the boot file used by the transaction

Implemented in BdbApplDomain, and BdbObjyDomain.

Referenced by BdbDomainOODB::bootName().

virtual d_ULong BdbImplDomainOODB::cacheInitPages (    )  [pure virtual]
 

Returns:
the number of cache pages for Domains transaction to initially use

Implemented in BdbApplDomain, and BdbObjyDomain.

Referenced by BdbDomainOODB::cacheInitPages().

virtual d_ULong BdbImplDomainOODB::cacheMaxPages (    )  [pure virtual]
 

Returns:
the maximum number of cache pages for Domains transaction to use

Implemented in BdbApplDomain, and BdbObjyDomain.

Referenced by BdbDomainOODB::cacheMaxPages().

virtual BdbMode BdbImplDomainOODB::change (  BdbMode    mode,
d_Boolean    forceCommit = d_False,
const char *    label = 0
)  [pure virtual]
 

Changes the type of transaction, committing it if necessary

Implemented in BdbApplDomain, and BdbObjyDomain.

Referenced by BdbDomainOODB::change().

virtual BdbStatus BdbImplDomainOODB::checkPoint (  BdbCheckPointFunc &    func,
const char *    theTag = 0
)  [pure virtual]
 

Commit the current transaction,, the specified BdbCheckPointFunc object is executed, and then the transaction is restarted. The current locks may or may not be held depending on the circumstances. (If the locks _must_ be held the use 'commitAndHold'.)

Implemented in BdbApplDomain, and BdbObjyDomain.

Referenced by BdbDomainOODB::checkPoint().

virtual d_Boolean BdbImplDomainOODB::checkVTablePointer (    )  [pure virtual]
 

Returns:
true if the vtable pointers are being checked

Implemented in BdbApplDomain, and BdbObjyDomain.

Referenced by BdbDomainOODB::isVTablePointerChecked().

virtual BdbStatus BdbImplDomainOODB::closeAllAndReopen (  BdbNoOpenTransFunc &    func,
const char *    label = 0
)  [pure virtual]
 

If all open transactions are read transaction, with the exception of transactions in this domain, then all transactions are commited, the specified BdbNoOpenTransFunc object is executed, and then all transactions are restored to their original state.

Only returns if succeeds (Include return for backwards compatibility.)

Returns:
BdbcSuccess

Implemented in BdbApplDomain, and BdbObjyDomain.

Referenced by BdbDomainOODB::closeAllAndReopen().

virtual BdbStatus BdbImplDomainOODB::commit (  const char *    label = 0 )  [pure virtual]
 

Commits the transaction

Only returns if succeeds (Include return for backwards compatibility.)

Returns:
BdbcSuccess

Implemented in BdbApplDomain, and BdbObjyDomain.

Referenced by BdbDomainOODB::commit().

virtual BdbStatus BdbImplDomainOODB::commitAndHold (  const char *    label = 0 )  [pure virtual]
 

Commits the transaction but does not release its locks

Implemented in BdbApplDomain, and BdbObjyDomain.

Referenced by BdbDomainOODB::commitAndHold().

virtual BdbStatus BdbImplDomainOODB::commitNested (  BdbNestingOptToken    optToken = BdbcInValidNestingOptToken )  [pure virtual]
 

commit currently nested transaction

Implemented in BdbApplDomain, and BdbObjyDomain.

Referenced by BdbDomainOODB::commitNested().

virtual BdbHandleCacheMgr* BdbImplDomainOODB::currentHandleCache (    )  [pure virtual]
 

Returns:
the BdbHandleCacheMgr used by the present transaction (this may be a nested transaction)

Implemented in BdbApplDomain, and BdbObjyDomain.

Referenced by BdbDomainOODB::currentHandleCache().

virtual d_Boolean BdbImplDomainOODB::currentTransIsHeld (    )  [pure virtual]
 

Returns:
true is token represents a locked transaction

Implemented in BdbApplDomain, and BdbObjyDomain.

Referenced by BdbDomainOODB::currentTransIsHeld().

virtual BdbTransToken BdbImplDomainOODB::currentTransToken (    )  [pure virtual]
 

Returns:
a token identifying the current transaction

Implemented in BdbApplDomain, and BdbObjyDomain.

Referenced by BdbDomainOODB::currentTransToken().

virtual BdbStatus BdbImplDomainOODB::deactivate (    )  [pure virtual]
 

Make the proceeding Domain activation (taken from the LIFO stack) the active one.

Implemented in BdbApplDomain, and BdbObjyDomain.

Referenced by BdbDomainOODB::deactivate().

virtual const char* BdbImplDomainOODB::dirName (    )  [pure virtual]
 

Returns:
a pointer to the name of the directory holding the FDDB file of the federation used by the transaction

Implemented in BdbApplDomain, and BdbObjyDomain.

Referenced by BdbDomainOODB::dirName().

virtual void BdbImplDomainOODB::dropCurrentTrans (    )  [pure virtual]
 

Flags the current Transaction so that it will be deleted.

Implemented in BdbApplDomain, and BdbObjyDomain.

Referenced by BdbDomainOODB::dropCurrentTrans().

virtual d_ULong BdbImplDomainOODB::fileDescriptors (    )  [pure virtual]
 

Returns:
the value to be used when initializing OODB

Implemented in BdbApplDomain, and BdbObjyDomain.

Referenced by BdbDomainOODB::fileDescriptors().

virtual d_Boolean BdbImplDomainOODB::hasInhibitPolicy (    )  [pure virtual]
 

Returns:
true is this Domain already has a BdbInhibitPolicy

Implemented in BdbApplDomain, and BdbObjyDomain.

Referenced by BdbDomainOODB::hasInhibitPolicy().

virtual void BdbImplDomainOODB::holdCurrentTrans (    )  [pure virtual]
 

Flags the current Transaction so that it will not be deleted.

Implemented in BdbApplDomain, and BdbObjyDomain.

Referenced by BdbDomainOODB::holdCurrentTrans().

virtual const char* BdbImplDomainOODB::hostName (    )  [pure virtual]
 

Returns:
a pointer to the name of the host holding the FDDB file of the federation used by the transaction

Implemented in BdbApplDomain, and BdbObjyDomain.

Referenced by BdbDomainOODB::hostName().

virtual d_Boolean BdbImplDomainOODB::hotMode (    )  [pure virtual]
 

Returns:
the Hot-Mode status for the transaction in progress

Implemented in BdbApplDomain, and BdbObjyDomain.

virtual BdbIndexMode BdbImplDomainOODB::indexMode (    )  [pure virtual]
 

Returns:
the indexing mode to use are next 'start'

Implemented in BdbApplDomain, and BdbObjyDomain.

Referenced by BdbDomainOODB::indexMode().

virtual d_Boolean BdbImplDomainOODB::isActive (    )  [pure virtual]
 

Returns:
true if this Domain is currently active

Implemented in BdbApplDomain, and BdbObjyDomain.

Referenced by BdbDomainOODB::isActive().

virtual d_Boolean BdbImplDomainOODB::isSingleFed (    )  [pure virtual]
 

Returns:
true if single federation is going to be used

Implemented in BdbApplDomain, and BdbObjyDomain.

virtual d_Boolean BdbImplDomainOODB::isStandalone (    )  [pure virtual]
 

Returns:
true if jobs is standalone

Implemented in BdbApplDomain, and BdbObjyDomain.

Referenced by BdbDomainOODB::isStandalone().

virtual BdbNestingOptToken BdbImplDomainOODB::issueOptToken (    )  [pure virtual]
 

Returns:
an token that may be used to optimize access to the OODB by a nested transaction

Implemented in BdbApplDomain, and BdbObjyDomain.

Referenced by BdbDomainOODB::issueOptToken().

virtual const char* BdbImplDomainOODB::label (    )  [pure virtual]
 

Returns:
the domain's label

Implemented in BdbApplDomain, and BdbObjyDomain.

Referenced by BdbDomainOODB::activate(), BdbDomainOODB::deactivate(), and BdbDomainOODB::matchLabel().

virtual d_Long BdbImplDomainOODB::lockWait (    )  [pure virtual]
 

Returns:
the type of behavior when waiting for locks, for transaction in progress

Implemented in BdbApplDomain, and BdbObjyDomain.

Referenced by BdbDomainOODB::lockWait().

virtual BdbMode BdbImplDomainOODB::mode (    )  [pure virtual]
 

Returns:
the current mode of the transaction

Implemented in BdbApplDomain, and BdbObjyDomain.

Referenced by BdbDomainOODB::mode(), and BdbDomainOODB::transIsOpen().

virtual const char* BdbImplDomainOODB::modeName (  BdbMode    mode )  const [pure virtual]
 

Returns:
string describing specified mode

Implemented in BdbApplDomain, and BdbObjyDomain.

virtual const char* BdbImplDomainOODB::modeName (    )  [pure virtual]
 

Returns:
string describing current mode of the transaction

Implemented in BdbApplDomain, and BdbObjyDomain.

Referenced by BdbDomainOODB::modeName().

virtual BdbMode BdbImplDomainOODB::mrowMode (    )  [pure virtual]
 

Returns:
the indexing mode to use are next 'start'

Implemented in BdbApplDomain, and BdbObjyDomain.

Referenced by BdbDomainOODB::mrowMode().

virtual BdbTransToken BdbImplDomainOODB::newCurrentTrans (  const char *    newBootName )  [pure virtual]
 

Implemented in BdbApplDomain, and BdbObjyDomain.

virtual BdbTransToken BdbImplDomainOODB::newCurrentTrans (    )  [pure virtual]
 

Replaced current trans with a new one, deleting the old if it is not 'held'

Returns:
the token of the old transaction if it is held, otherwise BdbcInValidTransToken

Implemented in BdbApplDomain, and BdbObjyDomain.

Referenced by BdbDomainOODB::newCurrentTrans().

virtual d_Boolean BdbImplDomainOODB::oodbIsInitialized (    )  [pure virtual]
 

Returns:
true is the OODBMS has been initialized

Implemented in BdbApplDomain, and BdbObjyDomain.

Referenced by BdbDomainOODB::oodbIsInitialized().

const BdbImplDomainOODB& BdbImplDomainOODB::operator= (  const BdbImplDomainOODB &    aRhs )  [private]
 

stops default

virtual void BdbImplDomainOODB::releaseOptToken (  BdbNestingOptToken    optToken = BdbcInValidNestingOptToken )  [pure virtual]
 

Signal that the specified token is not longer needs

Implemented in BdbApplDomain, and BdbObjyDomain.

Referenced by BdbDomainOODB::releaseOptToken().

virtual d_Long BdbImplDomainOODB::rpcTimeout (    )  [pure virtual]
 

Returns:
the RPC timeout for the job

Implemented in BdbApplDomain, and BdbObjyDomain.

Referenced by BdbDomainOODB::rpcTimeout().

virtual void BdbImplDomainOODB::setAMSUsage (  BdbAMSUsage    amsUsage )  [pure virtual]
 

Set the AMS usage for the job

Implemented in BdbApplDomain, and BdbObjyDomain.

Referenced by BdbDomainOODB::setAMSUsage().

virtual void BdbImplDomainOODB::setBootName (  const char *    name )  [pure virtual]
 

Set the boot file name to be used by this transaction.

Implemented in BdbApplDomain, and BdbObjyDomain.

Referenced by BdbDomainOODB::setBootName().

virtual void BdbImplDomainOODB::setCacheInitPages (  d_ULong    nPages )  [pure virtual]
 

Set up the number of cache pages for Domains transaction to initially use

Implemented in BdbApplDomain, and BdbObjyDomain.

Referenced by BdbDomainOODB::setCacheInitPages().

virtual void BdbImplDomainOODB::setCacheMaxPages (  d_ULong    nPages )  [pure virtual]
 

Set up the maximum number of cache pages for Domains transaction to use

Implemented in BdbApplDomain, and BdbObjyDomain.

Referenced by BdbDomainOODB::setCacheMaxPages().

virtual void BdbImplDomainOODB::setCheckVTablePointer (  d_Boolean    checkVptr )  [pure virtual]
 

Set the flag indication whether to check the VTable pointer

Implemented in BdbApplDomain, and BdbObjyDomain.

Referenced by BdbDomainOODB::setCheckVTablePointer().

virtual void BdbImplDomainOODB::setClient (  BdbDomainOODB &    client )  [pure virtual]
 

Set the client of the BdbImplDomainOODB, used as the return value for 'activeClient()'.

Implemented in BdbApplDomain, and BdbObjyDomain.

Referenced by BdbDomainOODB::BdbDomainOODB().

virtual void BdbImplDomainOODB::setCurrentTrans (  const BdbTransToken &    token )  [pure virtual]
 

Sets the current BdbTransToken to be used by this instance whenever it is active.

Implemented in BdbApplDomain, and BdbObjyDomain.

Referenced by BdbDomainOODB::setCurrentTrans().

virtual void BdbImplDomainOODB::setDefaultBootName (  const char *    name )  [pure virtual]
 

Set the boot file name to be used as base federation for job.

Implemented in BdbApplDomain, and BdbObjyDomain.

Referenced by BdbDomainOODB::setDefaultBootName().

virtual void BdbImplDomainOODB::setFileDescriptors (  d_ULong    nFiles )  [pure virtual]
 

Set up the number of file descriptors to be used by each ooContext instance

Implemented in BdbApplDomain, and BdbObjyDomain.

Referenced by BdbDomainOODB::setFileDescriptors().

virtual void BdbImplDomainOODB::setHotMode (  d_Boolean    hotMode )  [pure virtual]
 

Sets the Hot-Mode status for the transaction in progress

Implemented in BdbApplDomain, and BdbObjyDomain.

virtual void BdbImplDomainOODB::setIgnoreErrors (  d_Boolean    ignoreError )  [pure virtual]
 

Set the flag indication whether errors with be ignored

Implemented in BdbApplDomain, and BdbObjyDomain.

Referenced by BdbDomainOODB::ignoreErrors(), and BdbDomainOODB::noticeErrors().

virtual void BdbImplDomainOODB::setIndexMode (  BdbIndexMode    indexMode )  [pure virtual]
 

Sets the indexing mode to use are next 'start'

Implemented in BdbApplDomain, and BdbObjyDomain.

Referenced by BdbDomainOODB::setIndexMode().

virtual void BdbImplDomainOODB::setInhibitPolicy (  const BdbInhibitPolicy *    policy )  [pure virtual]
 

Set the BdbInhibtPolicy to be used by this Domain

Implemented in BdbApplDomain, and BdbObjyDomain.

Referenced by BdbDomainOODB::setInhibitPolicy().

virtual void BdbImplDomainOODB::setLockWait (  d_Long    waitOption )  [pure virtual]
 

Sets the type of behavior when waiting for locks, for transaction in progress

Implemented in BdbApplDomain, and BdbObjyDomain.

Referenced by BdbDomainOODB::setLockWait().

virtual void BdbImplDomainOODB::setMrowMode (  BdbMode    mrowMode )  [pure virtual]
 

Sets the MROW mode to use when starting the next transaction

Implemented in BdbApplDomain, and BdbObjyDomain.

Referenced by BdbDomainOODB::setMrowMode().

virtual void BdbImplDomainOODB::setRpcTimeout (  d_Long    rpcTimeout )  [pure virtual]
 

Set the RPC timeout for the transaction in progress.

Implemented in BdbApplDomain, and BdbObjyDomain.

Referenced by BdbDomainOODB::setRpcTimeout().

virtual void BdbImplDomainOODB::setSingleFed (    )  [pure virtual]
 

Set the flag indication when the job is running in single or multiple federation mode.

Implemented in BdbApplDomain, and BdbObjyDomain.

virtual void BdbImplDomainOODB::setStandalone (    )  [pure virtual]
 

Set the flag indicating whether the jobs is standalone

Implemented in BdbApplDomain, and BdbObjyDomain.

Referenced by BdbDomainOODB::setStandalone().

virtual BdbStatus BdbImplDomainOODB::startNestedRead (  BdbNestingOptToken    optToken = BdbcInValidNestingOptToken )  [pure virtual]
 

Start a new nested transaction, in read mode

Implemented in BdbApplDomain, and BdbObjyDomain.

Referenced by BdbDomainOODB::startNestedRead().

virtual BdbStatus BdbImplDomainOODB::startNestedUpdate (  BdbNestingOptToken    optToken = BdbcInValidNestingOptToken )  [pure virtual]
 

Start new nested transaction, in update mode

Implemented in BdbApplDomain, and BdbObjyDomain.

Referenced by BdbDomainOODB::startNestedUpdate().

virtual BdbStatus BdbImplDomainOODB::startRead (  const char *    label = 0 )  [pure virtual]
 

Starts a read transaction

Only returns if succeeds (Include return for backwards compatibility.)

Returns:
BdbcSuccess

Implemented in BdbApplDomain, and BdbObjyDomain.

Referenced by BdbDomainOODB::startRead().

virtual BdbStatus BdbImplDomainOODB::startUpdate (  const char *    label = 0 )  [pure virtual]
 

Starts an update transaction

Implemented in BdbApplDomain, and BdbObjyDomain.

Referenced by BdbDomainOODB::startUpdate().

virtual BdbTransId BdbImplDomainOODB::transId (    )  [pure virtual]
 

Returns:
unique identifier (if transaction is in progress)

Implemented in BdbApplDomain, and BdbObjyDomain.

Referenced by BdbDomainOODB::transId().

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

 

BaBar Public Site | SLAC | News | Links | Who's Who | Contact Us

Page Owner: Jacek Becla
Last Update: October 04, 2002