Apache2::Const - Perl Interface for Apache Constants


NAME

Apache2::Const - Perl Interface for Apache Constants


Synopsis

  # make the constants available but don't import them
  use Apache2::Const -compile => qw(constant names ...);
  
  # w/o the => syntax sugar
  use Apache2::Const ("-compile", qw(constant names ...));
  
  # compile and import the constants
  use Apache2::Const qw(constant names ...);


Description

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 Apache2::Const -compile => qw(FORBIDDEN OK);

makes the constants Apache2::Const::FORBIDDEN and Apache2::Const::OK available to your code, but they aren't imported. In which case you need to use a fully qualified constants, as in:

  return Apache2::Const::OK;

If you drop the argument -compile and write:

  use Apache2::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 Apache2::Const -compile => qw(FORBIDDEN OK);

you could write:

 use Apache2::Const "-compile", qw(FORBIDDEN OK);

and for parentheses-lovers:

 use Apache2::Const ("-compile", qw(FORBIDDEN OK));


Constants

:cmd_how

  use Apache2::Const -compile => qw(:cmd_how);

The :cmd_how constants group is used in Apache2::Module::add()|docs::2.0::api::Apache2::Module/C_add_ and $cmds->args_how|docs::2.0::api::Apache2::Command/C_args_how_.

Apache2::Const::FLAG

One of On or Off (full description).

since: 1.99_12

Apache2::Const::ITERATE

One argument, occuring multiple times (full description).

since: 1.99_12

Apache2::Const::ITERATE2

Two arguments, the second occurs multiple times (full description).

since: 1.99_12

Apache2::Const::NO_ARGS

No arguments at all (full description).

since: 1.99_12

Apache2::Const::RAW_ARGS

The command will parse the command line itself (full description).

since: 1.99_12

Apache2::Const::TAKE1

One argument only (full description).

since: 1.99_12

Apache2::Const::TAKE12

One or two arguments (full description).

since: 1.99_12

Apache2::Const::TAKE123

One, two or three arguments (full description).

since: 1.99_12

Apache2::Const::TAKE13

One or three arguments (full description).

since: 1.99_12

Apache2::Const::TAKE2

Two arguments (full description).

since: 1.99_12

Apache2::Const::TAKE23

Two or three arguments (full description).

since: 1.99_12

Apache2::Const::TAKE3

Three arguments (full description).

since: 1.99_12

:common

  use Apache2::Const -compile => qw(:common);

The :common group is for XXX constants.

Apache2::Const::AUTH_REQUIRED

since: 1.99_12

Apache2::Const::DECLINED

since: 1.99_12

Apache2::Const::DONE

since: 1.99_12

Apache2::Const::FORBIDDEN

since: 1.99_12

Apache2::Const::NOT_FOUND

since: 1.99_12

Apache2::Const::OK

since: 1.99_12

Apache2::Const::REDIRECT

since: 1.99_12

Apache2::Const::SERVER_ERROR

since: 1.99_12

:config

  use Apache2::Const -compile => qw(:config);

The :config group is for XXX constants.

Apache2::Const::DECLINE_CMD

since: 1.99_12

:conn_keepalive

  use Apache2::Const -compile => qw(:conn_keepalive);

The :conn_keepalive constants group is used by the ($c->keepalive|docs::2.0::api::Apache2::Connection/C_keepalive_) method.

Apache2::Const::CONN_CLOSE

The connection will be closed at the end of the current HTTP request.

since: 1.99_13

Apache2::Const::CONN_KEEPALIVE

The connection will be kept alive at the end of the current HTTP request.

since: 1.99_13

Apache2::Const::CONN_UNKNOWN

The connection is at an unknown state, e.g., initialized but not open yet.

since: 1.99_13

:context

  use Apache2::Const -compile => qw(:context);

The :context group is used by the $parms->check_cmd_context|docs::2.0::api::Apache2::CmdParms/C_check_cmd_context_ method.

Apache2::Const::NOT_IN_VIRTUALHOST

The command is not in a <VirtualHost> block.

since: 1.99_15

Apache2::Const::NOT_IN_LIMIT

The command is not in a <Limit> block.

since: 1.99_15

Apache2::Const::NOT_IN_DIRECTORY

The command is not in a <Directory> block.

since: 1.99_15

Apache2::Const::NOT_IN_LOCATION

The command is not in a <Location>/<LocationMatch> block.

since: 1.99_15

Apache2::Const::NOT_IN_FILES

The command is not in a <Files>/<FilesMatch> block.

since: 1.99_15

Apache2::Const::NOT_IN_DIR_LOC_FILE

The command is not in a <Files>/<FilesMatch>, <Location>/<LocationMatch> or <Directory> block.

since: 1.99_15

Apache2::Const::GLOBAL_ONLY

The directive appears outside of any container directives.

since: 1.99_15

:filter_type

  use Apache2::Const -compile => qw(:filter_type);

The :filter_type group is for XXX constants.

Apache2::Const::FTYPE_CONNECTION

since: 1.99_12

Apache2::Const::FTYPE_CONTENT_SET

since: 1.99_12

Apache2::Const::FTYPE_NETWORK

since: 1.99_12

Apache2::Const::FTYPE_PROTOCOL

since: 1.99_12

Apache2::Const::FTYPE_RESOURCE

since: 1.99_12

Apache2::Const::FTYPE_TRANSCODE

since: 1.99_12

:http

  use Apache2::Const -compile => qw(:http);

The :http group is for XXX constants.

Apache2::Const::HTTP_ACCEPTED

since: 1.99_12

Apache2::Const::HTTP_BAD_GATEWAY

since: 1.99_12

Apache2::Const::HTTP_BAD_REQUEST

since: 1.99_12

Apache2::Const::HTTP_CONFLICT

since: 1.99_12

Apache2::Const::HTTP_CONTINUE

since: 1.99_12

Apache2::Const::HTTP_CREATED

since: 1.99_12

Apache2::Const::HTTP_EXPECTATION_FAILED

since: 1.99_12

Apache2::Const::HTTP_FAILED_DEPENDENCY

since: 1.99_12

Apache2::Const::HTTP_FORBIDDEN

since: 1.99_12

Apache2::Const::HTTP_GATEWAY_TIME_OUT

since: 1.99_12

Apache2::Const::HTTP_GONE

since: 1.99_12

Apache2::Const::HTTP_INSUFFICIENT_STORAGE

since: 1.99_12

Apache2::Const::HTTP_INTERNAL_SERVER_ERROR

since: 1.99_12

Apache2::Const::HTTP_LENGTH_REQUIRED

since: 1.99_12

Apache2::Const::HTTP_LOCKED

since: 1.99_12

Apache2::Const::HTTP_METHOD_NOT_ALLOWED

since: 1.99_12

Apache2::Const::HTTP_MOVED_PERMANENTLY

since: 1.99_12

Apache2::Const::HTTP_MOVED_TEMPORARILY

since: 1.99_12

Apache2::Const::HTTP_MULTIPLE_CHOICES

since: 1.99_12

Apache2::Const::HTTP_MULTI_STATUS

since: 1.99_12

Apache2::Const::HTTP_NON_AUTHORITATIVE

since: 1.99_12

Apache2::Const::HTTP_NOT_ACCEPTABLE

since: 1.99_12

Apache2::Const::HTTP_NOT_EXTENDED

since: 1.99_12

Apache2::Const::HTTP_NOT_FOUND

since: 1.99_12

Apache2::Const::HTTP_NOT_IMPLEMENTED

since: 1.99_12

Apache2::Const::HTTP_NOT_MODIFIED

since: 1.99_12

Apache2::Const::HTTP_NO_CONTENT

since: 1.99_12

Apache2::Const::HTTP_OK

since: 1.99_12

Apache2::Const::HTTP_PARTIAL_CONTENT

since: 1.99_12

Apache2::Const::HTTP_PAYMENT_REQUIRED

since: 1.99_12

Apache2::Const::HTTP_PRECONDITION_FAILED

since: 1.99_12

Apache2::Const::HTTP_PROCESSING

since: 1.99_12

Apache2::Const::HTTP_PROXY_AUTHENTICATION_REQUIRED

since: 1.99_12

Apache2::Const::HTTP_RANGE_NOT_SATISFIABLE

since: 1.99_12

Apache2::Const::HTTP_REQUEST_ENTITY_TOO_LARGE

since: 1.99_12

Apache2::Const::HTTP_REQUEST_TIME_OUT

since: 1.99_12

Apache2::Const::HTTP_REQUEST_URI_TOO_LARGE

since: 1.99_12

Apache2::Const::HTTP_RESET_CONTENT

since: 1.99_12

Apache2::Const::HTTP_SEE_OTHER

since: 1.99_12

Apache2::Const::HTTP_SERVICE_UNAVAILABLE

since: 1.99_12

Apache2::Const::HTTP_SWITCHING_PROTOCOLS

since: 1.99_12

Apache2::Const::HTTP_TEMPORARY_REDIRECT

since: 1.99_12

Apache2::Const::HTTP_UNAUTHORIZED

since: 1.99_12

Apache2::Const::HTTP_UNPROCESSABLE_ENTITY

since: 1.99_12

Apache2::Const::HTTP_UNSUPPORTED_MEDIA_TYPE

since: 1.99_12

Apache2::Const::HTTP_UPGRADE_REQUIRED

since: 1.99_12

Apache2::Const::HTTP_USE_PROXY

since: 1.99_12

Apache2::Const::HTTP_VARIANT_ALSO_VARIES

since: 1.99_12

:input_mode

  use Apache2::Const -compile => qw(:input_mode);

The :input_mode group is used by get_brigade|docs::2.0::api::Apache2::Filter/C_get_brigade_.

Apache2::Const::MODE_EATCRLF

since: 1.99_12

See Apache2::Filter::get_brigade()|docs::2.0::api::Apache2::Filter/C_get_brigade_.

Apache2::Const::MODE_EXHAUSTIVE

since: 1.99_12

See Apache2::Filter::get_brigade()|docs::2.0::api::Apache2::Filter/C_get_brigade_.

Apache2::Const::MODE_GETLINE

since: 1.99_12

See Apache2::Filter::get_brigade()|docs::2.0::api::Apache2::Filter/C_get_brigade_.

Apache2::Const::MODE_INIT

since: 1.99_12

See Apache2::Filter::get_brigade()|docs::2.0::api::Apache2::Filter/C_get_brigade_.

Apache2::Const::MODE_READBYTES

since: 1.99_12

See Apache2::Filter::get_brigade()|docs::2.0::api::Apache2::Filter/C_get_brigade_.

Apache2::Const::MODE_SPECULATIVE

since: 1.99_12

See Apache2::Filter::get_brigade()|docs::2.0::api::Apache2::Filter/C_get_brigade_.

:log

  use Apache2::Const -compile => qw(:log);

The :log group is for constants used by Apache2::Log|docs::2.0::api::Apache2::Log.

Apache2::Const::LOG_ALERT

since: 1.99_12

See Apache2::Log|docs::2.0::api::Apache2::Log/C_Apache2__LOG_ALERT_.

Apache2::Const::LOG_CRIT

since: 1.99_12

See Apache2::Log|docs::2.0::api::Apache2::Log/C_Apache2__LOG_CRIT_.

Apache2::Const::LOG_DEBUG

since: 1.99_12

See Apache2::Log|docs::2.0::api::Apache2::Log/C_Apache2__LOG_DEBUG_.

Apache2::Const::LOG_EMERG

since: 1.99_12

See Apache2::Log|docs::2.0::api::Apache2::Log/C_Apache2__LOG_EMERG_.

Apache2::Const::LOG_ERR

since: 1.99_12

See Apache2::Log|docs::2.0::api::Apache2::Log/C_Apache2__LOG_ERR_.

Apache2::Const::LOG_INFO

since: 1.99_12

See Apache2::Log|docs::2.0::api::Apache2::Log/C_Apache2__LOG_INFO_.

Apache2::Const::LOG_LEVELMASK

since: 1.99_12

See Apache2::Log|docs::2.0::api::Apache2::Log/C_Apache2__LOG_LEVELMASK_.

Apache2::Const::LOG_NOTICE

since: 1.99_12

See Apache2::Log|docs::2.0::api::Apache2::Log/C_Apache2__LOG_NOTICE_.

Apache2::Const::LOG_STARTUP

since: 1.99_12

See Apache2::Log|docs::2.0::api::Apache2::Log/C_Apache2__LOG_STARTUP_.

Apache2::Const::LOG_TOCLIENT

since: 1.99_12

See Apache2::Log|docs::2.0::api::Apache2::Log/C_Apache2__LOG_TOCLIENT_.

Apache2::Const::LOG_WARNING

since: 1.99_12

See Apache2::Log|docs::2.0::api::Apache2::Log/C_Apache2__LOG_WARNING_.

:methods

  use Apache2::Const -compile => qw(:methods);

The :methods constants group is used in conjunction with $r->method_number|docs::2.0::api::Apache2::RequestRec/C_method_number_.

Apache2::Const::METHODS

since: 1.99_12

Apache2::Const::M_BASELINE_CONTROL

since: 1.99_12

Apache2::Const::M_CHECKIN

since: 1.99_12

Apache2::Const::M_CHECKOUT

since: 1.99_12

Apache2::Const::M_CONNECT

since: 1.99_12

Apache2::Const::M_COPY

since: 1.99_12

Apache2::Const::M_DELETE

since: 1.99_12

Apache2::Const::M_GET

since: 1.99_12

corresponds to the HTTP GET method

Apache2::Const::M_INVALID

since: 1.99_12

Apache2::Const::M_LABEL

since: 1.99_12

Apache2::Const::M_LOCK

since: 1.99_12

Apache2::Const::M_MERGE

since: 1.99_12

Apache2::Const::M_MKACTIVITY

since: 1.99_12

Apache2::Const::M_MKCOL

since: 1.99_12

Apache2::Const::M_MKWORKSPACE

since: 1.99_12

Apache2::Const::M_MOVE

since: 1.99_12

Apache2::Const::M_OPTIONS

since: 1.99_12

Apache2::Const::M_PATCH

since: 1.99_12

Apache2::Const::M_POST

since: 1.99_12

corresponds to the HTTP POST method

Apache2::Const::M_PROPFIND

since: 1.99_12

Apache2::Const::M_PROPPATCH

since: 1.99_12

Apache2::Const::M_PUT

since: 1.99_12

corresponds to the HTTP PUT method

Apache2::Const::M_REPORT

since: 1.99_12

Apache2::Const::M_TRACE

since: 1.99_12

Apache2::Const::M_UNCHECKOUT

since: 1.99_12

Apache2::Const::M_UNLOCK

since: 1.99_12

Apache2::Const::M_UPDATE

since: 1.99_12

Apache2::Const::M_VERSION_CONTROL

since: 1.99_12

:mpmq

  use Apache2::Const -compile => qw(:mpmq);

The :mpmq group is for querying MPM properties.

Apache2::Const::MPMQ_NOT_SUPPORTED

since: 1.99_12

Apache2::Const::MPMQ_STATIC

since: 1.99_12

Apache2::Const::MPMQ_DYNAMIC

since: 1.99_12

Apache2::Const::MPMQ_MAX_DAEMON_USED

since: 1.99_12

Apache2::Const::MPMQ_IS_THREADED

since: 1.99_12

Apache2::Const::MPMQ_IS_FORKED

since: 1.99_12

Apache2::Const::MPMQ_HARD_LIMIT_DAEMONS

since: 1.99_12

Apache2::Const::MPMQ_HARD_LIMIT_THREADS

since: 1.99_12

Apache2::Const::MPMQ_MAX_THREADS

since: 1.99_12

Apache2::Const::MPMQ_MIN_SPARE_DAEMONS

since: 1.99_12

Apache2::Const::MPMQ_MIN_SPARE_THREADS

since: 1.99_12

Apache2::Const::MPMQ_MAX_SPARE_DAEMONS

since: 1.99_12

Apache2::Const::MPMQ_MAX_SPARE_THREADS

since: 1.99_12

Apache2::Const::MPMQ_MAX_REQUESTS_DAEMON

since: 1.99_12

Apache2::Const::MPMQ_MAX_DAEMONS

since: 1.99_12

:options

  use Apache2::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::Apache2::Access/C_allow_options_.

Apache2::Const::OPT_ALL

since: 1.99_12

Apache2::Const::OPT_EXECCGI

since: 1.99_12

Apache2::Const::OPT_INCLUDES

since: 1.99_12

Apache2::Const::OPT_INCNOEXEC

since: 1.99_12

Apache2::Const::OPT_INDEXES

since: 1.99_12

Apache2::Const::OPT_MULTI

since: 1.99_12

Apache2::Const::OPT_NONE

since: 1.99_12

Apache2::Const::OPT_SYM_LINKS

since: 1.99_12

Apache2::Const::OPT_SYM_OWNER

since: 1.99_12

Apache2::Const::OPT_UNSET

since: 1.99_12

:override

  use Apache2::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::Apache2::Access/C_allow_overrides_.

Apache2::Const::ACCESS_CONF

*.conf inside <Directory> or <Location>

since: 1.99_12

Apache2::Const::OR_ALL

Apache2::Const::OR_LIMIT|/C_Apache2__OR_LIMIT_ | Apache2::Const::OR_OPTIONS|/C_Apache2__OR_OPTIONS_ | Apache2::Const::OR_FILEINFO|/C_Apache2__OR_FILEINFO_ | Apache2::Const::OR_AUTHCFG|/C_Apache2__OR_AUTHCFG_ | Apache2::Const::OR_INDEXES|/C_Apache2__OR_INDEXES_

since: 1.99_12

Apache2::Const::OR_AUTHCFG

*.conf inside <Directory> or <Location> and .htaccess when AllowOverride AuthConfig

since: 1.99_12

Apache2::Const::OR_FILEINFO

*.conf anywhere and .htaccess when AllowOverride FileInfo

since: 1.99_12

Apache2::Const::OR_INDEXES

*.conf anywhere and .htaccess when AllowOverride Indexes

since: 1.99_12

Apache2::Const::OR_LIMIT

*.conf inside <Directory> or <Location> and .htaccess when AllowOverride Limit

since: 1.99_12

Apache2::Const::OR_NONE

*.conf is not available anywhere in this override

since: 1.99_12

Apache2::Const::OR_OPTIONS

*.conf anywhere and .htaccess when AllowOverride Options

since: 1.99_12

Apache2::Const::OR_UNSET

Unset a directive (in Allow)

since: 1.99_12

Apache2::Const::RSRC_CONF

*.conf outside <Directory> or <Location>

since: 1.99_12

:platform

  use Apache2::Const -compile => qw(:platform);

The :platform group is for constants that may differ from OS to OS.

Apache2::Const::CRLF

since: 1.99_12

Apache2::Const::CR

since: 1.99_12

Apache2::Const::LF

since: 1.99_12

:remotehost

  use Apache2::Const -compile => qw(:remotehost);

The :remotehost constants group is is used by the $c->get_remote_host|docs::2.0::api::Apache2::Connection/C_get_remote_host_ method.

Apache2::Const::REMOTE_DOUBLE_REV

since: 1.99_12

Apache2::Const::REMOTE_HOST

since: 1.99_12

Apache2::Const::REMOTE_NAME

since: 1.99_12

Apache2::Const::REMOTE_NOLOOKUP

since: 1.99_12

:satisfy

  use Apache2::Const -compile => qw(:satisfy);

The :satisfy constants group is used in conjunction with $r->satisfies|docs::2.0::api::Apache2::Access/C_satisfies_.

Apache2::Const::SATISFY_ALL

since: 1.99_12

All of the requirements must be met.

Apache2::Const::SATISFY_ANY

since: 1.99_12

any of the requirements must be met.

Apache2::Const::SATISFY_NOSPEC

since: 1.99_12

There are no applicable satisfy lines

:types

  use Apache2::Const -compile => qw(:types);

The :types group is for XXX constants.

Apache2::Const::DIR_MAGIC_TYPE

since: 1.99_12


See Also

mod_perl 2.0 documentation.


Copyright

mod_perl 2.0 and its core modules are copyrighted under The Apache Software License, Version 2.0.


Authors

The mod_perl development team and numerous contributors.

 Apache2::Const - Perl Interface for Apache Constants