home *** CD-ROM | disk | FTP | other *** search
/ Chip 2000 May / Chip_2000-05_cd1.bin / zkuste / Perl / ActivePerl-5.6.0.613.msi / 䆊䌷䈹䈙䏵-䞅䞆䞀㡆䞃䄦䠥 / _41f1c4760f4e889f2a42c1b46ce26ea5 < prev    next >
Text File  |  2000-03-23  |  4KB  |  115 lines
  1.  
  2. <HTML>
  3. <HEAD>
  4. <TITLE>POE::Driver - POE Read/Write Abstraction</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> POE::Driver - POE Read/Write Abstraction</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="#public driver methods">PUBLIC DRIVER METHODS</A></LI>
  26.     <LI><A HREF="#see also">SEE ALSO</A></LI>
  27.     <LI><A HREF="#bugs">BUGS</A></LI>
  28.     <LI><A HREF="#authors & copyrights">AUTHORS & COPYRIGHTS</A></LI>
  29. </UL>
  30. <!-- INDEX END -->
  31.  
  32. <HR>
  33. <P>
  34. <H1><A NAME="name">NAME</A></H1>
  35. <P>POE::Driver - POE Read/Write Abstraction</P>
  36. <P>
  37. <HR>
  38. <H1><A NAME="supportedplatforms">SUPPORTED PLATFORMS</A></H1>
  39. <UL>
  40. <LI>Linux</LI>
  41. <LI>Solaris</LI>
  42. <LI>Windows</LI>
  43. </UL>
  44. <HR>
  45. <H1><A NAME="synopsis">SYNOPSIS</A></H1>
  46. <PRE>
  47.   $driver = new POE::Driver::Something();
  48.   $arrayref_of_data_chunks = $driver->get($filehandle);
  49.   $queue_size = $driver->put($arrayref_of_data_chunks);
  50.   $queue_size = $driver->flush($filehandle);</PRE>
  51. <P>
  52. <HR>
  53. <H1><A NAME="description">DESCRIPTION</A></H1>
  54. <P>Drivers provide a generic interface for low-level file I/O.  Wheels
  55. use this interface to read and write files, sockets, and things,
  56. without having to know the details for each.</P>
  57. <P>In theory, drivers should be pretty much interchangeable.  In
  58. practice, there seems to be an impermeable barrier between the
  59. different SOCK_* types.</P>
  60. <P>
  61. <HR>
  62. <H1><A NAME="public driver methods">PUBLIC DRIVER METHODS</A></H1>
  63. <P>These methods are the generic Driver interface.  Specific drivers may
  64. have additional methods.</P>
  65. <UL>
  66. <LI>
  67. POE::Driver::new()
  68. <P>The <CODE>new()</CODE> method creates and initializes a new driver.  Specific
  69. drivers may have different constructor parameters.</P>
  70. <P></P>
  71. <LI>
  72. POE::Driver::get($filehandle)
  73. <P>The <CODE>get()</CODE> method immediately tries to read information from a
  74. filehandle.  It returns a reference to an array of received data
  75. chunks.  The array may be empty if nothing could be read.  The array
  76. reference it returns is a suitable parameter to POE::Filter::get().</P>
  77. <P>Wheels usually call the <CODE>get()</CODE> method from their read select states.</P>
  78. <P></P>
  79. <LI>
  80. POE::Driver::put($arrayref_of_data_chunks)
  81. <P>The <CODE>put()</CODE> method places raw data into the driver's output queue.  Some
  82. drivers may flush data from the <CODE>put()</CODE> method.  It accepts a reference
  83. to an array of writable chunks, and it returns the number of elements
  84. it its output queue.</P>
  85. <P>Wheels usually call the <CODE>put()</CODE> method from their own <CODE>put()</CODE> methods.</P>
  86. <P></P>
  87. <LI>
  88. POE::Driver::flush($filehandle)
  89. <P>The <CODE>flush()</CODE> method attempts to flush some data from the driver's
  90. output queue to the file.  It returns the number of elements remaining
  91. in the output queue after the flush.</P>
  92. <P>Wheels usually call the <CODE>flush()</CODE> method from their write select states.</P>
  93. <P></P></UL>
  94. <P>
  95. <HR>
  96. <H1><A NAME="see also">SEE ALSO</A></H1>
  97. <P>POE::Driver::SysRW</P>
  98. <P>
  99. <HR>
  100. <H1><A NAME="bugs">BUGS</A></H1>
  101. <P>There is no POE::Driver::SendRecv</P>
  102. <P>
  103. <HR>
  104. <H1><A NAME="authors & copyrights">AUTHORS & COPYRIGHTS</A></H1>
  105. <P>Please see the POE manpage.</P>
  106. <TABLE BORDER=0 CELLPADDING=0 CELLSPACING=0 WIDTH=100%>
  107. <TR><TD CLASS=block VALIGN=MIDDLE WIDTH=100% BGCOLOR="#cccccc">
  108. <STRONG><P CLASS=block> POE::Driver - POE Read/Write Abstraction</P></STRONG>
  109. </TD></TR>
  110. </TABLE>
  111.  
  112. </BODY>
  113.  
  114. </HTML>
  115.