home *** CD-ROM | disk | FTP | other *** search
/ Chip 2000 May / Chip_2000-05_cd1.bin / zkuste / Perl / ActivePerl-5.6.0.613.msi / 䆊䌷䈹䈙䏵-䞅䞆䞀㡆䞃䄦䠥 / _b8ddc3f134ba254b448c5da55feec34b < prev    next >
Text File  |  2000-03-23  |  10KB  |  243 lines
  1.  
  2. <HTML>
  3. <HEAD>
  4. <TITLE>CGI::Push - Simple Interface to Server Push</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> CGI::Push - Simple Interface to Server Push</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="#using cgi::push">USING CGI::Push</A></LI>
  26.     <UL>
  27.  
  28.         <LI><A HREF="#heterogeneous pages">Heterogeneous Pages</A></LI>
  29.         <LI><A HREF="#changing the page delay on the fly">Changing the Page Delay on the Fly</A></LI>
  30.     </UL>
  31.  
  32.     <LI><A HREF="#installing cgi::push scripts">INSTALLING CGI::Push SCRIPTS</A></LI>
  33.     <LI><A HREF="#author information">AUTHOR INFORMATION</A></LI>
  34.     <LI><A HREF="#bugs">BUGS</A></LI>
  35.     <LI><A HREF="#see also">SEE ALSO</A></LI>
  36. </UL>
  37. <!-- INDEX END -->
  38.  
  39. <HR>
  40. <P>
  41. <H1><A NAME="name">NAME</A></H1>
  42. <P>CGI::Push - Simple Interface to Server Push</P>
  43. <P>
  44. <HR>
  45. <H1><A NAME="supportedplatforms">SUPPORTED PLATFORMS</A></H1>
  46. <UL>
  47. <LI>Linux</LI>
  48. <LI>Solaris</LI>
  49. <LI>Windows</LI>
  50. </UL>
  51. <HR>
  52. <H1><A NAME="synopsis">SYNOPSIS</A></H1>
  53. <PRE>
  54.     use CGI::Push qw(:standard);</PRE>
  55. <PRE>
  56.     do_push(-next_page=>\&next_page,
  57.             -last_page=>\&last_page,
  58.             -delay=>0.5);</PRE>
  59. <PRE>
  60.     sub next_page {
  61.         my($q,$counter) = @_;
  62.         return undef if $counter >= 10;
  63.         return start_html('Test'),
  64.                h1('Visible'),"\n",
  65.                "This page has been called ", strong($counter)," times",
  66.                end_html();
  67.       }</PRE>
  68. <PRE>
  69.      sub last_page {
  70.          my($q,$counter) = @_;
  71.          return start_html('Done'),
  72.                 h1('Finished'),
  73.                 strong($counter),' iterations.',
  74.                 end_html;
  75.      }</PRE>
  76. <P>
  77. <HR>
  78. <H1><A NAME="description">DESCRIPTION</A></H1>
  79. <P>CGI::Push is a subclass of the CGI object created by CGI.pm.  It is
  80. specialized for server push operations, which allow you to create
  81. animated pages whose content changes at regular intervals.</P>
  82. <P>You provide CGI::Push with a pointer to a subroutine that will draw
  83. one page.  Every time your subroutine is called, it generates a new
  84. page.  The contents of the page will be transmitted to the browser
  85. in such a way that it will replace what was there beforehand.  The
  86. technique will work with HTML pages as well as with graphics files, 
  87. allowing you to create animated GIFs.</P>
  88. <P>
  89. <HR>
  90. <H1><A NAME="using cgi::push">USING CGI::Push</A></H1>
  91. <P>CGI::Push adds one new method to the standard CGI suite, do_push().
  92. When you call this method, you pass it a reference to a subroutine
  93. that is responsible for drawing each new page, an interval delay, and
  94. an optional subroutine for drawing the last page.  Other optional
  95. parameters include most of those recognized by the CGI <CODE>header()</CODE>
  96. method.</P>
  97. <P>You may call <CODE>do_push()</CODE> in the object oriented manner or not, as you
  98. prefer:</P>
  99. <PRE>
  100.     use CGI::Push;
  101.     $q = new CGI::Push;
  102.     $q->do_push(-next_page=>\&draw_a_page);</PRE>
  103. <PRE>
  104.         -or-</PRE>
  105. <PRE>
  106.     use CGI::Push qw(:standard);
  107.     do_push(-next_page=>\&draw_a_page);</PRE>
  108. <P>Parameters are as follows:</P>
  109. <DL>
  110. <DT><STRONG><A NAME="item_%2Dnext_page">-next_page</A></STRONG><BR>
  111. <DD>
  112. <PRE>
  113.     do_push(-next_page=>\&my_draw_routine);</PRE>
  114. <P>This required parameter points to a reference to a subroutine responsible for
  115. drawing each new page.  The subroutine should expect two parameters
  116. consisting of the CGI object and a counter indicating the number
  117. of times the subroutine has been called.  It should return the
  118. contents of the page as an <STRONG>array</STRONG> of one or more items to print.  
  119. It can return a false value (or an empty array) in order to abort the
  120. redrawing loop and print out the final page (if any)</P>
  121. <PRE>
  122.     sub my_draw_routine {
  123.         my($q,$counter) = @_;
  124.         return undef if $counter > 100;
  125.         return start_html('testing'),
  126.                h1('testing'),
  127.                "This page called $counter times";
  128.     }</PRE>
  129. <P>You are of course free to refer to create and use global variables
  130. within your draw routine in order to achieve special effects.</P>
  131. <DT><STRONG><A NAME="item_%2Dlast_page">-last_page</A></STRONG><BR>
  132. <DD>
  133. This optional parameter points to a reference to the subroutine
  134. responsible for drawing the last page of the series.  It is called
  135. after the -next_page routine returns a false value.  The subroutine
  136. itself should have exactly the same calling conventions as the
  137. -next_page routine.
  138. <P></P>
  139. <DT><STRONG><A NAME="item_%2Dtype">-type</A></STRONG><BR>
  140. <DD>
  141. This optional parameter indicates the content type of each page.  It
  142. defaults to ``text/html''.  Normally the module assumes that each page
  143. is of a homogenous MIME type.  However if you provide either of the
  144. magic values ``heterogeneous'' or ``dynamic'' (the latter provided for the
  145. convenience of those who hate long parameter names), you can specify
  146. the MIME type -- and other header fields -- on a per-page basis.  See 
  147. ``heterogeneous pages'' for more details.
  148. <P></P>
  149. <DT><STRONG><A NAME="item_%2Ddelay">-delay</A></STRONG><BR>
  150. <DD>
  151. This indicates the delay, in seconds, between frames.  Smaller delays
  152. refresh the page faster.  Fractional values are allowed.
  153. <P><STRONG>If not specified, -delay will default to 1 second</STRONG></P>
  154. <P></P>
  155. <DT><STRONG><A NAME="item_%2Dcookie%2C_%2Dtarget%2C_%2Dexpires">-cookie, -target, -expires</A></STRONG><BR>
  156. <DD>
  157. These have the same meaning as the like-named parameters in
  158. CGI::header().
  159. <P></P></DL>
  160. <P>
  161. <H2><A NAME="heterogeneous pages">Heterogeneous Pages</A></H2>
  162. <P>Ordinarily all pages displayed by CGI::Push share a common MIME type.
  163. However by providing a value of ``heterogeneous'' or ``dynamic'' in the
  164. <CODE>do_push()</CODE> -type parameter, you can specify the MIME type of each page
  165. on a case-by-case basis.</P>
  166. <P>If you use this option, you will be responsible for producing the
  167. HTTP header for each page.  Simply modify your draw routine to
  168. look like this:</P>
  169. <PRE>
  170.     sub my_draw_routine {
  171.         my($q,$counter) = @_;
  172.         return header('text/html'),   # note we're producing the header here
  173.                start_html('testing'),
  174.                h1('testing'),
  175.                "This page called $counter times";
  176.     }</PRE>
  177. <P>You can add any header fields that you like, but some (cookies and
  178. status fields included) may not be interpreted by the browser.  One
  179. interesting effect is to display a series of pages, then, after the
  180. last page, to redirect the browser to a new URL.  Because <CODE>redirect()</CODE> 
  181. does b<not> work, the easiest way is with a -refresh header field,
  182. as shown below:</P>
  183. <PRE>
  184.     sub my_draw_routine {
  185.         my($q,$counter) = @_;
  186.         return undef if $counter > 10;
  187.         return header('text/html'),   # note we're producing the header here
  188.                start_html('testing'),
  189.                h1('testing'),
  190.                "This page called $counter times";
  191.     }</PRE>
  192. <PRE>
  193.     sub my_last_page {
  194.         header(-refresh=>'5; URL=<A HREF="http://somewhere.else/finished.html">http://somewhere.else/finished.html</A>',
  195.                -type=>'text/html'),
  196.         start_html('Moved'),
  197.         h1('This is the last page'),
  198.         'Goodbye!'
  199.          hr,    
  200.          end_html; 
  201.     }</PRE>
  202. <P>
  203. <H2><A NAME="changing the page delay on the fly">Changing the Page Delay on the Fly</A></H2>
  204. <P>If you would like to control the delay between pages on a page-by-page
  205. basis, call <CODE>push_delay()</CODE> from within your draw routine.  <CODE>push_delay()</CODE>
  206. takes a single numeric argument representing the number of seconds you
  207. wish to delay after the current page is displayed and before
  208. displaying the next one.  The delay may be fractional.  Without
  209. parameters, <CODE>push_delay()</CODE> just returns the current delay.</P>
  210. <P>
  211. <HR>
  212. <H1><A NAME="installing cgi::push scripts">INSTALLING CGI::Push SCRIPTS</A></H1>
  213. <P>Server push scripts <STRONG>must</STRONG> be installed as no-parsed-header (NPH)
  214. scripts in order to work correctly.  On Unix systems, this is most
  215. often accomplished by prefixing the script's name with ``nph-''.  
  216. Recognition of NPH scripts happens automatically with WebSTAR and 
  217. Microsoft IIS.  Users of other servers should see their documentation
  218. for help.</P>
  219. <P>
  220. <HR>
  221. <H1><A NAME="author information">AUTHOR INFORMATION</A></H1>
  222. <P>Copyright 1995-1998, Lincoln D. Stein.  All rights reserved.</P>
  223. <P>This library is free software; you can redistribute it and/or modify
  224. it under the same terms as Perl itself.</P>
  225. <P>Address bug reports and comments to: <A HREF="mailto:lstein@cshl.org">lstein@cshl.org</A></P>
  226. <P>
  227. <HR>
  228. <H1><A NAME="bugs">BUGS</A></H1>
  229. <P>This section intentionally left blank.</P>
  230. <P>
  231. <HR>
  232. <H1><A NAME="see also">SEE ALSO</A></H1>
  233. <P><A HREF="../../lib/CGI/Carp.html">the CGI::Carp manpage</A>, <A HREF="../../lib/CGI.html">the CGI manpage</A></P>
  234. <TABLE BORDER=0 CELLPADDING=0 CELLSPACING=0 WIDTH=100%>
  235. <TR><TD CLASS=block VALIGN=MIDDLE WIDTH=100% BGCOLOR="#cccccc">
  236. <STRONG><P CLASS=block> CGI::Push - Simple Interface to Server Push</P></STRONG>
  237. </TD></TR>
  238. </TABLE>
  239.  
  240. </BODY>
  241.  
  242. </HTML>
  243.