home *** CD-ROM | disk | FTP | other *** search
/ Chip 2000 May / Chip_2000-05_cd1.bin / zkuste / Perl / ActivePerl-5.6.0.613.msi / 䆊䌷䈹䈙䏵-䞅䞆䞀㡆䞃䄦䠥 / _879fb17ade24304bdfd1dc5847f6f6af < prev    next >
Text File  |  2000-03-23  |  7KB  |  174 lines
  1.  
  2. <HTML>
  3. <HEAD>
  4. <TITLE>HTTP::Status - HTTP Status code processing</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> HTTP::Status - HTTP Status code processing</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="#constants">CONSTANTS</A></LI>
  26.     <LI><A HREF="#functions">FUNCTIONS</A></LI>
  27.     <LI><A HREF="#bugs">BUGS</A></LI>
  28. </UL>
  29. <!-- INDEX END -->
  30.  
  31. <HR>
  32. <P>
  33. <H1><A NAME="name">NAME</A></H1>
  34. <P>HTTP::Status - HTTP Status code processing</P>
  35. <P>
  36. <HR>
  37. <H1><A NAME="supportedplatforms">SUPPORTED PLATFORMS</A></H1>
  38. <UL>
  39. <LI>Linux</LI>
  40. <LI>Solaris</LI>
  41. <LI>Windows</LI>
  42. </UL>
  43. <HR>
  44. <H1><A NAME="synopsis">SYNOPSIS</A></H1>
  45. <PRE>
  46.  use HTTP::Status;</PRE>
  47. <PRE>
  48.  if ($rc != RC_OK) {
  49.      print status_message($rc), "\n";
  50.  }</PRE>
  51. <PRE>
  52.  if (is_success($rc)) { ... }
  53.  if (is_error($rc)) { ... }
  54.  if (is_redirect($rc)) { ... }</PRE>
  55. <P>
  56. <HR>
  57. <H1><A NAME="description">DESCRIPTION</A></H1>
  58. <P><EM>HTTP::Status</EM> is a library of routines for defining and
  59. classifying HTTP status codes for libwww-perl.  Status codes are
  60. used to encode the overall outcome of a HTTP response message.  Codes
  61. correspond to those defined in <EM>draft-ietf-http-v11-spec-rev-03</EM> (an
  62. update to RFC 2068).</P>
  63. <P>
  64. <HR>
  65. <H1><A NAME="constants">CONSTANTS</A></H1>
  66. <P>The following constant functions can be used as mnemonic status code
  67. names:</P>
  68. <PRE>
  69.    RC_CONTINUE                          (100)
  70.    RC_SWITCHING_PROTOCOLS               (101)</PRE>
  71. <PRE>
  72.    RC_OK                                (200)
  73.    RC_CREATED                           (201)
  74.    RC_ACCEPTED                          (202)
  75.    RC_NON_AUTHORITATIVE_INFORMATION     (203)
  76.    RC_NO_CONTENT                        (204)
  77.    RC_RESET_CONTENT                     (205)
  78.    RC_PARTIAL_CONTENT                   (206)</PRE>
  79. <PRE>
  80.    RC_MULTIPLE_CHOICES                  (300)
  81.    RC_MOVED_PERMANENTLY                 (301)
  82.    RC_FOUND                             (302)
  83.    RC_SEE_OTHER                         (303)
  84.    RC_NOT_MODIFIED                      (304)
  85.    RC_USE_PROXY                         (305)
  86.    RC_TEMPORARY_REDIRECT                (307)</PRE>
  87. <PRE>
  88.    RC_BAD_REQUEST                       (400)
  89.    RC_UNAUTHORIZED                      (401)
  90.    RC_PAYMENT_REQUIRED                  (402)
  91.    RC_FORBIDDEN                         (403)
  92.    RC_NOT_FOUND                         (404)
  93.    RC_METHOD_NOT_ALLOWED                (405)
  94.    RC_NOT_ACCEPTABLE                    (406)
  95.    RC_PROXY_AUTHENTICATION_REQUIRED     (407)
  96.    RC_REQUEST_TIMEOUT                   (408)
  97.    RC_CONFLICT                          (409)
  98.    RC_GONE                              (410)
  99.    RC_LENGTH_REQUIRED                   (411)
  100.    RC_PRECONDITION_FAILED               (412)
  101.    RC_REQUEST_ENTITY_TOO_LARGE          (413)
  102.    RC_REQUEST_URI_TOO_LARGE             (414)
  103.    RC_UNSUPPORTED_MEDIA_TYPE            (415)
  104.    RC_REQUEST_RANGE_NOT_SATISFIABLE     (416)
  105.    RC_EXPECTATION_FAILED                (417)</PRE>
  106. <PRE>
  107.    RC_INTERNAL_SERVER_ERROR             (500)
  108.    RC_NOT_IMPLEMENTED                   (501)
  109.    RC_BAD_GATEWAY                       (502)
  110.    RC_SERVICE_UNAVAILABLE               (503)
  111.    RC_GATEWAY_TIMEOUT                   (504)
  112.    RC_HTTP_VERSION_NOT_SUPPORTED        (505)</PRE>
  113. <P>
  114. <HR>
  115. <H1><A NAME="functions">FUNCTIONS</A></H1>
  116. <P>The following additional functions are provided.  Most of them are
  117. exported by default.</P>
  118. <DL>
  119. <DT><STRONG><A NAME="item_status_message"><CODE>status_message($code)</CODE></A></STRONG><BR>
  120. <DD>
  121. The <A HREF="#item_status_message"><CODE>status_message()</CODE></A> function will translate status codes to human
  122. readable strings. The string is the same as found in the constant
  123. names above.  If the $code is unknown, then <A HREF="../../../lib/Pod/perlfunc.html#item_undef"><CODE>undef</CODE></A> is returned.
  124. <P></P>
  125. <DT><STRONG><A NAME="item_is_info"><CODE>is_info($code)</CODE></A></STRONG><BR>
  126. <DD>
  127. Return TRUE if <CODE>$code</CODE> is an <EM>Informational</EM> status code.  This
  128. class of status code indicates a provisional response which can't have
  129. any content.
  130. <P></P>
  131. <DT><STRONG><A NAME="item_is_success"><CODE>is_success($code)</CODE></A></STRONG><BR>
  132. <DD>
  133. Return TRUE if <CODE>$code</CODE> is a <EM>Successful</EM> status code.
  134. <P></P>
  135. <DT><STRONG><A NAME="item_is_redirect"><CODE>is_redirect($code)</CODE></A></STRONG><BR>
  136. <DD>
  137. Return TRUE if <CODE>$code</CODE> is a <EM>Redirection</EM> status code. This class of
  138. status code indicates that further action needs to be taken by the
  139. user agent in order to fulfill the request.
  140. <P></P>
  141. <DT><STRONG><A NAME="item_is_error"><CODE>is_error($code)</CODE></A></STRONG><BR>
  142. <DD>
  143. Return TRUE if <CODE>$code</CODE> is an <EM>Error</EM> status code.  The function
  144. return TRUE for both client error or a server error status codes.
  145. <P></P>
  146. <DT><STRONG><A NAME="item_is_client_error"><CODE>is_client_error($code)</CODE></A></STRONG><BR>
  147. <DD>
  148. Return TRUE if <CODE>$code</CODE> is an <EM>Client Error</EM> status code. This class
  149. of status code is intended for cases in which the client seems to have
  150. erred.
  151. <P>This function is <STRONG>not</STRONG> exported by default.</P>
  152. <P></P>
  153. <DT><STRONG><A NAME="item_is_server_error"><CODE>is_server_error($code)</CODE></A></STRONG><BR>
  154. <DD>
  155. Return TRUE if <CODE>$code</CODE> is an <EM>Server Error</EM> status code. This class
  156. of status codes is intended for cases in which the server is aware
  157. that it has erred or is incapable of performing the request.
  158. <P>This function is <STRONG>not</STRONG> exported by default.</P>
  159. <P></P></DL>
  160. <P>
  161. <HR>
  162. <H1><A NAME="bugs">BUGS</A></H1>
  163. <P>Wished @EXPORT_OK had been used instead of @EXPORT in the beginning.
  164. Now too much is exported by default.</P>
  165. <TABLE BORDER=0 CELLPADDING=0 CELLSPACING=0 WIDTH=100%>
  166. <TR><TD CLASS=block VALIGN=MIDDLE WIDTH=100% BGCOLOR="#cccccc">
  167. <STRONG><P CLASS=block> HTTP::Status - HTTP Status code processing</P></STRONG>
  168. </TD></TR>
  169. </TABLE>
  170.  
  171. </BODY>
  172.  
  173. </HTML>
  174.