|
Apache::Const - Perl Interface for Apache Constants |
:cmd_howApache::FLAGApache::ITERATEApache::ITERATE2Apache::NO_ARGSApache::RAW_ARGSApache::TAKE1Apache::TAKE12Apache::TAKE123Apache::TAKE13Apache::TAKE2Apache::TAKE23Apache::TAKE3:commonApache::AUTH_REQUIREDApache::DECLINEDApache::DONEApache::FORBIDDENApache::NOT_FOUNDApache::OKApache::REDIRECTApache::SERVER_ERROR:config:conn_keepalive:contextApache::NOT_IN_VIRTUALHOSTApache::NOT_IN_LIMITApache::NOT_IN_DIRECTORYApache::NOT_IN_LOCATIONApache::NOT_IN_FILESApache::NOT_IN_DIR_LOC_FILEApache::GLOBAL_ONLY:filter_typeApache::FTYPE_CONNECTIONApache::FTYPE_CONTENT_SETApache::FTYPE_NETWORKApache::FTYPE_PROTOCOLApache::FTYPE_RESOURCEApache::FTYPE_TRANSCODE:httpApache::HTTP_ACCEPTEDApache::HTTP_BAD_GATEWAYApache::HTTP_BAD_REQUESTApache::HTTP_CONFLICTApache::HTTP_CONTINUEApache::HTTP_CREATEDApache::HTTP_EXPECTATION_FAILEDApache::HTTP_FAILED_DEPENDENCYApache::HTTP_FORBIDDENApache::HTTP_GATEWAY_TIME_OUTApache::HTTP_GONEApache::HTTP_INSUFFICIENT_STORAGEApache::HTTP_INTERNAL_SERVER_ERRORApache::HTTP_LENGTH_REQUIREDApache::HTTP_LOCKEDApache::HTTP_METHOD_NOT_ALLOWEDApache::HTTP_MOVED_PERMANENTLYApache::HTTP_MOVED_TEMPORARILYApache::HTTP_MULTIPLE_CHOICESApache::HTTP_MULTI_STATUSApache::HTTP_NON_AUTHORITATIVEApache::HTTP_NOT_ACCEPTABLEApache::HTTP_NOT_EXTENDEDApache::HTTP_NOT_FOUNDApache::HTTP_NOT_IMPLEMENTEDApache::HTTP_NOT_MODIFIEDApache::HTTP_NO_CONTENTApache::HTTP_OKApache::HTTP_PARTIAL_CONTENTApache::HTTP_PAYMENT_REQUIREDApache::HTTP_PRECONDITION_FAILEDApache::HTTP_PROCESSINGApache::HTTP_PROXY_AUTHENTICATION_REQUIREDApache::HTTP_RANGE_NOT_SATISFIABLEApache::HTTP_REQUEST_ENTITY_TOO_LARGEApache::HTTP_REQUEST_TIME_OUTApache::HTTP_REQUEST_URI_TOO_LARGEApache::HTTP_RESET_CONTENTApache::HTTP_SEE_OTHERApache::HTTP_SERVICE_UNAVAILABLEApache::HTTP_SWITCHING_PROTOCOLSApache::HTTP_TEMPORARY_REDIRECTApache::HTTP_UNAUTHORIZEDApache::HTTP_UNPROCESSABLE_ENTITYApache::HTTP_UNSUPPORTED_MEDIA_TYPEApache::HTTP_UPGRADE_REQUIREDApache::HTTP_USE_PROXYApache::HTTP_VARIANT_ALSO_VARIES:input_modeApache::MODE_EATCRLFApache::MODE_EXHAUSTIVEApache::MODE_GETLINEApache::MODE_INITApache::MODE_READBYTESApache::MODE_SPECULATIVE:logApache::LOG_ALERTApache::LOG_CRITApache::LOG_DEBUGApache::LOG_EMERGApache::LOG_ERRApache::LOG_INFOApache::LOG_LEVELMASKApache::LOG_NOTICEApache::LOG_STARTUPApache::LOG_TOCLIENTApache::LOG_WARNING:methodsApache::METHODSApache::M_BASELINE_CONTROLApache::M_CHECKINApache::M_CHECKOUTApache::M_CONNECTApache::M_COPYApache::M_DELETEApache::M_GETApache::M_INVALIDApache::M_LABELApache::M_LOCKApache::M_MERGEApache::M_MKACTIVITYApache::M_MKCOLApache::M_MKWORKSPACEApache::M_MOVEApache::M_OPTIONSApache::M_PATCHApache::M_POSTApache::M_PROPFINDApache::M_PROPPATCHApache::M_PUTApache::M_REPORTApache::M_TRACEApache::M_UNCHECKOUTApache::M_UNLOCKApache::M_UPDATEApache::M_VERSION_CONTROL:mpmqApache::MPMQ_NOT_SUPPORTEDApache::MPMQ_STATICApache::MPMQ_DYNAMICApache::MPMQ_MAX_DAEMON_USEDApache::MPMQ_IS_THREADEDApache::MPMQ_IS_FORKEDApache::MPMQ_HARD_LIMIT_DAEMONSApache::MPMQ_HARD_LIMIT_THREADSApache::MPMQ_MAX_THREADSApache::MPMQ_MIN_SPARE_DAEMONSApache::MPMQ_MIN_SPARE_THREADSApache::MPMQ_MAX_SPARE_DAEMONSApache::MPMQ_MAX_SPARE_THREADSApache::MPMQ_MAX_REQUESTS_DAEMONApache::MPMQ_MAX_DAEMONS:optionsApache::OPT_ALLApache::OPT_EXECCGIApache::OPT_INCLUDESApache::OPT_INCNOEXECApache::OPT_INDEXESApache::OPT_MULTIApache::OPT_NONEApache::OPT_SYM_LINKSApache::OPT_SYM_OWNERApache::OPT_UNSET:overrideApache::ACCESS_CONFApache::OR_ALLApache::OR_AUTHCFGApache::OR_FILEINFOApache::OR_INDEXESApache::OR_LIMITApache::OR_NONEApache::OR_OPTIONSApache::OR_UNSETApache::RSRC_CONF:platform:remotehost:satisfy:types
Apache::Const - Perl Interface for Apache Constants
# make the constants available but don't import them use Apache::Const -compile => qw(constant names ...);
# w/o the => syntax sugar
use Apache::Const ("-compile", qw(constant names ...));
# compile and import the constants use Apache::Const qw(constant names ...);
This package contains constants specific to Apache features.
mod_perl 2.0 comes with several hundreds of constants, which you don't want to make available to your Perl code by default, due to CPU and memory overhead. Therefore when you want to use a certain constant you need to explicitly ask to make it available.
For example, the code:
use Apache::Const -compile => qw(FORBIDDEN OK);
makes the constants Apache::FORBIDDEN and Apache::OK available
to your code, but they aren't imported. In which case you need to use
a fully qualified constants, as in:
return Apache::OK;
If you drop the argument -compile and write:
use Apache::Const qw(FORBIDDEN OK);
Then both constants are imported into your code's namespace and can be used standalone like so:
return OK;
Both, due to the extra memory requirement, when importing symbols, and
since there are constants in other namespaces (e.g.,
APR::|docs::2.0::api::APR::Const and
ModPerl::|docs::2.0::api::ModPerl::Const, and non-mod_perl
modules) which may contain the same names, it's not recommended to
import constants. I.e. you want to use the -compile construct.
Finaly, in Perl => is almost the same as the comma operator. It
can be used as syntax sugar making it more clear when there is a
key-value relation between two arguments, and also it automatically
parses its lefthand argument (the key) as a string, so you don't need
to quote it.
If you don't want to use that syntax, instead of writing:
use Apache::Const -compile => qw(FORBIDDEN OK);
you could write:
use Apache::Const "-compile", qw(FORBIDDEN OK);
and for parentheses-lovers:
use Apache::Const ("-compile", qw(FORBIDDEN OK));
:cmd_howuse Apache::Const -compile => qw(:cmd_how);
The :cmd_how group is for XXX constants.
Apache::FLAG
Apache::ITERATE
Apache::ITERATE2
Apache::NO_ARGS
Apache::RAW_ARGS
Apache::TAKE1
Apache::TAKE12
Apache::TAKE123
Apache::TAKE13
Apache::TAKE2
Apache::TAKE23
Apache::TAKE3
:commonuse Apache::Const -compile => qw(:common);
The :common group is for XXX constants.
Apache::AUTH_REQUIRED
Apache::DECLINED
Apache::DONE
Apache::FORBIDDEN
Apache::NOT_FOUND
Apache::OK
Apache::REDIRECT
Apache::SERVER_ERROR
:configuse Apache::Const -compile => qw(:config);
The :config group is for XXX constants.
Apache::DECLINE_CMD
:conn_keepaliveuse Apache::Const -compile => qw(:conn_keepalive);
The :conn_keepalive constants group is used by the
($c->keepalive|docs::2.0::api::Apache::Connection/C_keepalive_)
method.
Apache::CONN_CLOSEThe connection will be closed at the end of the current HTTP request.
Apache::CONN_KEEPALIVEThe connection will be kept alive at the end of the current HTTP request.
Apache::CONN_UNKNOWNThe connection is at an unknown state, e.g., initialized but not open yet.
:contextuse Apache::Const -compile => qw(:context);
The :context group is used by the
$parms->check_cmd_context|docs::2.0::api::Apache::CmdParms/C_check_cmd_context_
method.
Apache::NOT_IN_VIRTUALHOSTThe command is not in a <VirtualHost> block.
Apache::NOT_IN_LIMITThe command is not in a <Limit> block.
Apache::NOT_IN_DIRECTORYThe command is not in a <Directory> block.
Apache::NOT_IN_LOCATIONThe command is not in a <Location>/<LocationMatch> block.
Apache::NOT_IN_FILESThe command is not in a <Files>/<FilesMatch> block.
Apache::NOT_IN_DIR_LOC_FILEThe command is not in a <Files>/<FilesMatch>, <Location>/<LocationMatch> or <Directory> block.
Apache::GLOBAL_ONLYThe directive appears outside of any container directives.
:filter_typeuse Apache::Const -compile => qw(:filter_type);
The :filter_type group is for XXX constants.
Apache::FTYPE_CONNECTION
Apache::FTYPE_CONTENT_SET
Apache::FTYPE_NETWORK
Apache::FTYPE_PROTOCOL
Apache::FTYPE_RESOURCE
Apache::FTYPE_TRANSCODE
:httpuse Apache::Const -compile => qw(:http);
The :http group is for XXX constants.
Apache::HTTP_ACCEPTED
Apache::HTTP_BAD_GATEWAY
Apache::HTTP_BAD_REQUEST
Apache::HTTP_CONFLICT
Apache::HTTP_CONTINUE
Apache::HTTP_CREATED
Apache::HTTP_EXPECTATION_FAILED
Apache::HTTP_FAILED_DEPENDENCY
Apache::HTTP_FORBIDDEN
Apache::HTTP_GATEWAY_TIME_OUT
Apache::HTTP_GONE
Apache::HTTP_INSUFFICIENT_STORAGE
Apache::HTTP_INTERNAL_SERVER_ERROR
Apache::HTTP_LENGTH_REQUIRED
Apache::HTTP_LOCKED
Apache::HTTP_METHOD_NOT_ALLOWED
Apache::HTTP_MOVED_PERMANENTLY
Apache::HTTP_MOVED_TEMPORARILY
Apache::HTTP_MULTIPLE_CHOICES
Apache::HTTP_MULTI_STATUS
Apache::HTTP_NON_AUTHORITATIVE
Apache::HTTP_NOT_ACCEPTABLE
Apache::HTTP_NOT_EXTENDED
Apache::HTTP_NOT_FOUND
Apache::HTTP_NOT_IMPLEMENTED
Apache::HTTP_NOT_MODIFIED
Apache::HTTP_NO_CONTENT
Apache::HTTP_OK
Apache::HTTP_PARTIAL_CONTENT
Apache::HTTP_PAYMENT_REQUIRED
Apache::HTTP_PRECONDITION_FAILED
Apache::HTTP_PROCESSING
Apache::HTTP_PROXY_AUTHENTICATION_REQUIRED
Apache::HTTP_RANGE_NOT_SATISFIABLE
Apache::HTTP_REQUEST_ENTITY_TOO_LARGE
Apache::HTTP_REQUEST_TIME_OUT
Apache::HTTP_REQUEST_URI_TOO_LARGE
Apache::HTTP_RESET_CONTENT
Apache::HTTP_SEE_OTHER
Apache::HTTP_SERVICE_UNAVAILABLE
Apache::HTTP_SWITCHING_PROTOCOLS
Apache::HTTP_TEMPORARY_REDIRECT
Apache::HTTP_UNAUTHORIZED
Apache::HTTP_UNPROCESSABLE_ENTITY
Apache::HTTP_UNSUPPORTED_MEDIA_TYPE
Apache::HTTP_UPGRADE_REQUIRED
Apache::HTTP_USE_PROXY
Apache::HTTP_VARIANT_ALSO_VARIES
:input_modeuse Apache::Const -compile => qw(:input_mode);
The :input_mode group is for XXX constants.
Apache::MODE_EATCRLFSee
Apache::Filter::get_brigade()|docs::2.0::api::Apache::Filter/C_get_brigade_.
Apache::MODE_EXHAUSTIVESee
Apache::Filter::get_brigade()|docs::2.0::api::Apache::Filter/C_get_brigade_.
Apache::MODE_GETLINESee
Apache::Filter::get_brigade()|docs::2.0::api::Apache::Filter/C_get_brigade_.
Apache::MODE_INITSee
Apache::Filter::get_brigade()|docs::2.0::api::Apache::Filter/C_get_brigade_.
Apache::MODE_READBYTESSee
Apache::Filter::get_brigade()|docs::2.0::api::Apache::Filter/C_get_brigade_.
Apache::MODE_SPECULATIVESee
Apache::Filter::get_brigade()|docs::2.0::api::Apache::Filter/C_get_brigade_.
:loguse Apache::Const -compile => qw(:log);
The :log group is for constants used by
Apache::Log|docs::2.0::api::Apache::Log.
Apache::LOG_ALERTSee Apache::Log|docs::2.0::api::Apache::Log/C_Apache__LOG_ALERT_.
Apache::LOG_CRITSee Apache::Log|docs::2.0::api::Apache::Log/C_Apache__LOG_CRIT_.
Apache::LOG_DEBUGSee Apache::Log|docs::2.0::api::Apache::Log/C_Apache__LOG_DEBUG_.
Apache::LOG_EMERGSee Apache::Log|docs::2.0::api::Apache::Log/C_Apache__LOG_EMERG_.
Apache::LOG_ERRSee Apache::Log|docs::2.0::api::Apache::Log/C_Apache__LOG_ERR_.
Apache::LOG_INFOSee Apache::Log|docs::2.0::api::Apache::Log/C_Apache__LOG_INFO_.
Apache::LOG_LEVELMASKSee Apache::Log|docs::2.0::api::Apache::Log/C_Apache__LOG_LEVELMASK_.
Apache::LOG_NOTICESee Apache::Log|docs::2.0::api::Apache::Log/C_Apache__LOG_NOTICE_.
Apache::LOG_STARTUPSee Apache::Log|docs::2.0::api::Apache::Log/C_Apache__LOG_STARTUP_.
Apache::LOG_TOCLIENTSee Apache::Log|docs::2.0::api::Apache::Log/C_Apache__LOG_TOCLIENT_.
Apache::LOG_WARNINGSee Apache::Log|docs::2.0::api::Apache::Log/C_Apache__LOG_WARNING_.
:methodsuse Apache::Const -compile => qw(:methods);
The :methods constants group is used in conjunction with
$r->method_number|docs::2.0::api::Apache::RequestRec/C_method_number_.
Apache::METHODS
Apache::M_BASELINE_CONTROL
Apache::M_CHECKIN
Apache::M_CHECKOUT
Apache::M_CONNECT
Apache::M_COPY
Apache::M_DELETE
Apache::M_GETcorresponds to the HTTP GET method
Apache::M_INVALID
Apache::M_LABEL
Apache::M_LOCK
Apache::M_MERGE
Apache::M_MKACTIVITY
Apache::M_MKCOL
Apache::M_MKWORKSPACE
Apache::M_MOVE
Apache::M_OPTIONS
Apache::M_PATCH
Apache::M_POSTcorresponds to the HTTP POST method
Apache::M_PROPFIND
Apache::M_PROPPATCH
Apache::M_PUTcorresponds to the HTTP PUT method
Apache::M_REPORT
Apache::M_TRACE
Apache::M_UNCHECKOUT
Apache::M_UNLOCK
Apache::M_UPDATE
Apache::M_VERSION_CONTROL
:mpmquse Apache::Const -compile => qw(:mpmq);
The :mpmq group is for querying MPM properties.
Apache::MPMQ_NOT_SUPPORTED
Apache::MPMQ_STATIC
Apache::MPMQ_DYNAMIC
Apache::MPMQ_MAX_DAEMON_USED
Apache::MPMQ_IS_THREADED
Apache::MPMQ_IS_FORKED
Apache::MPMQ_HARD_LIMIT_DAEMONS
Apache::MPMQ_HARD_LIMIT_THREADS
Apache::MPMQ_MAX_THREADS
Apache::MPMQ_MIN_SPARE_DAEMONS
Apache::MPMQ_MIN_SPARE_THREADS
Apache::MPMQ_MAX_SPARE_DAEMONS
Apache::MPMQ_MAX_SPARE_THREADS
Apache::MPMQ_MAX_REQUESTS_DAEMON
Apache::MPMQ_MAX_DAEMONS
:optionsuse Apache::Const -compile => qw(:options);
The :options group contains constants corresponding to the
Options configuration directive. For examples see:
$r->allow_options|docs::2.0::api::Apache::Access/C_allow_options_.
Apache::OPT_ALL
Apache::OPT_EXECCGI
Apache::OPT_INCLUDES
Apache::OPT_INCNOEXEC
Apache::OPT_INDEXES
Apache::OPT_MULTI
Apache::OPT_NONE
Apache::OPT_SYM_LINKS
Apache::OPT_SYM_OWNER
Apache::OPT_UNSET
:overrideuse Apache::Const -compile => qw(:override);
The :override group contains constants corresponding to the
AllowOverride configuration directive. For examples see:
$r->allow_options|docs::2.0::api::Apache::Access/C_allow_overrides_.
Apache::ACCESS_CONF
Apache::OR_ALL
Apache::OR_AUTHCFG
Apache::OR_FILEINFO
Apache::OR_INDEXES
Apache::OR_LIMIT
Apache::OR_NONE
Apache::OR_OPTIONS
Apache::OR_UNSET
Apache::RSRC_CONF
:platformuse Apache::Const -compile => qw(:platform);
The :platform group is for constants that may
differ from OS to OS.
Apache::CRLF
Apache::CR
Apache::LF
:remotehostuse Apache::Const -compile => qw(:remotehost);
The :remotehost constants group is is used by the
$c->get_remote_host|docs::2.0::api::Apache::Connection/C_get_remote_host_
method.
Apache::REMOTE_DOUBLE_REV
Apache::REMOTE_HOST
Apache::REMOTE_NAME
Apache::REMOTE_NOLOOKUP
:satisfyuse Apache::Const -compile => qw(:satisfy);
The :satisfy constants group is used in conjunction with
$r->satisfies|docs::2.0::api::Apache::Access/C_satisfies_.
Apache::SATISFY_ALLAll of the requirements must be met.
Apache::SATISFY_ANYany of the requirements must be met.
Apache::SATISFY_NOSPECThere are no applicable satisfy lines
:typesuse Apache::Const -compile => qw(:types);
The :types group is for XXX constants.
Apache::DIR_MAGIC_TYPE
mod_perl 2.0 and its core modules are copyrighted under The Apache Software License, Version 2.0.
The mod_perl development team and numerous contributors.
|
Apache::Const - Perl Interface for Apache Constants |