Class Spinnaker::GenICam::CGlobalLock

ClassList > GenICam > CGlobalLock

Named global lock which can be used over process boundaries.

• #include <GCSynch.h>

Public Functions

Type	Name
	CGlobalLock (const char * pszName)
	CGlobalLock (const gcstring & strName)
bool	IsValid (void) const
bool	Lock (unsigned int timeout_ms)
bool	TryLock (void)
void	Unlock (void)
	~CGlobalLock ()

Protected Attributes

Type	Name
long	m_DebugCount

Public Functions Documentation

function CGlobalLock [1/3]

explicit GenICam::CGlobalLock::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.

---

function CGlobalLock [2/3]

explicit GenICam::CGlobalLock::CGlobalLock (
    const 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.

---

function IsValid

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

tests whether the lock is valid

---

function Lock

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

enters the lock (may block)

---

function TryLock

bool GenICam::CGlobalLock::TryLock (
    void
) 

tries to enter the lock and returns immediately when not possible

---

function Unlock

void GenICam::CGlobalLock::Unlock (
    void
) 

leaves the lock

---

function ~CGlobalLock

GenICam::CGlobalLock::~CGlobalLock () 

---

Protected Attributes Documentation

variable m_DebugCount

long Spinnaker::GenICam::CGlobalLock::m_DebugCount;

---

---

The documentation for this class was generated from the following file /workspace/include/SpinGenApi/GCSynch.h