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 st...@apache.org on 2005/05/12 01:08:55 UTC
svn commit: r169715 - in /perl/modperl/docs/trunk/src/docs/2.0/api/APR:
Const.pod Status.pod
Author: stas
Date: Wed May 11 16:08:54 2005
New Revision: 169715
URL: http://svn.apache.org/viewcvs?rev=169715&view=rev
Log:
document APR::Status::is_ECONNRESET
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=169715&r1=169714&r2=169715&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 Wed May 11 16:08:54 2005
@@ -236,6 +236,11 @@
=back
+Due to possible variants in conditions matching C<ECONNRESET>, for
+checking error codes against this you most likely want to use the
+C<L<APR::Status::is_ECONNRESET|docs::2.0::api::APR::Status/C_is_ECONNRESET_>>
+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=169715&r1=169714&r2=169715&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 Wed May 11 16:08:54 2005
@@ -270,6 +270,36 @@
+=head2 C<is_ECONNRESET>
+
+Check if the error is matching C<ECONNRESET> and its variants
+(corresponds to the C<APR_STATUS_IS_ECONNRESET> macro).
+
+ $status = APR::Status::is_ECONNRESET($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<ECONNRESET>, the use
+of this function is recommended for checking error codes against this
+value, rather than just using
+C<L<APR::Const::ECONNRESET|docs::2.0::api::APR::Const/C_APR__Const__ECONNRESET_>>
+directly.
+
+
+
+
---------------------------------------------------------------------
To unsubscribe, e-mail: docs-cvs-unsubscribe@perl.apache.org
For additional commands, e-mail: docs-cvs-help@perl.apache.org