co::base::TimedLock Class Reference

A mutex with timeout capabilities. More...

#include <timedLock.h>

Inheritance diagram for co::base::TimedLock:

Collaboration diagram for co::base::TimedLock:

List of all members.

Public Member Functions
COBASE_API	TimedLock ()
	Construct a new timed lock.
COBASE_API	~TimedLock ()
	Destruct the lock.
COBASE_API bool	set (const uint32_t timeout=EQ_TIMEOUT_INDEFINITE)
	Set the lock.
COBASE_API void	unset ()
	Release the lock.
COBASE_API bool	trySet ()
	Attempt to set the lock.
bool	isSet ()
	Test if the lock is set.

---

Detailed Description

A mutex with timeout capabilities.

Definition at line 31 of file timedLock.h.

---

Constructor & Destructor Documentation

COBASE_API co::base::TimedLock::TimedLock

(

)

Construct a new timed lock.

Version:

1.0

COBASE_API co::base::TimedLock::~TimedLock

(

)

Destruct the lock.

Version:

1.0

---

Member Function Documentation

bool co::base::TimedLock::isSet

(

)

[inline]

Test if the lock is set.

Returns:

true if the lock is set, false if it is not set.

Version:

1.0

Definition at line 68 of file timedLock.h.

COBASE_API bool co::base::TimedLock::set

(

const uint32_t

timeout = EQ_TIMEOUT_INDEFINITE

)

Set the lock.

Parameters:

timeout

the timeout in milliseconds to wait for the lock, or EQ_TIMEOUT_INDEFINITE to wait indefinitely.

Returns:

true if the lock was acquired, false if not.

Version:

1.0

COBASE_API bool co::base::TimedLock::trySet

(

)

Attempt to set the lock.

Returns:

true if the lock was acquired, false if not.

Version:

1.0

COBASE_API void co::base::TimedLock::unset

(

)

Release the lock.

Version:

1.0

---

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

• timedLock.h