perl-docs-cvs mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From s...@apache.org
Subject cvs commit: modperl-docs/src/docs/2.0/api/APR Brigade.pod
Date Fri, 04 Jun 2004 04:13:26 GMT
stas        2004/06/03 21:13:25

  Modified:    src/docs/2.0/api/APR Brigade.pod
  Log:
  new function: cleanup
  
  Revision  Changes    Path
  1.7       +37 -0     modperl-docs/src/docs/2.0/api/APR/Brigade.pod
  
  Index: Brigade.pod
  ===================================================================
  RCS file: /home/cvs/modperl-docs/src/docs/2.0/api/APR/Brigade.pod,v
  retrieving revision 1.6
  retrieving revision 1.7
  diff -u -u -r1.6 -r1.7
  --- Brigade.pod	28 May 2004 02:54:34 -0000	1.6
  +++ Brigade.pod	4 Jun 2004 04:13:25 -0000	1.7
  @@ -31,6 +31,7 @@
     $bb3 = $bb->split($b_last);
     
     last if $bb->is_empty();
  +  $bb->cleanup();
     $bb->destroy();
   
   
  @@ -54,6 +55,42 @@
   =head1 API
   
   C<APR::Brigade> provides the following functions and/or methods:
  +
  +
  +=head2 C<cleanup>
  +
  +Empty out an entire bucket brigade:
  +
  +  $bb->cleanup;
  +
  +=over 4
  +
  +=item obj: C<$bb>
  +( C<L<APR::Brigade object|docs::2.0::api::APR::Brigade>> )
  +
  +The brigade to cleanup
  +
  +=item ret: no return value
  +
  +=item since: 1.99_10
  +
  +=back
  +
  +This method destroys all of the buckets within the bucket brigade's
  +bucket list.  This is similar to C<L<destroy()|/C_destroy_>>, except
  +that it does not deregister the brigade's C<L<pool()|/C_pool_>>
  +cleanup function.
  +
  +Generally, you should use C<L<destroy()|/C_destroy_>>.  This function
  +can be useful in situations where you have a single brigade that you
  +wish to reuse many times by destroying all of the buckets in the
  +brigade and putting new buckets into it later.
  +
  +
  +
  +
  +
  +
   
   
   
  
  
  

---------------------------------------------------------------------
To unsubscribe, e-mail: docs-cvs-unsubscribe@perl.apache.org
For additional commands, e-mail: docs-cvs-help@perl.apache.org


Mime
View raw message