Public Member Functions | Protected Attributes | Private Member Functions | List of all members
GENICAM_NAMESPACE::CGlobalLock Class Reference

Named global lock which can be used over process boundaries. More...

#include <GCSynch.h>

Public Member Functions

 CGlobalLock (const char *pszName)
 Creates a global lock object name pszName. In case an object with the same name already exists a reference to the existing object will be created. If pszName is NULL an unnamed object will be created. More...
 
 CGlobalLock (const GENICAM_NAMESPACE::gcstring &strName)
 Creates a global lock object name strName. In case an object with the same name already exists a reference to the existing object will be created. If strName is empty an unnamed object will be created. More...
 
bool IsValid (void) const
 tests whether the lock is valid More...
 
bool Lock (unsigned int timeout_ms)
 enters the lock (may block) More...
 
bool TryLock (void)
 tries to enter the lock and returns immediately when not possible More...
 
void Unlock (void)
 leaves the lock More...
 
 ~CGlobalLock ()
 

Protected Attributes

long m_DebugCount
 

Private Member Functions

 CGlobalLock (const CGlobalLock &)
 
CGlobalLockoperator= (const CGlobalLock &)
 

Detailed Description

Named global lock which can be used over process boundaries.

Definition at line 209 of file GCSynch.h.

Constructor & Destructor Documentation

GENICAM_NAMESPACE::CGlobalLock::CGlobalLock ( const char *  pszName)
explicit

Creates a global lock object name pszName. In case an object with the same name already exists a reference to the existing object will be created. If pszName is NULL an unnamed object will be created.

GENICAM_NAMESPACE::CGlobalLock::CGlobalLock ( const GENICAM_NAMESPACE::gcstring strName)
explicit

Creates a global lock object name strName. In case an object with the same name already exists a reference to the existing object will be created. If strName is empty an unnamed object will be created.

GENICAM_NAMESPACE::CGlobalLock::~CGlobalLock ( )
GENICAM_NAMESPACE::CGlobalLock::CGlobalLock ( const CGlobalLock )
private

Member Function Documentation

bool GENICAM_NAMESPACE::CGlobalLock::IsValid ( void  ) const

tests whether the lock is valid

bool GENICAM_NAMESPACE::CGlobalLock::Lock ( unsigned int  timeout_ms)

enters the lock (may block)

CGlobalLock& GENICAM_NAMESPACE::CGlobalLock::operator= ( const CGlobalLock )
private
bool GENICAM_NAMESPACE::CGlobalLock::TryLock ( void  )

tries to enter the lock and returns immediately when not possible

void GENICAM_NAMESPACE::CGlobalLock::Unlock ( void  )

leaves the lock

Member Data Documentation

long GENICAM_NAMESPACE::CGlobalLock::m_DebugCount
mutableprotected

Definition at line 266 of file GCSynch.h.


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


rc_genicam_api
Author(s): Heiko Hirschmueller
autogenerated on Wed Mar 17 2021 02:48:42