wy_threadid.3wy

一个不错

.\"
.\" Edited by I.J.Wang, 2004
.\"
.TH Wy_ThreadID 3wy "libwy v0.31"
.SH NAME
Wy_ThreadID \- class of thread identifier 
.SH SYNOPSIS
.B #include <wy_thread.h>
.PP
Wy_ThreadID is a discardable class of thread identifier
.SH "PUBLIC MEMBERS"
 \fBWy_ThreadID\fP() throw()
 \fBWy_ThreadID\fP(const Wy_ThreadID&) throw()
 \fBWy_ThreadID\fP(pthread_t) throw()
 \fBWy_ThreadID\fP(Wy_ThreadID&, Wy::ByMove_t) throw()
 bool \fBis_default\fP(void) const throw()
 ::pthread_t \fB_pthread_id\fP(void) const throw()
 void \fBreset\fP(void) throw()
 void \fBreset\fP(const Wy_ThreadID&) throw()
 void \fBreset\fP(pthread_t) throw()
 const Wy_ThreadID& \fBoperator =\fP(const Wy_ThreadID&) throw()
 bool \fBoperator ==\fP(const Wy_ThreadID&) const throw()
 bool \fBoperator !=\fP(const Wy_ThreadID&) const throw()
 static bool \fB_thread_equal\fP(Wy_ThreadID, Wy_ThreadID) throw()
.SH "DESCRIPTION"
.\"--------------------------------------------
.PP
.BI "Wy_ThreadID() throw()"
.PP
    Construct default object. (no any thread associated)

    _pthread_id()= 0
 
    Warning: Implementation uses ::pthread_t(0) as the default value
             for no thread. No documents found to say this is correct.
             However, no successfully created threads have tested to
             return pthread_t(0) either.
.\"--------------------------------------------
.PP
.BI "Wy_ThreadID(const Wy_ThreadID& " "src" ") throw()"
.PP
    Construct object by copy from \fIsrc\fP

    _pthread_id()= src._pthread_id()
.\"--------------------------------------------
.PP
.BI "Wy_ThreadID(pthread_t " "tid" ") throw()"
.PP
    Construct object by copy from \fItid\fP

    _pthread_id()= \fItid\fP
.\"--------------------------------------------
.PP
.BI "Wy_ThreadID(Wy_ThreadID& " "src" ", Wy::ByMove_t) throw()"
.PP
    See Wy_Array(Wy_Array&, Wy::ByMove_t) in wy_array(3wy)
    for definition of the move constructor.
.\"--------------------------------------------
.PP
.BI "bool is_default(void) const throw()"
.PP
    Is *this equivalent to the default object
.PP
    [\fBRet\fP] true= object is equivalent to Wy_ThreadID()
         false= otherwise
.\"--------------------------------------------
.PP
.BI "::pthread_t _pthread_id(void) const throw()"
.PP
    Get the pthread_t equivalent of *this
.PP
    [\fBRet\fP] type pthread_t equivalent of *this
.\"--------------------------------------------
.PP
.BI "void reset(void) throw()" 
.PP
    Reconstruct *this to the state as Wy_ThreadID()
.\"--------------------------------------------
.PP
.BI "void reset(const Wy_ThreadID& src) throw()" 
.PP
    Reconstruct *this to the state as Wy_ThreadID(\fIsrc\fP)
.\"--------------------------------------------
.PP
.BI "void reset(pthread_t " "tid" ") throw()" 
.PP
    Reconstruct *this to the state as Wy_ThreadID(\fItid\fP)
.\"--------------------------------------------
.PP
.BI "const Wy_ThreadID& operator =(const Wy_ThreadID& " "tid" ") throw()" 
.PP
    Assign *this from \fItid\fP
.PP
    [\fBRet\fP] Const reference of *this
.\"--------------------------------------------
.PP
.BI "bool operator ==(const Wy_ThreadID& " "tid" ") const throw()"
.TP
.BI "bool operator !=(const Wy_ThreadID& " "tid" ") const throw()"
.PP
    Test equivalence of *this and \fItid\fP

    Warning: Avoid using this member. Using the static member 
             _thread_equal if possible.

    Note: These are value test of Wy_ThreadID objects, nothing to
          do with the real threads.
.PP 
    [\fBRet\fP] true= relation holds
         false= otherwise
.\"--------------------------------------------
.PP
.BI "static bool _thread_equal(Wy_ThreadID " "id1" ", Wy_ThreadID " "id2" ") throw()"
.PP
    Test the thread identifiers refer to the same running thread

    Note: If either \fIid1\fP or \fIid2\fP is not referring to a running thread
          result is undefined.
.PP 
    [\fBRet\fP] true= \fIid1\fP and \fIid2\fP refers to the same running thread
         false= otherwise

    [\fBRefer\fP] ::pthread_equal(pthread_t,pthread_t)
.\"--------------------------------------------
.SH "SEE ALSO"
.BR wy_thread
.SH NOTE
Project is in development, http://sourceforge.net/projects/libwx