Replace tabs with spaces in more files.
--HG-- branch : trunk
This commit is contained in:
@@ -28,7 +28,7 @@
|
||||
#include "zthread/Waitable.h"
|
||||
|
||||
namespace ZThread {
|
||||
|
||||
|
||||
class FifoConditionImpl;
|
||||
|
||||
/**
|
||||
@@ -37,13 +37,13 @@ namespace ZThread {
|
||||
* @date <2003-07-16T14:38:59-0400>
|
||||
* @version 2.2.1
|
||||
*
|
||||
* A Condition is a Waitable object used to block a thread until a particular
|
||||
* condition is met. A Condition object is always used in conjunction with Lockable
|
||||
* A Condition is a Waitable object used to block a thread until a particular
|
||||
* condition is met. A Condition object is always used in conjunction with Lockable
|
||||
* object. This object should be a FastMutex, Mutex, PriorityMutex or PriorityInheritanceMutex.
|
||||
*
|
||||
* Condition objects are reminiscent of POSIX condition variables in several ways but
|
||||
* are slightly different.
|
||||
*
|
||||
* Condition objects are reminiscent of POSIX condition variables in several ways but
|
||||
* are slightly different.
|
||||
*
|
||||
* A Condition is <i>not</i> subject to spurious wakeup.
|
||||
*
|
||||
* Like all Waitable objects, Conditions are sensitive to Thread::interupt() which can
|
||||
@@ -52,10 +52,10 @@ namespace ZThread {
|
||||
* @see Thread::interupt()
|
||||
*
|
||||
* Before a wait() is performed on a Condition, the associated Lockable object should
|
||||
* have been acquire()ed. When the wait() begins, that Lockable object is release()d
|
||||
* (wait() will atomically begin the wait and unlock the Lockable).
|
||||
* have been acquire()ed. When the wait() begins, that Lockable object is release()d
|
||||
* (wait() will atomically begin the wait and unlock the Lockable).
|
||||
*
|
||||
* A thread blocked by wait() will remain so until an exception occurs, or until
|
||||
* A thread blocked by wait() will remain so until an exception occurs, or until
|
||||
* the thread awakened by a signal() or broadcast(). When the thread resumes execution,
|
||||
* the associated Lockable is acquire()d before wait() returns.
|
||||
*
|
||||
@@ -66,33 +66,33 @@ namespace ZThread {
|
||||
class ZTHREAD_API Condition : public Waitable, private NonCopyable {
|
||||
|
||||
FifoConditionImpl* _impl;
|
||||
|
||||
|
||||
public:
|
||||
|
||||
|
||||
/**
|
||||
* Create a Condition associated with the given Lockable object.
|
||||
*
|
||||
* @param l Lockable object to associate with this Condition object.
|
||||
*/
|
||||
Condition(Lockable& l);
|
||||
Condition(Lockable& l);
|
||||
|
||||
//! Destroy Condition object
|
||||
virtual ~Condition();
|
||||
|
||||
|
||||
/**
|
||||
* Wake <em>one</em> thread waiting on this Condition.
|
||||
*
|
||||
* The associated Lockable need not have been acquire when this function is
|
||||
* The associated Lockable need not have been acquire when this function is
|
||||
* invoked.
|
||||
*
|
||||
* @post a waiting thread, if any exists, will be awakened.
|
||||
*/
|
||||
void signal();
|
||||
void signal();
|
||||
|
||||
/**
|
||||
* Wake <em>all</em> threads wait()ing on this Condition.
|
||||
*
|
||||
* The associated Lockable need not have been acquire when this function is
|
||||
* The associated Lockable need not have been acquire when this function is
|
||||
* invoked.
|
||||
*
|
||||
* @post all wait()ing threads, if any exist, will be awakened.
|
||||
@@ -108,16 +108,16 @@ namespace ZThread {
|
||||
* @exception Interrupted_Exception thrown when the calling thread is interrupted.
|
||||
* A thread may be interrupted at any time, prematurely ending any wait.
|
||||
*
|
||||
* @pre The thread calling this method must have first acquired the associated
|
||||
* Lockable object.
|
||||
* @pre The thread calling this method must have first acquired the associated
|
||||
* Lockable object.
|
||||
*
|
||||
* @post A thread that has resumed execution without exception (because of a signal(),
|
||||
* broadcast() or exception) will have acquire()d the associated Lockable object
|
||||
* @post A thread that has resumed execution without exception (because of a signal(),
|
||||
* broadcast() or exception) will have acquire()d the associated Lockable object
|
||||
* before returning from a wait().
|
||||
*
|
||||
* @see Waitable::wait()
|
||||
*/
|
||||
virtual void wait();
|
||||
virtual void wait();
|
||||
|
||||
/**
|
||||
* Wait for this Condition, blocking the calling thread until a signal or broadcast
|
||||
@@ -127,28 +127,28 @@ namespace ZThread {
|
||||
*
|
||||
* @param timeout maximum amount of time (milliseconds) this method could block
|
||||
*
|
||||
* @return
|
||||
* - <em>true</em> if the Condition receives a signal or broadcast before
|
||||
* @return
|
||||
* - <em>true</em> if the Condition receives a signal or broadcast before
|
||||
* <i>timeout</i> milliseconds elapse.
|
||||
* - <em>false</em> otherwise.
|
||||
*
|
||||
*
|
||||
* @exception Interrupted_Exception thrown when the calling thread is interrupted.
|
||||
* A thread may be interrupted at any time, prematurely ending any wait.
|
||||
*
|
||||
* @pre The thread calling this method must have first acquired the associated
|
||||
* Lockable object.
|
||||
* @pre The thread calling this method must have first acquired the associated
|
||||
* Lockable object.
|
||||
*
|
||||
* @post A thread that has resumed execution without exception (because of a signal(),
|
||||
* broadcast() or exception) will have acquire()d the associated Lockable object
|
||||
* @post A thread that has resumed execution without exception (because of a signal(),
|
||||
* broadcast() or exception) will have acquire()d the associated Lockable object
|
||||
* before returning from a wait().
|
||||
*
|
||||
* @see Waitable::wait(unsigned long timeout)
|
||||
*/
|
||||
virtual bool wait(unsigned long timeout);
|
||||
|
||||
|
||||
|
||||
};
|
||||
|
||||
|
||||
} // namespace ZThread
|
||||
|
||||
#endif // __ZTCONDITION_H__
|
||||
|
||||
Reference in New Issue
Block a user