OSB_LIB::Guard::Cleanup Class Reference

Inheritance diagram for OSB_LIB::Guard::Cleanup:

[legend]List of all members.

---

Detailed Description

Base class to perform the clean-up actions.

The class is only responsible to perform any needed clean-up actions. It is NOT the task of the class to control the ownership of the clean-up actions: This is the responsibility of Guard!

Remarks:

The class is declared public in Guard, mainly to avoid name clashes. The class MutexUnlock shows a concrete implementation.

Definition at line 132 of file guard.h.

Public Types

• typedef std::auto_ptr< Guard::Cleanup > AutoPtr

  Shorthand for a auto pointer as needed in the auto pointer constructor of Guard.
  

Public Member Functions

• virtual ~Cleanup ()

  Virtual empty destructor.
  

• virtual int cleanup ()=0

  Perform the clean-up actions.
  

---

Member Typedef Documentation

typedef std::auto_ptr<Guard::Cleanup> OSB_LIB::Guard::Cleanup::AutoPtr

Shorthand for a auto pointer as needed in the auto pointer constructor of Guard.

Definition at line 138 of file guard.h.

---

Constructor & Destructor Documentation

virtual OSB_LIB::Guard::Cleanup::~Cleanup

(

)

[virtual]

Virtual empty destructor.

Remarks:

The destructor does not perform any operation.
In particular it does not call the member cleanup(): This is the task of Guard that owns the clean-up object.

---

Member Function Documentation

virtual int OSB_LIB::Guard::Cleanup::cleanup

(

)

[pure virtual]

Perform the clean-up actions.

Returns:

0 in case of success, else a non-zero value specified by the derived class.

Remarks:

Concrete classes may redefine the meaning of the return value.

Implemented in OSB_LIB::MutexUnlock, and OSB_LIB::TcatLockManager::UnlockAll.

---

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

• guard.h

---