PM Library classes

class PMNotify

? ^ 
    extends PMNonCopyable as public

Notify another thread.

An application can use an notify object to trigger execution of other threads. This is useful if, for example, one thread provides data to many other threads. Using an notify object frees the other threads from the trouble of polling to determine when new data is available.

None of the functions in this class throws exceptions because an exception probably has been thrown already or is about to be thrown.

You can construct and destruct objects of this class.

Source:
pm_notify.h:33
Author:
Dmitry A.Steklenev
Version:
$Revision: 1.2 $

Contents

^ 
EntityInherited FromTypeScopeShort Description
PMNotifyconstructor publicConstructs the notify object.
~PMNotifydestructor publicDestructs the notify object.
postmethod public Posts the notify.
waitmethod public Waits the notify.
waitmethod public Waits the notify with timeout.
resetmethod public Resets the notify.

constructor PMNotify

? ^  > 
Constructs the notify object.
Source:
pm_notify.h:36
Code:
public PMNotify ( )

destructor ~PMNotify

? ^  < > 
Destructs the notify object.
Source:
pm_notify.h:38
Code:
public ~ PMNotify ( )

method post

? ^  < > 
Posts the notify.

Causing all of the threads that were blocked on wait requests for that object to execute.

Source:
pm_notify.h:49
Returns:
TRUE, if notify posted.
Code:
public BOOL post ( )

method wait

? ^  < > 
Waits the notify.

Enables a thread to wait for an notify to be posted.

Source:
pm_notify.h:59
Returns:
TRUE, if notify received.
Code:
public BOOL wait ( ) const

method wait

? ^  < > 
Waits the notify with timeout.

Enables a thread to wait for an notify to be posted.

Source:
pm_notify.h:71
Param:
mseq This is the maximum amount of time the user wants to allow the thread to be blocked.
Returns:
TRUE, if notify received.
Code:
public BOOL wait ( unsigned long msec ) const

method reset

? ^  < > 
Resets the notify.

Resets an object, causing all threads that subsequently call wait to be blocked.

Source:
pm_notify.h:82
Returns:
TRUE, if resets succesfull.
Code:
public BOOL reset ( )

Created Fri Aug 3 09:13:16 2012.
This documentation was generated automatically by
ccdoc v08r39 2003/02/27 bin_opt_emx_os2-2.30.
Click here to submit a bug report or feature request for ccdoc.
Click here to return to the top of the page.