/ 
lcwa-1.0.0
River stage zero No dependents
++
 / HTTP::Status
Author image Ralf S. Engelschall

NAME

HTTP::Status - HTTP Status code processing

SYNOPSIS

 use HTTP::Status;

 if ($rc != RC_OK) {
     print status_message($rc), "\n";
 }

 if (is_success($rc)) { ... }
 if (is_error($rc)) { ... }
 if (is_redirect($rc)) { ... }

DESCRIPTION

HTTP::Status is a library of routines for defining and classification of HTTP status codes for libwww-perl. Status codes are used to encode the overall outcome of a HTTP response message. Codes correspond to those defined in RFC 2068.

CONSTANTS

The following constant functions can be used as mnemonic status code names:

   RC_CONTINUE                          (100)
   RC_SWITCHING_PROTOCOLS               (101)

   RC_OK                                (200)
   RC_CREATED                           (201)
   RC_ACCEPTED                          (202)
   RC_NON_AUTHORITATIVE_INFORMATION     (203)
   RC_NO_CONTENT                        (204)
   RC_RESET_CONTENT                     (205)
   RC_PARTIAL_CONTENT                   (206)

   RC_MULTIPLE_CHOICES                  (300)
   RC_MOVED_PERMANENTLY                 (301)
   RC_MOVED_TEMPORARILY                 (302)
   RC_SEE_OTHER                         (303)
   RC_NOT_MODIFIED                      (304)
   RC_USE_PROXY                         (305)

   RC_BAD_REQUEST                       (400)
   RC_UNAUTHORIZED                      (401)
   RC_PAYMENT_REQUIRED                  (402)
   RC_FORBIDDEN                         (403)
   RC_NOT_FOUND                         (404)
   RC_METHOD_NOT_ALLOWED                (405)
   RC_NOT_ACCEPTABLE                    (406)
   RC_PROXY_AUTHENTICATION_REQUIRED     (407)
   RC_REQUEST_TIMEOUT                   (408)
   RC_CONFLICT                          (409)
   RC_GONE                              (410)
   RC_LENGTH_REQUIRED                   (411)
   RC_PRECONDITION_FAILED               (412)
   RC_REQUEST_ENTITY_TOO_LARGE          (413)
   RC_REQUEST_URI_TOO_LARGE             (414)
   RC_UNSUPPORTED_MEDIA_TYPE            (415)

   RC_INTERNAL_SERVER_ERROR             (500)
   RC_NOT_IMPLEMENTED                   (501)
   RC_BAD_GATEWAY                       (502)
   RC_SERVICE_UNAVAILABLE               (503)
   RC_GATEWAY_TIMEOUT                   (504)
   RC_HTTP_VERSION_NOT_SUPPORTED        (505)

FUNCTIONS

The following additional functions are provided. Most of them are exported by default.

status_message($code)

The status_message() function will translate status codes to human readable strings. The string is the same as found in the constant names above.

is_info($code)

Return TRUE if $code is an Informational status code.

is_success($code)

Return TRUE if $code is a Successful status code.

is_redirect($code)

Return TRUE if $code is a Redirection status code.

is_error($code)

Return TRUE if $code is an Error status code. The function return TRUE for both client error or a server error status codes.

is_client_error($code)

Return TRUE if $code is an Client Error status code. This function is not exported by default.

is_server_error($code)

Return TRUE if $code is an Server Error status code. This function is not exported by default.