.\" -*- mode: troff; coding: utf-8 -*- .\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. .ie n \{\ . ds C` "" . ds C' "" 'br\} .el\{\ . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" ======================================================================== .\" .IX Title "HTTP::Status 3" .TH HTTP::Status 3 2023-10-03 "perl v5.38.0" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH SYNOPSIS .IX Header "SYNOPSIS" .Vb 1 \& use HTTP::Status qw(:constants :is status_message); \& \& if ($rc != HTTP_OK) { \& print status_message($rc), "\en"; \& } \& \& if (is_success($rc)) { ... } \& if (is_error($rc)) { ... } \& if (is_redirect($rc)) { ... } .Ve .SH DESCRIPTION .IX Header "DESCRIPTION" \&\fIHTTP::Status\fR is a library of routines for defining and classifying HTTP status codes for libwww-perl. Status codes are used to encode the overall outcome of an HTTP response message. Codes correspond to those defined in RFC 2616 and RFC 2518. .SH CONSTANTS .IX Header "CONSTANTS" The following constant functions can be used as mnemonic status code names. None of these are exported by default. Use the \f(CW\*(C`:constants\*(C'\fR tag to import them all. .PP .Vb 4 \& HTTP_CONTINUE (100) \& HTTP_SWITCHING_PROTOCOLS (101) \& HTTP_PROCESSING (102) \& HTTP_EARLY_HINTS (103) \& \& HTTP_OK (200) \& HTTP_CREATED (201) \& HTTP_ACCEPTED (202) \& HTTP_NON_AUTHORITATIVE_INFORMATION (203) \& HTTP_NO_CONTENT (204) \& HTTP_RESET_CONTENT (205) \& HTTP_PARTIAL_CONTENT (206) \& HTTP_MULTI_STATUS (207) \& HTTP_ALREADY_REPORTED (208) \& \& HTTP_IM_USED (226) \& \& HTTP_MULTIPLE_CHOICES (300) \& HTTP_MOVED_PERMANENTLY (301) \& HTTP_FOUND (302) \& HTTP_SEE_OTHER (303) \& HTTP_NOT_MODIFIED (304) \& HTTP_USE_PROXY (305) \& HTTP_TEMPORARY_REDIRECT (307) \& HTTP_PERMANENT_REDIRECT (308) \& \& HTTP_BAD_REQUEST (400) \& HTTP_UNAUTHORIZED (401) \& HTTP_PAYMENT_REQUIRED (402) \& HTTP_FORBIDDEN (403) \& HTTP_NOT_FOUND (404) \& HTTP_METHOD_NOT_ALLOWED (405) \& HTTP_NOT_ACCEPTABLE (406) \& HTTP_PROXY_AUTHENTICATION_REQUIRED (407) \& HTTP_REQUEST_TIMEOUT (408) \& HTTP_CONFLICT (409) \& HTTP_GONE (410) \& HTTP_LENGTH_REQUIRED (411) \& HTTP_PRECONDITION_FAILED (412) \& HTTP_PAYLOAD_TOO_LARGE (413) \& HTTP_URI_TOO_LONG (414) \& HTTP_UNSUPPORTED_MEDIA_TYPE (415) \& HTTP_RANGE_NOT_SATISFIABLE (416) \& HTTP_EXPECTATION_FAILED (417) \& HTTP_MISDIRECTED REQUEST (421) \& HTTP_UNPROCESSABLE_ENTITY (422) \& HTTP_LOCKED (423) \& HTTP_FAILED_DEPENDENCY (424) \& HTTP_TOO_EARLY (425) \& HTTP_UPGRADE_REQUIRED (426) \& HTTP_PRECONDITION_REQUIRED (428) \& HTTP_TOO_MANY_REQUESTS (429) \& HTTP_REQUEST_HEADER_FIELDS_TOO_LARGE (431) \& HTTP_UNAVAILABLE_FOR_LEGAL_REASONS (451) \& \& HTTP_INTERNAL_SERVER_ERROR (500) \& HTTP_NOT_IMPLEMENTED (501) \& HTTP_BAD_GATEWAY (502) \& HTTP_SERVICE_UNAVAILABLE (503) \& HTTP_GATEWAY_TIMEOUT (504) \& HTTP_HTTP_VERSION_NOT_SUPPORTED (505) \& HTTP_VARIANT_ALSO_NEGOTIATES (506) \& HTTP_INSUFFICIENT_STORAGE (507) \& HTTP_LOOP_DETECTED (508) \& HTTP_NOT_EXTENDED (510) \& HTTP_NETWORK_AUTHENTICATION_REQUIRED (511) .Ve .SH FUNCTIONS .IX Header "FUNCTIONS" The following additional functions are provided. Most of them are exported by default. The \f(CW\*(C`:is\*(C'\fR import tag can be used to import all the classification functions. .ie n .IP "status_message( $code )" 4 .el .IP "status_message( \f(CW$code\fR )" 4 .IX Item "status_message( $code )" The \fBstatus_message()\fR function will translate status codes to human readable strings. The string is the same as found in the constant names above. For example, \f(CWstatus_message(303)\fR will return \f(CW"Not Found"\fR. .Sp If the \f(CW$code\fR is not registered in the list of IANA HTTP Status Codes then \f(CW\*(C`undef\*(C'\fR is returned. .ie n .IP "status_constant_name( $code )" 4 .el .IP "status_constant_name( \f(CW$code\fR )" 4 .IX Item "status_constant_name( $code )" The \fBstatus_constant_name()\fR function will translate a status code to a string which has the name of the constant for that status code. For example, \f(CWstatus_constant_name(404)\fR will return \f(CW"HTTP_NOT_FOUND"\fR. .Sp If the \f(CW$code\fR is not registered in the list of IANA HTTP Status Codes then \f(CW\*(C`undef\*(C'\fR is returned. .ie n .IP "is_info( $code )" 4 .el .IP "is_info( \f(CW$code\fR )" 4 .IX Item "is_info( $code )" Return TRUE if \f(CW$code\fR is an \fIInformational\fR status code (1xx). This class of status code indicates a provisional response which can't have any content. .ie n .IP "is_success( $code )" 4 .el .IP "is_success( \f(CW$code\fR )" 4 .IX Item "is_success( $code )" Return TRUE if \f(CW$code\fR is a \fISuccessful\fR status code (2xx). .ie n .IP "is_redirect( $code )" 4 .el .IP "is_redirect( \f(CW$code\fR )" 4 .IX Item "is_redirect( $code )" Return TRUE if \f(CW$code\fR is a \fIRedirection\fR status code (3xx). This class of status code indicates that further action needs to be taken by the user agent in order to fulfill the request. .ie n .IP "is_error( $code )" 4 .el .IP "is_error( \f(CW$code\fR )" 4 .IX Item "is_error( $code )" Return TRUE if \f(CW$code\fR is an \fIError\fR status code (4xx or 5xx). The function returns TRUE for both client and server error status codes. .ie n .IP "is_client_error( $code )" 4 .el .IP "is_client_error( \f(CW$code\fR )" 4 .IX Item "is_client_error( $code )" Return TRUE if \f(CW$code\fR is a \fIClient Error\fR status code (4xx). This class of status code is intended for cases in which the client seems to have erred. .Sp This function is \fBnot\fR exported by default. .ie n .IP "is_server_error( $code )" 4 .el .IP "is_server_error( \f(CW$code\fR )" 4 .IX Item "is_server_error( $code )" Return TRUE if \f(CW$code\fR is a \fIServer Error\fR status code (5xx). This class of status codes is intended for cases in which the server is aware that it has erred or is incapable of performing the request. .Sp This function is \fBnot\fR exported by default. .ie n .IP "is_cacheable_by_default( $code )" 4 .el .IP "is_cacheable_by_default( \f(CW$code\fR )" 4 .IX Item "is_cacheable_by_default( $code )" Return TRUE if \f(CW$code\fR indicates that a response is cacheable by default, and it can be reused by a cache with heuristic expiration. All other status codes are not cacheable by default. See RFC 7231 \- HTTP/1.1 Semantics and Content, Section 6.1. Overview of Status Codes . .Sp This function is \fBnot\fR exported by default. .IP status_codes 4 .IX Item "status_codes" Returns a hash mapping numerical HTTP status code (e.g. 200) to text status messages (e.g. "OK") .Sp This function is \fBnot\fR exported by default. .SH "SEE ALSO" .IX Header "SEE ALSO" IANA HTTP Status Codes .SH BUGS .IX Header "BUGS" For legacy reasons all the \f(CW\*(C`HTTP_\*(C'\fR constants are exported by default with the prefix \f(CW\*(C`RC_\*(C'\fR. It's recommended to use explicit imports and the \f(CW\*(C`:constants\*(C'\fR tag instead of relying on this.