home *** CD-ROM | disk | FTP | other *** search
/ Chip 2000 May / Chip_2000-05_cd1.bin / zkuste / Perl / ActivePerl-5.6.0.613.msi / 䆊䌷䈹䈙䏵-䞅䞆䞀㡆䞃䄦䠥 / _99ccb52e571dc168b3401b69260886aa < prev    next >
Text File  |  2000-03-23  |  4KB  |  127 lines
  1.  
  2. <HTML>
  3. <HEAD>
  4. <TITLE>POE::Wheel - POE FollowTail Protocol Logic</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::Wheel - POE FollowTail Protocol Logic</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 methods">PUBLIC METHODS</A></LI>
  26.     <LI><A HREF="#events and parameters">EVENTS AND PARAMETERS</A></LI>
  27.     <LI><A HREF="#see also">SEE ALSO</A></LI>
  28.     <LI><A HREF="#bugs">BUGS</A></LI>
  29.     <LI><A HREF="#authors & copyrights">AUTHORS & COPYRIGHTS</A></LI>
  30. </UL>
  31. <!-- INDEX END -->
  32.  
  33. <HR>
  34. <P>
  35. <H1><A NAME="name">NAME</A></H1>
  36. <P>POE::Wheel - POE FollowTail Protocol Logic</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.   $wheel = new POE::Wheel::FollowTail(
  49.     Handle       => $file_handle,                 # File to tail
  50.     Driver       => new POE::Driver::Something(), # How to read it
  51.     Filter       => new POE::Filter::Something(), # How to parse it
  52.     PollInterval => 1,                  # How often to check it
  53.     InputState   => $input_event_name,  # State to call upon input
  54.     ErrorState   => $error_event_name,  # State to call upon error
  55.   );</PRE>
  56. <P>
  57. <HR>
  58. <H1><A NAME="description">DESCRIPTION</A></H1>
  59. <P>This wheel follows the end of an ever-growing file, perhaps a log
  60. file, and generates events whenever new data appears.  It is a
  61. read-only wheel, so it does not include a <CODE>put()</CODE> method.  It uses
  62. <A HREF="../../../../lib/Pod/perlfunc.html#item_tell"><CODE>tell()</CODE></A> and <A HREF="../../../../lib/Pod/perlfunc.html#item_seek"><CODE>seek()</CODE></A> functions, so it's only suitable for plain files.
  63. It won't tail pipes or consoles.</P>
  64. <P>
  65. <HR>
  66. <H1><A NAME="public methods">PUBLIC METHODS</A></H1>
  67. <UL>
  68. <LI>
  69. POE::Wheel::FollowTail::event(...)
  70. <P>Please see POE::Wheel.</P>
  71. <P></P></UL>
  72. <P>
  73. <HR>
  74. <H1><A NAME="events and parameters">EVENTS AND PARAMETERS</A></H1>
  75. <UL>
  76. <LI>
  77. PollInterval
  78. <P>PollInterval is the number of seconds to wait between file checks.
  79. Once FollowTail re-reaches the end of the file, it waits this long
  80. before checking again.</P>
  81. <P></P>
  82. <LI>
  83. InputState
  84. <P>The InputState event is identical to POE::Wheel::ReadWrite's
  85. InputState.  It's the state to be called when the followed file
  86. lengthens.</P>
  87. <P>ARG0 contains a logical chunk of data, read from the end of the tailed
  88. file.</P>
  89. <P></P>
  90. <LI>
  91. ErrorState
  92. <P>The ErrorState event contains the name of the state that will be
  93. called when a file error occurs.  The FollowTail wheel knows what to
  94. do with EAGAIN, so it's not considered a true error.</P>
  95. <P>The ARG0 parameter contains the name of the function that failed.
  96. ARG1 and ARG2 contain the numeric and string versions of $! at the
  97. time of the error, respectively.</P>
  98. <P>A sample ErrorState state:</P>
  99. <PRE>
  100.   sub error_state {
  101.     my ($operation, $errnum, $errstr) = @_[ARG0, ARG1, ARG2];
  102.     warn "$operation error $errnum: $errstr\n";
  103.   }</PRE>
  104. <P></P></UL>
  105. <P>
  106. <HR>
  107. <H1><A NAME="see also">SEE ALSO</A></H1>
  108. <P>POE::Wheel; POE::Wheel::ListenAccept; POE::Wheel::ReadWrite;
  109. POE::Wheel::SocketFactory</P>
  110. <P>
  111. <HR>
  112. <H1><A NAME="bugs">BUGS</A></H1>
  113. <P>This wheel can't tail pipes and consoles.  Blargh.</P>
  114. <P>
  115. <HR>
  116. <H1><A NAME="authors & copyrights">AUTHORS & COPYRIGHTS</A></H1>
  117. <P>Please see the POE manpage.</P>
  118. <TABLE BORDER=0 CELLPADDING=0 CELLSPACING=0 WIDTH=100%>
  119. <TR><TD CLASS=block VALIGN=MIDDLE WIDTH=100% BGCOLOR="#cccccc">
  120. <STRONG><P CLASS=block> POE::Wheel - POE FollowTail Protocol Logic</P></STRONG>
  121. </TD></TR>
  122. </TABLE>
  123.  
  124. </BODY>
  125.  
  126. </HTML>
  127.