SessionGuardBase Class Reference

Inheritance diagram for SessionGuardBase:

[legend]Collaboration diagram for SessionGuardBase:

[legend]List of all members.

---

Detailed Description

Synchronize access to the database: base class.

Definition at line 53 of file contractadmin-server.h.

Public Member Functions

• SessionGuardBase (bool noWait)
• virtual ~SessionGuardBase ()=0

Protected Member Functions

• OSB_DB::Session & get ()
• SessionGuardBase ()

  Default contructor.
  

• SessionGuardBase (bool noWait)

  Constructor: locks the mutex.
  

• virtual ~SessionGuardBase ()=0

  Destructor: unlock the mutex.
  

• bool locked () const

  Guard locked?
  

• void lock (bool noWait)

  Constructor: locks the mutex.
  

• OSB_DB::Session & get ()

  Get the database session.
  

Private Member Functions

• SessionGuardBase (const SessionGuardBase &)
• SessionGuardBase & operator= (const SessionGuardBase &)
• SessionGuardBase (const SessionGuardBase &)

  Prevent copying: not implemented.
  

• SessionGuardBase & operator= (const SessionGuardBase &)

  Prevent assignment: not implemented.
  

Private Attributes

• OSB_DB::Session * pSession_
• bool locked_

  Flag the mutex was locked.
  

Static Private Attributes

• static OSB_LIB::Mutex mutex_

  Mutex used to synchronize.
  

• static OSB_DB::Session * pSession_

  Pointer to the database session: set by main.
  

Friends

• int main (int, char **)

  Allow to set pSession_.
  

---

Constructor & Destructor Documentation

SessionGuardBase::SessionGuardBase

(

bool

noWait

)

virtual SessionGuardBase::~SessionGuardBase

(

)

[pure virtual]

SessionGuardBase::SessionGuardBase

(

const SessionGuardBase &

)

[private]

SessionGuardBase::SessionGuardBase

(

)

[protected]

Default contructor.

Attention:

Clients must call lock() before using get().

SessionGuardBase::SessionGuardBase

(

bool

noWait

)

[protected]

Constructor: locks the mutex.

Parameters:

noWait

Don't wait for database locks?

Exceptions:

OsbException

from lock().

virtual SessionGuardBase::~SessionGuardBase

(

)

[protected, pure virtual]

Destructor: unlock the mutex.

SessionGuardBase::SessionGuardBase

(

const SessionGuardBase &

)

[private]

Prevent copying: not implemented.

---

Member Function Documentation

OSB_DB::Session& SessionGuardBase::get

(

)

[protected]

Get the database session.

Exceptions:

OsbException

if locked_ is false.

Reimplemented in ReadSession, WriteSession, ReadSession, and WriteSession.

OSB_DB::Session& SessionGuardBase::get

(

)

[protected]

Reimplemented in ReadSession, WriteSession, ReadSession, and WriteSession.

Referenced by WriteSession::get(), ReadSession::get(), and WriteSession::getConst().

void SessionGuardBase::lock

(

bool

noWait

)

[protected]

Constructor: locks the mutex.

Parameters:

noWait

Don't wait for database locks?

Exceptions:

	OsbException	if the lock can not be aquired.
	OsbException	if pSession_ is 0.

Reimplemented in ReadSession, and WriteSession.

bool SessionGuardBase::locked

(

)

const [protected]

Guard locked?

Reimplemented in ReadSession, and WriteSession.

SessionGuardBase& SessionGuardBase::operator=

(

const SessionGuardBase &

)

[private]

Prevent assignment: not implemented.

SessionGuardBase& SessionGuardBase::operator=

(

const SessionGuardBase &

)

[private]

---

Friends And Related Function Documentation

int main	(	int	,
		char **
	)			[friend]

Allow to set pSession_.

---

Member Data Documentation

bool SessionGuardBase::locked_ [private]

Flag the mutex was locked.

Definition at line 182 of file rqsglobal.h.

static OSB_LIB::Mutex SessionGuardBase::mutex_ [static, private]

Mutex used to synchronize.

Definition at line 54 of file contractadmin-server.h.

OSB_DB::Session* SessionGuardBase::pSession_ [static, private]

Pointer to the database session: set by main.

Definition at line 138 of file rqsglobal.h.

OSB_DB::Session* SessionGuardBase::pSession_ [private]

Definition at line 67 of file contractadmin-server.h.

---

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

• contractadmin-server.h
• rqsglobal.h

---