Digital Mages - Net::ICAP::Common(3)

Net::ICAP::Common

Section: User Contributed Perl Documentation (3)
Updated: 2017-04-12
Index  

NAME

Net::ICAP::Common - Common ICAP Constants  

VERSION

$Id: lib/Net/ICAP/Common.pm, 0.04 2017/04/12 15:54:19 acorliss Exp $  

SYNOPSIS

    use Net::ICAP::Common qw(:all);

 

DESCRIPTION

This module provides commonly used constants. You can selective import the following sets of constants:

o :all - All constants

o :std - Basic ICAP constants common to all message types

o :req - ICAP constants specific to requests

o :resp - ICAP constants specific to responses

 

CONSTANTS

 

:std

The following constants are used (primarily) internally for all ICAP message types.

ICAP_DEF_PORT

  1344

The default TCP port used by ICAP.

ICAP_VERSION

  ICAP/1.0

The ICAP protocol version string.

ICAP_REQ_HDR

  req-hdr

The HTTP request header entity string as used in the Encapsulated header.

ICAP_RES_HDR

  res-hdr

The HTTP response header entity string as used in the Encapsulated header.

ICAP_REQ_BODY

  req-body

The HTTP request body entity string as used in the Encapsulated header.

ICAP_RES_BODY

  res-body

The HTTP response body entity string as used in the Encapsulated header.

ICAP_OPT_BODY

  opt-body

The ICAP options body entity string as used in the Encapsulated header.

ICAP_NULL_BODY

  null-body

The ICAP null body entity string as used in the Encapsulated header.  

:req

The following constants are used specifically for ICAP Request messages.

ICAP_REQMOD

  REQMOD

The Request Modification method.

ICAP_RESPMOD

  RESPMOD

The Response Modification method.

ICAP_OPTIONS

  OPTIONS

The Options method.  

:resp

The following constants are used specifically for ICAP Response messages.

ICAP_CONTINUE

  100

The ICAP status code for 'Continue after ICAP Preview' responses.

ICAP_OK

  200

The ICAP status code for 'OK' responses.

ICAP_NO_MOD_NEEDED

  204

The ICAP status code for 'No Modifications Needed' responses.

ICAP_BAD_REQUEST

  400

The ICAP status code for 'Bad Request' responses.

ICAP_UNAUTHORIZED

  401

The ICAP status code for 'Unauthorized' responses.

ICAP_FORBIDDEN

  403

The ICAP status code for 'Forbidden' responses.

ICAP_SERVICE_NOT_FOUND

  404

The ICAP status code for 'ICAP Service Not Found' responses.

ICAP_METHOD_NOT_ALLOWED

  405

The ICAP status code for 'Method Not Allowed For Service' responses.

ICAP_AUTH_REQUIRED

  407

The ICAP status code for 'Proxy Authentication Required' responses.

ICAP_REQUEST_TIMEOUT

  408

The ICAP status code for 'Request Time-out' responses.

ICAP_LENGTH_REQUIRED

  411

The ICAP status code for 'Length Required' responses.

ICAP_URI_TOO_LARGE

  414

The ICAP status code for 'Request-URI Too Large' responses.

ICAP_SERVER_ERROR

  500

The ICAP status code for 'Internal Server Error' responses.

ICAP_METHOD_NOT_IMPLEMENTED

  501

The ICAP status code for 'Method Not Implemented' responses.

ICAP_BAD_GATEWAY

  502

The ICAP status code for 'Bad Gateway' responses.

ICAP_SERVICE_OVERLOADED

  503

The ICAP status code for 'Service Overloaded' responses.

ICAP_GATEWAY_TIMEOUT

  504

The ICAP status code for 'Gateway Time-out' responses.

ICAP_VERSION_NOT_SUPPORTED

  505

The ICAP status code for 'ICAP Version Not Supported' responses.  

DEPENDENCIES

None.  

BUGS AND LIMITATIONS

It is very likely that there are additional status codes in use in the wild that are not included here, including the HTTP status codes that also apply to ICAP.  

AUTHOR

Arthur Corliss (corliss@digitalmages.com)  

LICENSE AND COPYRIGHT

This software is licensed under the same terms as Perl, itself. Please see http://dev.perl.org/licenses/ for more information.

(c) 2012, Arthur Corliss (corliss@digitalmages.com)

---

 

Index

NAME

VERSION

SYNOPSIS

DESCRIPTION

CONSTANTS

:std

:req

:resp

DEPENDENCIES

BUGS AND LIMITATIONS

AUTHOR

LICENSE AND COPYRIGHT

---