OSVR-Core  0.6-1962-g59773924
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
osvr::util::GuardInterface Class Referenceabstract

An interface to a (deferred) guard class: after instantiation and lock returning true, some resource is locked and available until destruction. More...

#include <osvr/Util/GuardInterface.h>

Inherited by osvr::util::DummyGuard.

Public Member Functions

virtual
OSVR_RETURN_WARN_UNUSED bool 
lock ()=0
 Attempts to lock/request the resource, and returns true if successful. More...
 

Detailed Description

An interface to a (deferred) guard class: after instantiation and lock returning true, some resource is locked and available until destruction.

Definition at line 43 of file GuardInterface.h.

Member Function Documentation

virtual OSVR_RETURN_WARN_UNUSED bool osvr::util::GuardInterface::lock ( )
pure virtual

Attempts to lock/request the resource, and returns true if successful.

Only proceed with using the resource if this returns true!


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