OSSP CVS Repository

ossp - Difference in ossp-pkg/sio/al.pod versions 1.8 and 1.9
Not logged in
[Honeypot]  [Browse]  [Home]  [Login]  [Reports
[Search]  [Ticket]  [Timeline
  [History

ossp-pkg/sio/al.pod 1.8 -> 1.9

--- al.pod       2002/10/17 15:02:49     1.8
+++ al.pod       2002/10/18 09:09:18     1.9
@@ -67,6 +67,7 @@
 al_txfree,
 al_traverse,
 al_traverse_next,
+al_traverse_end,
 al_traverse_cb.
 
 =item B<Convenience Operations>:
@@ -284,6 +285,7 @@
 
 This function fails when the offset is outside the assembly line bounds.
 
+
 =item al_rc_t B<al_traverse_next>(al_t *I<al>, al_tx_t *I<tx>, al_chunk_t **I<alcp>);
 
 Complete a traversal step on the assembly line I<al> using the initialized
@@ -294,6 +296,14 @@
 The function returns AL_ERR_EOF when it passes the end (or beginning
 in case of backward traversal) of the assembly line.
 
+=item al_rc_t B<al_traverse_end>(al_t *I<al>, al_tx_t *I<tx>, int final);
+
+Clean up internal state of traversal. If I<final> is zero, you may
+continue the traversal later by calling B<al_traverse_next>. If
+I<final> is non-zero you need to start a new traversal. It is
+mandatory that every traversal that was started is finished by
+a call to B<al_traverse_end> with I<final> set to a non-zero value.
+
 =item al_rc_t B<al_traverse_cb>(al_t *I<al>, size_t I<off>, size_t I<n>, al_td_t I<dir>, al_rc_t (*I<cb>)(al_chunk_t *, void *), void *u);
 
 B<al_traverse_cb> is a wrapper function that does a full assembly line traversal in

CVSTrac 2.0.1