You are viewing a plain text version of this content. The canonical link for it is here.
Posted to docs-cvs@perl.apache.org by ra...@apache.org on 2005/05/10 18:10:54 UTC
svn commit: r169489 - in /perl/modperl/docs/trunk/src/docs/2.0/api/APR:
Const.pod Status.pod
Author: randyk
Date: Tue May 10 09:10:53 2005
New Revision: 169489
URL: http://svn.apache.org/viewcvs?rev=169489&view=rev
Log:
Document presence of is_EOF, is_CONNABORTED, and is_TIMEUP
functions of APR::Status, and provide cross-links to the
approriate APR::Const entry.
Modified:
perl/modperl/docs/trunk/src/docs/2.0/api/APR/Const.pod
perl/modperl/docs/trunk/src/docs/2.0/api/APR/Status.pod
Modified: perl/modperl/docs/trunk/src/docs/2.0/api/APR/Const.pod
URL: http://svn.apache.org/viewcvs/perl/modperl/docs/trunk/src/docs/2.0/api/APR/Const.pod?rev=169489&r1=169488&r2=169489&view=diff
==============================================================================
--- perl/modperl/docs/trunk/src/docs/2.0/api/APR/Const.pod (original)
+++ perl/modperl/docs/trunk/src/docs/2.0/api/APR/Const.pod Tue May 10 09:10:53 2005
@@ -104,7 +104,10 @@
=back
-
+Due to possible variants in conditions matching C<EACCES>,
+for checking error codes against this you most likely want to use the
+C<L<APR::Status::is_EACCES|docs::2.0::api::APR::Status/C_is_EACCES_>>
+function instead.
@@ -204,6 +207,11 @@
=back
+Due to possible variants in conditions matching C<ECONNABORTED>,
+for checking error codes against this you most likely want to use the
+C<L<APR::Status::is_ECONNABORTED|docs::2.0::api::APR::Status/C_is_ECONNABORTED_>>
+function instead.
+
@@ -456,6 +464,10 @@
=back
+Due to possible variants in conditions matching C<ENOENT>,
+for checking error codes against this you most likely want to use the
+C<L<APR::Status::is_ENOENT|docs::2.0::api::APR::Status/C_is_ENOENT_>>
+function instead.
@@ -663,6 +675,10 @@
=back
+Due to possible variants in conditions matching C<EOF>,
+for checking error codes against this you most likely want to use the
+C<L<APR::Status::is_EOF|docs::2.0::api::APR::Status/C_is_EOF_>>
+function instead.
@@ -2332,6 +2348,11 @@
=item since: 1.99_14
=back
+
+Due to possible variants in conditions matching C<TIMEUP>,
+for checking error codes against this you most likely want to use the
+C<L<APR::Status::is_TIMEUP|docs::2.0::api::APR::Status/C_is_TIMEUP_>>
+function instead.
Modified: perl/modperl/docs/trunk/src/docs/2.0/api/APR/Status.pod
URL: http://svn.apache.org/viewcvs/perl/modperl/docs/trunk/src/docs/2.0/api/APR/Status.pod?rev=169489&r1=169488&r2=169489&view=diff
==============================================================================
--- perl/modperl/docs/trunk/src/docs/2.0/api/APR/Status.pod (original)
+++ perl/modperl/docs/trunk/src/docs/2.0/api/APR/Status.pod Tue May 10 09:10:53 2005
@@ -129,11 +129,11 @@
die $@;
}
-As discussed above with C<APR::Const::EAGAIN>, the advantage of
-using C<is_EACCES> is portability - just checking
-C<$@> against C<APR::Const::EACCES> may work on some unices,
-but could fail on other platforms.
-
+Due to possible variants in conditions matching C<EACCES>,
+the use of this function is recommended for checking error codes
+against this value, rather than just using
+C<L<APR::Const::EACCES|docs::2.0::api::APR::Const/C_APR__Const__EACCES_>>
+directly.
=head2 C<is_ENOENT>
@@ -165,6 +165,95 @@
if ref $@ eq 'APR::Error' && APR::Status::is_ENOENT($@);
die $@;
}
+
+Due to possible variants in conditions matching C<ENOENT>,
+the use of this function is recommended for checking error codes
+against this value, rather than just using
+C<L<APR::Const::ENOENT|docs::2.0::api::APR::Const/C_APR__Const__ENOENT_>>
+directly.
+
+
+=head2 C<is_EOF>
+
+Check if the error is matching C<EOF> and its variants (corresponds
+to the C<APR_STATUS_IS_EOF> macro).
+
+ $status = APR::Status::is_EOF($error_code);
+
+=over 4
+
+=item arg1: C<$error_code> (integer or C<L<APR::Error
+object|docs::2.0::api::APR::Error>> )
+
+The error code or to check, normally C<$@> blessed into C<L<APR::Error
+object|docs::2.0::api::APR::Error>>.
+
+=item ret: C<$status> ( boolean )
+
+=item since: 1.999.24
+
+=back
+
+Due to possible variants in conditions matching C<EOF>,
+the use of this function is recommended for checking error codes
+against this value, rather than just using
+C<L<APR::Const::EOF|docs::2.0::api::APR::Const/C_APR__Const__EOF_>>
+directly.
+
+
+=head2 C<is_ECONNABORTED>
+
+Check if the error is matching C<ECONNABORTED> and its variants (corresponds
+to the C<APR_STATUS_IS_ECONNABORTED> macro).
+
+ $status = APR::Status::is_ECONNABORTED($error_code);
+
+=over 4
+
+=item arg1: C<$error_code> (integer or C<L<APR::Error
+object|docs::2.0::api::APR::Error>> )
+
+The error code or to check, normally C<$@> blessed into C<L<APR::Error
+object|docs::2.0::api::APR::Error>>.
+
+=item ret: C<$status> ( boolean )
+
+=item since: 1.999.24
+
+=back
+
+Due to possible variants in conditions matching C<ECONNABORTED>,
+the use of this function is recommended for checking error codes
+against this value, rather than just using
+C<L<APR::Const::ECONNABORTED|docs::2.0::api::APR::Const/C_APR__Const__ECONNABORTED_>> directly.
+
+
+=head2 C<is_TIMEUP>
+
+Check if the error is matching C<TIMEUP> and its variants (corresponds
+to the C<APR_STATUS_IS_TIMEUP> macro).
+
+ $status = APR::Status::is_TIMEUP($error_code);
+
+=over 4
+
+=item arg1: C<$error_code> (integer or C<L<APR::Error
+object|docs::2.0::api::APR::Error>> )
+
+The error code or to check, normally C<$@> blessed into C<L<APR::Error
+object|docs::2.0::api::APR::Error>>.
+
+=item ret: C<$status> ( boolean )
+
+=item since: 1.999.24
+
+=back
+
+Due to possible variants in conditions matching C<TIMEUP>,
+the use of this function is recommended for checking error codes
+against this value, rather than just using
+C<L<APR::Const::TIMEUP|docs::2.0::api::APR::Const/C_APR__Const__TIMEUP_>>
+directly.
=head1 See Also
---------------------------------------------------------------------
To unsubscribe, e-mail: docs-cvs-unsubscribe@perl.apache.org
For additional commands, e-mail: docs-cvs-help@perl.apache.org