Resource Class Reference
Provides a generic interface for resources which need to keep track of when they are in use, such as mutex locks. More...
#include <Resource.h>
Detailed Description
Provides a generic interface for resources which need to keep track of when they are in use, such as mutex locks.
Definition at line 6 of file Resource.h.
Classes | |
| class | Data |
| base class for holding data required for requesting to use/release the resource More... | |
Public Member Functions | |
| virtual | ~Resource () |
| destructor (does nothing -- up to subclass if they need to release resource) | |
| virtual void | useResource (Data &d)=0 |
| marks the resource as in use | |
| virtual void | releaseResource (Data &d)=0 |
| releases the resource | |
Static Public Attributes | |
| static Data | emptyData |
| to use as the data reference when none is needed/specified | |
Constructor & Destructor Documentation
| virtual Resource::~Resource | ( | ) | [virtual] |
destructor (does nothing -- up to subclass if they need to release resource)
Definition at line 16 of file Resource.h.
Member Function Documentation
| virtual void Resource::releaseResource | ( | Data & | d | ) | [pure virtual] |
releases the resource
Implemented in MutexLock< num_doors >, Thread::Lock, MotionPtr< T >, EmptyResource, MutexLock< ProcessID::NumProcesses >, MutexLock< MAX_ACCESS >, MotionPtr< PIDMC >, and MotionPtr< HeadPointerMC >.
Referenced by InverseMarkScope::InverseMarkScope(), MarkScope::reset(), InverseMarkScope::reset(), Socket::write(), and MarkScope::~MarkScope().
| virtual void Resource::useResource | ( | Data & | d | ) | [pure virtual] |
marks the resource as in use
Implemented in MutexLock< num_doors >, Thread::Lock, MotionPtr< T >, EmptyResource, MutexLock< ProcessID::NumProcesses >, MutexLock< MAX_ACCESS >, MotionPtr< PIDMC >, and MotionPtr< HeadPointerMC >.
Referenced by Socket::getWriteBuffer(), MarkScope::MarkScope(), MarkScope::reset(), InverseMarkScope::reset(), and InverseMarkScope::~InverseMarkScope().
Member Data Documentation
Resource::Data Resource::emptyData [static] |
to use as the data reference when none is needed/specified
Definition at line 13 of file Resource.h.
Referenced by Socket::getWriteBuffer(), Thread::Lock::lock(), Thread::Lock::unlock(), and Socket::write().
The documentation for this class was generated from the following files:
