home *** CD-ROM | disk | FTP | other *** search
/ Chip 2000 May / Chip_2000-05_cd1.bin / zkuste / Perl / ActivePerl-5.6.0.613.msi / 䆊䌷䈹䈙䏵-䞅䞆䞀㡆䞃䄦䠥 / _f5bdaf664528f1664f180eea0d09ae7c < prev    next >
Text File  |  2000-03-23  |  7KB  |  186 lines

  1.  
  2. <HTML>
  3. <HEAD>
  4. <TITLE>IO::Select - OO interface to the select system call</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> IO::Select - OO interface to the select system call</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="#constructor">CONSTRUCTOR</A></LI>
  26.     <LI><A HREF="#methods">METHODS</A></LI>
  27.     <LI><A HREF="#example">EXAMPLE</A></LI>
  28.     <LI><A HREF="#author">AUTHOR</A></LI>
  29.     <LI><A HREF="#copyright">COPYRIGHT</A></LI>
  30. </UL>
  31. <!-- INDEX END -->
  32.  
  33. <HR>
  34. <P>
  35. <H1><A NAME="name">NAME</A></H1>
  36. <P>IO::Select - OO interface to the select system call</P>
  37. <P>
  38. <HR>
  39. <H1><A NAME="supportedplatforms">SUPPORTED PLATFORMS</A></H1>
  40. <UL>
  41. <LI>Linux</LI>
  42. <LI>Solaris</LI>
  43. <LI>Windows</LI>
  44. </UL>
  45. <HR>
  46. <H1><A NAME="synopsis">SYNOPSIS</A></H1>
  47. <PRE>
  48.     use IO::Select;</PRE>
  49. <PRE>
  50.     $s = IO::Select->new();</PRE>
  51. <PRE>
  52.     $s->add(\*STDIN);
  53.     $s->add($some_handle);</PRE>
  54. <PRE>
  55.     @ready = $s->can_read($timeout);</PRE>
  56. <PRE>
  57.     @ready = IO::Select->new(@handles)->read(0);</PRE>
  58. <P>
  59. <HR>
  60. <H1><A NAME="description">DESCRIPTION</A></H1>
  61. <P>The <CODE>IO::Select</CODE> package implements an object approach to the system <A HREF="#item_select"><CODE>select</CODE></A>
  62. function call. It allows the user to see what IO handles, see <A HREF="../../lib/IO/Handle.html">the IO::Handle manpage</A>,
  63. are ready for reading, writing or have an error condition pending.</P>
  64. <P>
  65. <HR>
  66. <H1><A NAME="constructor">CONSTRUCTOR</A></H1>
  67. <DL>
  68. <DT><STRONG><A NAME="item_new">new ( [ HANDLES ] )</A></STRONG><BR>
  69. <DD>
  70. The constructor creates a new object and optionally initialises it with a set
  71. of handles.
  72. <P></P></DL>
  73. <P>
  74. <HR>
  75. <H1><A NAME="methods">METHODS</A></H1>
  76. <DL>
  77. <DT><STRONG><A NAME="item_add">add ( HANDLES )</A></STRONG><BR>
  78. <DD>
  79. Add the list of handles to the <CODE>IO::Select</CODE> object. It is these values that
  80. will be returned when an event occurs. <CODE>IO::Select</CODE> keeps these values in a
  81. cache which is indexed by the <A HREF="../../lib/Pod/perlfunc.html#item_fileno"><CODE>fileno</CODE></A> of the handle, so if more than one
  82. handle with the same <A HREF="../../lib/Pod/perlfunc.html#item_fileno"><CODE>fileno</CODE></A> is specified then only the last one is cached.
  83. <P>Each handle can be an <CODE>IO::Handle</CODE> object, an integer or an array
  84. reference where the first element is a <CODE>IO::Handle</CODE> or an integer.</P>
  85. <P></P>
  86. <DT><STRONG><A NAME="item_remove">remove ( HANDLES )</A></STRONG><BR>
  87. <DD>
  88. Remove all the given handles from the object. This method also works
  89. by the <A HREF="../../lib/Pod/perlfunc.html#item_fileno"><CODE>fileno</CODE></A> of the handles. So the exact handles that were added
  90. need not be passed, just handles that have an equivalent <A HREF="../../lib/Pod/perlfunc.html#item_fileno"><CODE>fileno</CODE></A>
  91. <P></P>
  92. <DT><STRONG><A NAME="item_exists">exists ( HANDLE )</A></STRONG><BR>
  93. <DD>
  94. Returns a true value (actually the handle itself) if it is present.
  95. Returns undef otherwise.
  96. <P></P>
  97. <DT><STRONG><A NAME="item_handles">handles</A></STRONG><BR>
  98. <DD>
  99. Return an array of all registered handles.
  100. <P></P>
  101. <DT><STRONG><A NAME="item_can_read">can_read ( [ TIMEOUT ] )</A></STRONG><BR>
  102. <DD>
  103. Return an array of handles that are ready for reading. <CODE>TIMEOUT</CODE> is
  104. the maximum amount of time to wait before returning an empty list. If
  105. <CODE>TIMEOUT</CODE> is not given and any handles are registered then the call
  106. will block.
  107. <P></P>
  108. <DT><STRONG><A NAME="item_can_write">can_write ( [ TIMEOUT ] )</A></STRONG><BR>
  109. <DD>
  110. Same as <A HREF="#item_can_read"><CODE>can_read</CODE></A> except check for handles that can be written to.
  111. <P></P>
  112. <DT><STRONG><A NAME="item_has_exception">has_exception ( [ TIMEOUT ] )</A></STRONG><BR>
  113. <DD>
  114. Same as <A HREF="#item_can_read"><CODE>can_read</CODE></A> except check for handles that have an exception
  115. condition, for example pending out-of-band data.
  116. <P></P>
  117. <DT><STRONG><A NAME="item_count">count ()</A></STRONG><BR>
  118. <DD>
  119. Returns the number of handles that the object will check for when
  120. one of the <CODE>can_</CODE> methods is called or the object is passed to
  121. the <A HREF="#item_select"><CODE>select</CODE></A> static method.
  122. <P></P>
  123. <DT><STRONG><A NAME="item_bits"><CODE>bits()</CODE></A></STRONG><BR>
  124. <DD>
  125. Return the bit string suitable as argument to the core <A HREF="#item_select"><CODE>select()</CODE></A> call.
  126. <P></P>
  127. <DT><STRONG><A NAME="item_select">select ( READ, WRITE, ERROR [, TIMEOUT ] )</A></STRONG><BR>
  128. <DD>
  129. <A HREF="#item_select"><CODE>select</CODE></A> is a static method, that is you call it with the package
  130. name like <A HREF="#item_new"><CODE>new</CODE></A>. <CODE>READ</CODE>, <CODE>WRITE</CODE> and <CODE>ERROR</CODE> are either <A HREF="../../lib/Pod/perlfunc.html#item_undef"><CODE>undef</CODE></A>
  131. or <CODE>IO::Select</CODE> objects. <CODE>TIMEOUT</CODE> is optional and has the same
  132. effect as for the core select call.
  133. <P>The result will be an array of 3 elements, each a reference to an array
  134. which will hold the handles that are ready for reading, writing and have
  135. error conditions respectively. Upon error an empty array is returned.</P>
  136. <P></P></DL>
  137. <P>
  138. <HR>
  139. <H1><A NAME="example">EXAMPLE</A></H1>
  140. <P>Here is a short example which shows how <CODE>IO::Select</CODE> could be used
  141. to write a server which communicates with several sockets while also
  142. listening for more connections on a listen socket</P>
  143. <PRE>
  144.     use IO::Select;
  145.     use IO::Socket;</PRE>
  146. <PRE>
  147.     $lsn = new IO::Socket::INET(Listen => 1, LocalPort => 8080);
  148.     $sel = new IO::Select( $lsn );</PRE>
  149. <PRE>
  150.     while(@ready = $sel->can_read) {
  151.         foreach $fh (@ready) {
  152.             if($fh == $lsn) {
  153.                 # Create a new socket
  154.                 $new = $lsn->accept;
  155.                 $sel->add($new);
  156.             }
  157.             else {
  158.                 # Process socket</PRE>
  159. <PRE>
  160.                 # Maybe we have finished with the socket
  161.                 $sel->remove($fh);
  162.                 $fh->close;
  163.             }
  164.         }
  165.     }</PRE>
  166. <P>
  167. <HR>
  168. <H1><A NAME="author">AUTHOR</A></H1>
  169. <P>Graham Barr. Currently maintained by the Perl Porters.  Please report all
  170. bugs to <<A HREF="mailto:perl5-porters@perl.org">perl5-porters@perl.org</A>>.</P>
  171. <P>
  172. <HR>
  173. <H1><A NAME="copyright">COPYRIGHT</A></H1>
  174. <P>Copyright (c) 1997-8 Graham Barr <<A HREF="mailto:gbarr@pobox.com">gbarr@pobox.com</A>>. All rights reserved.
  175. This program is free software; you can redistribute it and/or
  176. modify it under the same terms as Perl itself.</P>
  177. <TABLE BORDER=0 CELLPADDING=0 CELLSPACING=0 WIDTH=100%>
  178. <TR><TD CLASS=block VALIGN=MIDDLE WIDTH=100% BGCOLOR="#cccccc">
  179. <STRONG><P CLASS=block> IO::Select - OO interface to the select system call</P></STRONG>
  180. </TD></TR>
  181. </TABLE>
  182.  
  183. </BODY>
  184.  
  185. </HTML>
  186.