home *** CD-ROM | disk | FTP | other *** search
/ Chip 2000 May / Chip_2000-05_cd1.bin / zkuste / Perl / ActivePerl-5.6.0.613.msi / 䆊䌷䈹䈙䏵-䞅䞆䞀㡆䞃䄦䠥 / _7bae6dd152381b902d705b2b84f816e6 < prev    next >
Text File  |  2000-03-23  |  11KB  |  222 lines
  1.  
  2. <HTML>
  3. <HEAD>
  4. <TITLE>Thread - manipulate threads in Perl</TITLE>
  5. <LINK REL="stylesheet" HREF="../Active.css" TYPE="text/css">
  6. <LINK REV="made" HREF="mailto:">
  7. </HEAD>
  8.  
  9. <BODY>
  10. <TABLE BORDER=0 CELLPADDING=0 CELLSPACING=0 WIDTH=100%>
  11. <TR><TD CLASS=block VALIGN=MIDDLE WIDTH=100% BGCOLOR="#cccccc">
  12. <STRONG><P CLASS=block> Thread - manipulate threads in Perl</P></STRONG>
  13. </TD></TR>
  14. </TABLE>
  15.  
  16. <A NAME="__index__"></A>
  17. <!-- INDEX BEGIN -->
  18.  
  19. <UL>
  20.  
  21.     <LI><A HREF="#name">NAME</A></LI><LI><A HREF="#supportedplatforms">SUPPORTED PLATFORMS</A></LI>
  22.  
  23.     <LI><A HREF="#synopsis">SYNOPSIS</A></LI>
  24.     <LI><A HREF="#description">DESCRIPTION</A></LI>
  25.     <LI><A HREF="#functions">FUNCTIONS</A></LI>
  26.     <LI><A HREF="#methods">METHODS</A></LI>
  27.     <LI><A HREF="#limitations">LIMITATIONS</A></LI>
  28.     <LI><A HREF="#see also">SEE ALSO</A></LI>
  29. </UL>
  30. <!-- INDEX END -->
  31.  
  32. <HR>
  33. <P>
  34. <H1><A NAME="name">NAME</A></H1>
  35. <P>Thread - manipulate threads in Perl (EXPERIMENTAL, subject to change)</P>
  36. <P>
  37. <HR>
  38. <H1><A NAME="supportedplatforms">SUPPORTED PLATFORMS</A></H1>
  39. <UL>
  40. <LI>Windows</LI>
  41. </UL>
  42. <HR>
  43. <H1><A NAME="synopsis">SYNOPSIS</A></H1>
  44. <PRE>
  45.     use Thread;</PRE>
  46. <PRE>
  47.     my $t = new Thread \&start_sub, @start_args;</PRE>
  48. <PRE>
  49.     $result = $t->join;
  50.     $result = $t->eval;
  51.     $t->detach;</PRE>
  52. <PRE>
  53.     if($t->equal($another_thread)) {
  54.         # ...
  55.     }</PRE>
  56. <PRE>
  57.     my $tid = Thread->self->tid; 
  58.     my $tlist = Thread->list;</PRE>
  59. <PRE>
  60.     lock($scalar);
  61.     yield();</PRE>
  62. <PRE>
  63.     use Thread 'async';</PRE>
  64. <P>
  65. <HR>
  66. <H1><A NAME="description">DESCRIPTION</A></H1>
  67. <PRE>
  68.     WARNING: Threading is an experimental feature.  Both the interface
  69.     and implementation are subject to change drastically.  In fact, this
  70.     documentation describes the flavor of threads that was in version
  71.     5.005.  Perl 5.6.0 and later have the beginnings of support for
  72.     interpreter threads, which (when finished) is expected to be
  73.     significantly different from what is described here.  The information
  74.     contained here may therefore soon be obsolete.  Use at your own risk!</PRE>
  75. <P>The <CODE>Thread</CODE> module provides multithreading support for perl.</P>
  76. <P>
  77. <HR>
  78. <H1><A NAME="functions">FUNCTIONS</A></H1>
  79. <DL>
  80. <DT><STRONG><A NAME="item_new_%5C%26start_sub">new \&start_sub</A></STRONG><BR>
  81. <DD>
  82. <DT><STRONG><A NAME="item_new_%5C%26start_sub%2C_LIST">new \&start_sub, LIST</A></STRONG><BR>
  83. <DD>
  84. <CODE>new</CODE> starts a new thread of execution in the referenced subroutine. The
  85. optional list is passed as parameters to the subroutine. Execution
  86. continues in both the subroutine and the code after the <CODE>new</CODE> call.
  87. <P><CODE>new Thread</CODE> returns a thread object representing the newly created
  88. thread.</P>
  89. <P></P>
  90. <DT><STRONG><A NAME="item_lock">lock VARIABLE</A></STRONG><BR>
  91. <DD>
  92. <A HREF="#item_lock"><CODE>lock</CODE></A> places a lock on a variable until the lock goes out of scope.  If
  93. the variable is locked by another thread, the <A HREF="#item_lock"><CODE>lock</CODE></A> call will block until
  94. it's available. <A HREF="#item_lock"><CODE>lock</CODE></A> is recursive, so multiple calls to <A HREF="#item_lock"><CODE>lock</CODE></A> are
  95. safe--the variable will remain locked until the outermost lock on the
  96. variable goes out of scope.
  97. <P>Locks on variables only affect <A HREF="#item_lock"><CODE>lock</CODE></A> calls--they do <EM>not</EM> affect normal
  98. access to a variable. (Locks on subs are different, and covered in a bit)
  99. If you really, <EM>really</EM> want locks to block access, then go ahead and tie
  100. them to something and manage this yourself. This is done on purpose. While
  101. managing access to variables is a good thing, perl doesn't force you out of
  102. its living room...</P>
  103. <P>If a container object, such as a hash or array, is locked, all the elements
  104. of that container are not locked. For example, if a thread does a <CODE>lock
  105. @a</CODE>, any other thread doing a <A HREF="#item_lock"><CODE>lock($a[12])</CODE></A> won't block.</P>
  106. <P>You may also <A HREF="#item_lock"><CODE>lock</CODE></A> a sub, using <CODE>lock &sub</CODE>. Any calls to that sub from
  107. another thread will block until the lock is released. This behaviour is not
  108. equivalent to declaring the sub with the <CODE>locked</CODE> attribute.  The <CODE>locked</CODE>
  109. attribute serializes access to a subroutine, but allows different threads
  110. non-simultaneous access. <CODE>lock &sub</CODE>, on the other hand, will not allow
  111. <EM>any</EM> other thread access for the duration of the lock.</P>
  112. <P>Finally, <A HREF="#item_lock"><CODE>lock</CODE></A> will traverse up references exactly <EM>one</EM> level.
  113. <A HREF="#item_lock"><CODE>lock(\$a)</CODE></A> is equivalent to <A HREF="#item_lock"><CODE>lock($a)</CODE></A>, while <A HREF="#item_lock"><CODE>lock(\\$a)</CODE></A> is not.</P>
  114. <P></P>
  115. <DT><STRONG><A NAME="item_async_BLOCK%3B">async BLOCK;</A></STRONG><BR>
  116. <DD>
  117. <CODE>async</CODE> creates a thread to execute the block immediately following
  118. it. This block is treated as an anonymous sub, and so must have a
  119. semi-colon after the closing brace. Like <CODE>new Thread</CODE>, <CODE>async</CODE> returns a
  120. thread object.
  121. <P></P>
  122. <DT><STRONG><A NAME="item_self">Thread->self</A></STRONG><BR>
  123. <DD>
  124. The <A HREF="#item_self"><CODE>Thread->self</CODE></A> function returns a thread object that represents
  125. the thread making the <A HREF="#item_self"><CODE>Thread->self</CODE></A> call.
  126. <P></P>
  127. <DT><STRONG><A NAME="item_list">Thread->list</A></STRONG><BR>
  128. <DD>
  129. <A HREF="#item_list"><CODE>Thread->list</CODE></A> returns a list of thread objects for all running and
  130. finished but un-<A HREF="#item_join"><CODE>join</CODE></A>ed threads.
  131. <P></P>
  132. <DT><STRONG><A NAME="item_cond_wait_VARIABLE">cond_wait VARIABLE</A></STRONG><BR>
  133. <DD>
  134. The <CODE>cond_wait</CODE> function takes a <STRONG>locked</STRONG> variable as a parameter,
  135. unlocks the variable, and blocks until another thread does a <CODE>cond_signal</CODE>
  136. or <CODE>cond_broadcast</CODE> for that same locked variable. The variable that
  137. <CODE>cond_wait</CODE> blocked on is relocked after the <CODE>cond_wait</CODE> is satisfied.
  138. If there are multiple threads <CODE>cond_wait</CODE>ing on the same variable, all but
  139. one will reblock waiting to reaquire the lock on the variable. (So if
  140. you're only using <CODE>cond_wait</CODE> for synchronization, give up the lock as
  141. soon as possible)
  142. <P></P>
  143. <DT><STRONG><A NAME="item_cond_signal_VARIABLE">cond_signal VARIABLE</A></STRONG><BR>
  144. <DD>
  145. The <CODE>cond_signal</CODE> function takes a locked variable as a parameter and
  146. unblocks one thread that's <CODE>cond_wait</CODE>ing on that variable. If more than
  147. one thread is blocked in a <CODE>cond_wait</CODE> on that variable, only one (and
  148. which one is indeterminate) will be unblocked.
  149. <P>If there are no threads blocked in a <CODE>cond_wait</CODE> on the variable, the
  150. signal is discarded.</P>
  151. <P></P>
  152. <DT><STRONG><A NAME="item_cond_broadcast_VARIABLE">cond_broadcast VARIABLE</A></STRONG><BR>
  153. <DD>
  154. The <CODE>cond_broadcast</CODE> function works similarly to <CODE>cond_wait</CODE>.
  155. <CODE>cond_broadcast</CODE>, though, will unblock <STRONG>all</STRONG> the threads that are blocked
  156. in a <CODE>cond_wait</CODE> on the locked variable, rather than only one.
  157. <P></P>
  158. <DT><STRONG><A NAME="item_yield">yield</A></STRONG><BR>
  159. <DD>
  160. The <A HREF="#item_yield"><CODE>yield</CODE></A> function allows another thread to take control of the
  161. CPU. The exact results are implementation-dependent.
  162. <P></P></DL>
  163. <P>
  164. <HR>
  165. <H1><A NAME="methods">METHODS</A></H1>
  166. <DL>
  167. <DT><STRONG><A NAME="item_join">join</A></STRONG><BR>
  168. <DD>
  169. <A HREF="#item_join"><CODE>join</CODE></A> waits for a thread to end and returns any values the thread exited
  170. with. <A HREF="#item_join"><CODE>join</CODE></A> will block until the thread has ended, though it won't block
  171. if the thread has already terminated.
  172. <P>If the thread being <A HREF="#item_join"><CODE>join</CODE></A>ed <A HREF="../lib/Pod/perlfunc.html#item_die"><CODE>die</CODE></A>d, the error it died with will be
  173. returned at this time. If you don't want the thread performing the <A HREF="#item_join"><CODE>join</CODE></A>
  174. to die as well, you should either wrap the <A HREF="#item_join"><CODE>join</CODE></A> in an <A HREF="#item_eval"><CODE>eval</CODE></A> or use the
  175. <A HREF="#item_eval"><CODE>eval</CODE></A> thread method instead of <A HREF="#item_join"><CODE>join</CODE></A>.</P>
  176. <P></P>
  177. <DT><STRONG><A NAME="item_eval">eval</A></STRONG><BR>
  178. <DD>
  179. The <A HREF="#item_eval"><CODE>eval</CODE></A> method wraps an <A HREF="#item_eval"><CODE>eval</CODE></A> around a <A HREF="#item_join"><CODE>join</CODE></A>, and so waits for a
  180. thread to exit, passing along any values the thread might have returned.
  181. Errors, of course, get placed into <CODE>$@</CODE>.
  182. <P></P>
  183. <DT><STRONG><A NAME="item_detach">detach</A></STRONG><BR>
  184. <DD>
  185. <A HREF="#item_detach"><CODE>detach</CODE></A> tells a thread that it is never going to be joined i.e.
  186. that all traces of its existence can be removed once it stops running.
  187. Errors in detached threads will not be visible anywhere - if you want
  188. to catch them, you should use $SIG{__DIE__} or something like that.
  189. <P></P>
  190. <DT><STRONG><A NAME="item_equal">equal</A></STRONG><BR>
  191. <DD>
  192. <A HREF="#item_equal"><CODE>equal</CODE></A> tests whether two thread objects represent the same thread and
  193. returns true if they do.
  194. <P></P>
  195. <DT><STRONG><A NAME="item_tid">tid</A></STRONG><BR>
  196. <DD>
  197. The <A HREF="#item_tid"><CODE>tid</CODE></A> method returns the tid of a thread. The tid is a monotonically
  198. increasing integer assigned when a thread is created. The main thread of a
  199. program will have a tid of zero, while subsequent threads will have tids
  200. assigned starting with one.
  201. <P></P></DL>
  202. <P>
  203. <HR>
  204. <H1><A NAME="limitations">LIMITATIONS</A></H1>
  205. <P>The sequence number used to assign tids is a simple integer, and no
  206. checking is done to make sure the tid isn't currently in use. If a program
  207. creates more than 2^32 - 1 threads in a single run, threads may be assigned
  208. duplicate tids. This limitation may be lifted in a future version of Perl.</P>
  209. <P>
  210. <HR>
  211. <H1><A NAME="see also">SEE ALSO</A></H1>
  212. <P><A HREF="../lib/attributes.html">the attributes manpage</A>, <A HREF="../lib/Thread/Queue.html">the Thread::Queue manpage</A>, <A HREF="../lib/Thread/Semaphore.html">the Thread::Semaphore manpage</A>, <A HREF="../lib/Thread/Specific.html">the Thread::Specific manpage</A>.</P>
  213. <TABLE BORDER=0 CELLPADDING=0 CELLSPACING=0 WIDTH=100%>
  214. <TR><TD CLASS=block VALIGN=MIDDLE WIDTH=100% BGCOLOR="#cccccc">
  215. <STRONG><P CLASS=block> Thread - manipulate threads in Perl</P></STRONG>
  216. </TD></TR>
  217. </TABLE>
  218.  
  219. </BODY>
  220.  
  221. </HTML>
  222.