wycond.3wy

一个不错

.\"
.\" Edited by I.J.Wang, 2004
.\"
.TH WyCond 3wy "libwy v0.31"
.SH NAME
WyCond \- class of conditional variable
.SH SYNOPSIS
.B #include <wycond.h>
.PP
WyCond is the class for threads to suspend execution, waiting to resume on
wakeup signal.
.SH "PUBLIC MEMBERS"
 \fBWyCond\fP() throw()
 \fB~WyCond\fP() throw()
 void \fBsignal\fP(void) throw()
 void \fBbroadcast\fP(void) throw()
 WyRet \fBwait\fP(WyLock&)
 WyRet \fBwait\fP(WyLock&,WyTimeSpec)
.SH "DESCRIPTION" 
.PP
.\"--------------------------------------------
.BI "WyCond() throw()"
.PP
    Construct default object
.PP 
    [\fBRefer\fP] ::pthread_cond_init
.TP
.\"--------------------------------------------
.BI "~WyCond() throw()"
.PP
    Destruct *this
.PP 
    [\fBRefer\fP] ::pthread_cond_destroy
.TP
.\"--------------------------------------------
.BI "void signal(void) throw()" 
.PP
    Signal exactly one thread waiting on *this
.PP 
    [\fBRefer\fP] ::pthread_cond_signal
.TP
.\"--------------------------------------------
.BI "void broadcast(void) throw()" 
.PP
    Broadcast signal to all threads waiting on *this
.PP 
    [\fBRefer\fP] ::pthread_cond_broadcast
.TP
.\"--------------------------------------------
.BI "WyRet wait(WyLock& " "mtx" ")" 
.PP
    Wait for a wakeup signal
.PP 
    \fBNote\fP: Function may be waken-up by spurious signals. Always
          recheck the condition after waken-up.
.PP 
    [\fBRet\fP] Ok               Wait interrupted
          ...
.PP 
    [\fBRefer\fP] ::pthread_cond_wait
.TP
.\"--------------------------------------------
.BI "WyRet wait(WyLock& " "mtx" ", WyTimeSpec " "tm" ")"
.PP
    Wait for a wakeup signal, or the system time had passed
    the time given in \fItm\fP.
.PP 
    \fBNote\fP: Function may be waken-up by spurious signals. Always
          recheck the condition after waken-up.
.PP 
    [\fBRet\fP] Wym_ETIMEDOUT System time has passed \fItm\fP
          Wym_EINTR     Interrupted by a signal
          Wym_ERANGE    \fItm\fP not in the functional range
          ...
.PP 
    [\fBRefer\fP] ::pthread_cond_timedwait
.\"--------------------------------------------
.SH "SEE ALSO"
.BR wyreply
.BR wyret
.BR wymutex
.BR wylock
.BR wyonce
.BR wytimespec
.BR wy_thread
.SH NOTE
Except added by this library, replys are converted from the errno 
an underlying C library function returned. Report of such replys
are brief from Linux Programmer's Manual. See the associated man page
for details.

Project is in development, http://sourceforge.net/projects/libwx