home *** CD-ROM | disk | FTP | other *** search
/ Chip 2000 May / Chip_2000-05_cd1.bin / zkuste / Perl / ActivePerl-5.6.0.613.msi / 䆊䌷䈹䈙䏵-䞅䞆䞀㡆䞃䄦䠥 / _859ca3a8d25b391cd00ab35e977b674a < prev    next >
Text File  |  2000-03-23  |  4KB  |  132 lines
  1.  
  2. <HTML>
  3. <HEAD>
  4. <TITLE>Thread::Queue - thread-safe queues</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::Queue - thread-safe queues</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 and methods">FUNCTIONS AND METHODS</A></LI>
  26.     <LI><A HREF="#see also">SEE ALSO</A></LI>
  27. </UL>
  28. <!-- INDEX END -->
  29.  
  30. <HR>
  31. <P>
  32. <H1><A NAME="name">NAME</A></H1>
  33. <P>Thread::Queue - thread-safe queues</P>
  34. <P>
  35. <HR>
  36. <H1><A NAME="supportedplatforms">SUPPORTED PLATFORMS</A></H1>
  37. <UL>
  38. <LI>Windows</LI>
  39. </UL>
  40. <HR>
  41. <H1><A NAME="synopsis">SYNOPSIS</A></H1>
  42. <PRE>
  43.     use Thread::Queue;
  44.     my $q = new Thread::Queue;
  45.     $q->enqueue("foo", "bar");
  46.     my $foo = $q->dequeue;    # The "bar" is still in the queue.
  47.     my $foo = $q->dequeue_nb; # returns "bar", or undef if the queue was
  48.                               # empty
  49.     my $left = $q->pending;   # returns the number of items still in the queue</PRE>
  50. <P>
  51. <HR>
  52. <H1><A NAME="description">DESCRIPTION</A></H1>
  53. <P>A queue, as implemented by <CODE>Thread::Queue</CODE> is a thread-safe data structure
  54. much like a list. Any number of threads can safely add elements to the end
  55. of the list, or remove elements from the head of the list. (Queues don't
  56. permit adding or removing elements from the middle of the list)</P>
  57. <P>
  58. <HR>
  59. <H1><A NAME="functions and methods">FUNCTIONS AND METHODS</A></H1>
  60. <DL>
  61. <DT><STRONG><A NAME="item_new">new</A></STRONG><BR>
  62. <DD>
  63. The <A HREF="#item_new"><CODE>new</CODE></A> function creates a new empty queue.
  64. <P></P>
  65. <DT><STRONG><A NAME="item_enqueue">enqueue LIST</A></STRONG><BR>
  66. <DD>
  67. The <A HREF="#item_enqueue"><CODE>enqueue</CODE></A> method adds a list of scalars on to the end of the queue.
  68. The queue will grow as needed to accomodate the list.
  69. <P></P>
  70. <DT><STRONG><A NAME="item_dequeue">dequeue</A></STRONG><BR>
  71. <DD>
  72. The <A HREF="#item_dequeue"><CODE>dequeue</CODE></A> method removes a scalar from the head of the queue and
  73. returns it. If the queue is currently empty, <A HREF="#item_dequeue"><CODE>dequeue</CODE></A> will block the
  74. thread until another thread <A HREF="#item_enqueue"><CODE>enqueue</CODE></A>s a scalar.
  75. <P></P>
  76. <DT><STRONG><A NAME="item_dequeue_nb">dequeue_nb</A></STRONG><BR>
  77. <DD>
  78. The <A HREF="#item_dequeue_nb"><CODE>dequeue_nb</CODE></A> method, like the <A HREF="#item_dequeue"><CODE>dequeue</CODE></A> method, removes a scalar from
  79. the head of the queue and returns it. Unlike <A HREF="#item_dequeue"><CODE>dequeue</CODE></A>, though,
  80. <A HREF="#item_dequeue_nb"><CODE>dequeue_nb</CODE></A> won't block if the queue is empty, instead returning
  81. <A HREF="../../lib/Pod/perlfunc.html#item_undef"><CODE>undef</CODE></A>.
  82. <P></P>
  83. <DT><STRONG><A NAME="item_pending">pending</A></STRONG><BR>
  84. <DD>
  85. The <A HREF="#item_pending"><CODE>pending</CODE></A> method returns the number of items still in the queue.  (If
  86. there can be multiple readers on the queue it's best to lock the queue
  87. before checking to make sure that it stays in a consistent state)
  88. <P></P></DL>
  89. <P>
  90. <HR>
  91. <H1><A NAME="see also">SEE ALSO</A></H1>
  92. <P><A HREF="../../lib/Thread.html">the Thread manpage</A>
  93. </P>
  94. <PRE>
  95.  
  96. =cut</PRE>
  97. <P>sub new {
  98.     my $class = shift;
  99.     return bless [@_], $class;
  100. }</P>
  101. <P>sub dequeue : locked : method {
  102.     my $q = shift;
  103.     cond_wait $q until @$q;
  104.     return shift @$q;
  105. }</P>
  106. <P>sub dequeue_nb : locked : method {
  107.   my $q = shift;
  108.   if (@$q) {
  109.     return shift @$q;
  110.   } else {
  111.     return undef;
  112.   }
  113. }</P>
  114. <P>sub enqueue : locked : method {
  115.     my $q = shift;
  116.     push(@$q, @_) and cond_broadcast $q;
  117. }</P>
  118. <P>sub pending : locked : method {
  119.   my $q = shift;
  120.   return scalar(@$q);
  121. }</P>
  122. <P>1;</P>
  123. <TABLE BORDER=0 CELLPADDING=0 CELLSPACING=0 WIDTH=100%>
  124. <TR><TD CLASS=block VALIGN=MIDDLE WIDTH=100% BGCOLOR="#cccccc">
  125. <STRONG><P CLASS=block> Thread::Queue - thread-safe queues</P></STRONG>
  126. </TD></TR>
  127. </TABLE>
  128.  
  129. </BODY>
  130.  
  131. </HTML>
  132.