Csound and CsoundAC API  5.17
Public Member Functions | Private Attributes
csound::ThreadLock Class Reference

Encapsulates a thread monitor, such as a Windows event handle. More...

#include <System.hpp>

Public Member Functions

virtual void close ()
 Destroys the monitor.
virtual void endWait ()
 Releases one thread that is waiting on the monitor.
virtual bool isOpen ()
 Returns whether the monitor is open.
virtual void open ()
 Creates and initializes the monitor.
virtual void startWait (size_t timeoutMilliseconds=0)
 Waits until the monitor is notified by another thread.
 ThreadLock ()
virtual ~ThreadLock ()

Private Attributes

void * lock

Detailed Description

Encapsulates a thread monitor, such as a Windows event handle.

Constructor & Destructor Documentation

csound::ThreadLock::ThreadLock ( )
virtual csound::ThreadLock::~ThreadLock ( )
virtual

Member Function Documentation

virtual void csound::ThreadLock::close ( )
virtual

Destroys the monitor.

virtual void csound::ThreadLock::endWait ( )
virtual

Releases one thread that is waiting on the monitor.

virtual bool csound::ThreadLock::isOpen ( )
virtual

Returns whether the monitor is open.

virtual void csound::ThreadLock::open ( )
virtual

Creates and initializes the monitor.

The monitor is in a non-notified or unsignaled state.

virtual void csound::ThreadLock::startWait ( size_t  timeoutMilliseconds = 0)
virtual

Waits until the monitor is notified by another thread.

Zero timeout means infinite timeout.

Field Documentation

void* csound::ThreadLock::lock
private