The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.

NAME

APR::Const - Perl Interface for APR Constants

Synopsis

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

Description

This package contains constants specific to APR features.

Refer to the Apache::Const description section for more information.

Constants

:common

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

The :common group is for XXX constants.

APR::SUCCESS

since: 1.99_12

:error

  use APR::Const -compile => qw(:error);

The :error group is for XXX constants.

APR::EABOVEROOT

since: 1.99_12

APR::EABSOLUTE

since: 1.99_12

APR::EACCES

since: 1.99_12

APR::EAGAIN

since: 1.99_12

The error Resource temporarily unavailable, may be returned by many different system calls, especially IO calls.

APR::EBADDATE

since: 1.99_12

APR::EBADF

since: 1.99_12

APR::EBADIP

since: 1.99_12

APR::EBADMASK

since: 1.99_12

APR::EBADPATH

since: 1.99_12

APR::EBUSY

since: 1.99_12

APR::ECONNABORTED

since: 1.99_12

APR::ECONNREFUSED

since: 1.99_12

APR::ECONNRESET

since: 1.99_12

APR::EDSOOPEN

since: 1.99_12

APR::EEXIST

since: 1.99_12

APR::EFTYPE

since: 1.99_12

APR::EGENERAL

since: 1.99_12

APR::EHOSTUNREACH

since: 1.99_12

APR::EINCOMPLETE

since: 1.99_12

APR::EINIT

since: 1.99_12

APR::EINPROGRESS

since: 1.99_12

APR::EINTR

since: 1.99_12

APR::EINVAL

since: 1.99_12

APR::EINVALSOCK

since: 1.99_12

APR::EMFILE

since: 1.99_12

APR::EMISMATCH

since: 1.99_12

APR::ENAMETOOLONG

since: 1.99_12

APR::END

since: 1.99_12

APR::ENETUNREACH

since: 1.99_12

APR::ENFILE

since: 1.99_12

APR::ENODIR

since: 1.99_12

APR::ENOENT

since: 1.99_12

APR::ENOLOCK

since: 1.99_12

APR::ENOMEM

since: 1.99_12

APR::ENOPOLL

since: 1.99_12

APR::ENOPOOL

since: 1.99_12

APR::ENOPROC

since: 1.99_12

APR::ENOSHMAVAIL

since: 1.99_12

APR::ENOSOCKET

since: 1.99_12

APR::ENOSPC

since: 1.99_12

APR::ENOSTAT

since: 1.99_12

APR::ENOTDIR

since: 1.99_12

APR::ENOTEMPTY

since: 1.99_12

APR::ENOTHDKEY

since: 1.99_12

APR::ENOTHREAD

since: 1.99_12

APR::ENOTIME

since: 1.99_12

APR::ENOTIMPL

Something is not implemented

since: 1.99_12

APR::ENOTSOCK

since: 1.99_12

APR::EOF

since: 1.99_12

APR::EPATHWILD

since: 1.99_12

APR::EPIPE

since: 1.99_12

APR::EPROC_UNKNOWN

since: 1.99_12

APR::ERELATIVE

since: 1.99_12

APR::ESPIPE

since: 1.99_12

APR::ESYMNOTFOUND

since: 1.99_12

APR::ETIMEDOUT

since: 1.99_12

APR::EXDEV

since: 1.99_12

:filemode

  use APR::Const -compile => qw(:filemode);

The :filemode group is for XXX constants.

APR::BINARY

since: 1.99_12

APR::BUFFERED

since: 1.99_12

APR::CREATE

since: 1.99_12

APR::DELONCLOSE

since: 1.99_12

APR::EXCL

since: 1.99_12

APR::PEND

since: 1.99_12

APR::READ

since: 1.99_12

APR::TRUNCATE

since: 1.99_12

APR::WRITE

since: 1.99_12

:filepath

  use APR::Const -compile => qw(:filepath);

The :filepath group is for XXX constants.

APR::FILEPATH_ENCODING_LOCALE

since: 1.99_12

APR::FILEPATH_ENCODING_UNKNOWN

since: 1.99_12

APR::FILEPATH_ENCODING_UTF8

since: 1.99_12

APR::FILEPATH_NATIVE

since: 1.99_12

APR::FILEPATH_NOTABOVEROOT

since: 1.99_12

APR::FILEPATH_NOTABSOLUTE

since: 1.99_12

APR::FILEPATH_NOTRELATIVE

since: 1.99_12

APR::FILEPATH_SECUREROOT

since: 1.99_12

APR::FILEPATH_SECUREROOTTEST

since: 1.99_12

APR::FILEPATH_TRUENAME

since: 1.99_12

:fileprot

  use APR::Const -compile => qw(:fileprot);

The :fileprot group is used by $finfo->protection.

APR_FILEPROT_GEXECUTE

Execute by group

since: 1.99_17

APR_FILEPROT_GREAD

Read by group

since: 1.99_17

APR_FILEPROT_GSETID

Set group id

since: 1.99_17

APR_FILEPROT_GWRITE

Write by group

since: 1.99_17

APR_FILEPROT_OS_DEFAULT

use OS's default permissions

since: 1.99_17

APR_FILEPROT_UEXECUTE

Execute by user

since: 1.99_17

APR_FILEPROT_UREAD

Read by user

since: 1.99_17

APR_FILEPROT_USETID

Set user id

since: 1.99_17

APR_FILEPROT_UWRITE

Write by user

since: 1.99_17

APR_FILEPROT_WEXECUTE

Execute by others

since: 1.99_17

APR_FILEPROT_WREAD

Read by others

since: 1.99_17

APR_FILEPROT_WSTICKY

Sticky bit

since: 1.99_17

APR_FILEPROT_WWRITE

Write by others

since: 1.99_17

:filetype

  use APR::Const -compile => qw(:filetype);

The :filetype group is used by $finfo->filetype.

APR::FILETYPE_BLK

a file is a block device

since: 1.99_17

APR::FILETYPE_CHR

a file is a character device

since: 1.99_17

APR::FILETYPE_DIR

a file is a directory

since: 1.99_17

APR::FILETYPE_LNK

a file is a symbolic link

since: 1.99_17

APR::FILETYPE_NOFILE

the file type is undedetermined.

since: 1.99_17

APR::FILETYPE_PIPE

a file is a FIFO or a pipe.

since: 1.99_17

APR::FILETYPE_REG

a file is a regular file.

since: 1.99_17

APR::FILETYPE_SOCK

a file is a [unix domain] socket.

since: 1.99_17

APR::FILETYPE_UNKFILE

a file is of some other unknown type or the type cannot be determined.

since: 1.99_17

:finfo

  use APR::Const -compile => qw(:finfo);

The :finfo group is used by stat() and $finfo->valid.

APR::FINFO_ATIME

Access Time

since: 1.99_12

APR::FINFO_CSIZE

Storage size consumed by the file

since: 1.99_12

APR::FINFO_CTIME

Creation Time

since: 1.99_12

APR::FINFO_DEV

Device

since: 1.99_12

APR::FINFO_DIRENT

an atomic unix apr_dir_read()

since: 1.99_12

APR::FINFO_GPROT

Group protection bits

since: 1.99_12

APR::FINFO_GROUP

Group id

since: 1.99_12

APR::FINFO_ICASE

whether device is case insensitive

since: 1.99_12

APR::FINFO_IDENT

device and inode

since: 1.99_12

APR::FINFO_INODE

Inode

since: 1.99_12

Stat the link not the file itself if it is a link

since: 1.99_12

APR::FINFO_MIN

type, mtime, ctime, atime, size

since: 1.99_12

APR::FINFO_MTIME

Modification Time

since: 1.99_12

APR::FINFO_NAME

name in proper case

since: 1.99_12

Number of links

since: 1.99_12

APR::FINFO_NORM

All fields provided by an atomic unix apr_stat()

since: 1.99_12

APR::FINFO_OWNER

user and group

since: 1.99_12

APR::FINFO_PROT

all protections

since: 1.99_12

APR::FINFO_SIZE

Size of the file

since: 1.99_12

APR::FINFO_TYPE

Type

since: 1.99_12

APR::FINFO_UPROT

User protection bits

since: 1.99_12

APR::FINFO_USER

User id

since: 1.99_12

APR::FINFO_WPROT

World protection bits

since: 1.99_12

:flock

  use APR::Const -compile => qw(:flock);

The :flock group is for XXX constants.

APR::FLOCK_EXCLUSIVE

since: 1.99_12

APR::FLOCK_NONBLOCK

since: 1.99_12

APR::FLOCK_SHARED

since: 1.99_12

APR::FLOCK_TYPEMASK

since: 1.99_12

:hook

  use APR::Const -compile => qw(:hook);

The :hook group is for XXX constants.

APR::HOOK_FIRST

since: 1.99_12

APR::HOOK_LAST

since: 1.99_12

APR::HOOK_MIDDLE

since: 1.99_12

APR::HOOK_REALLY_FIRST

since: 1.99_12

APR::HOOK_REALLY_LAST

since: 1.99_12

:limit

  use APR::Const -compile => qw(:limit);

The :limit group is for XXX constants.

APR::LIMIT_CPU

since: 1.99_12

APR::LIMIT_MEM

since: 1.99_12

APR::LIMIT_NOFILE

since: 1.99_12

APR::LIMIT_NPROC

since: 1.99_12

:lockmech

  use APR::Const -compile => qw(:lockmech);

The :lockmech group is for XXX constants.

APR::LOCK_DEFAULT

since: 1.99_12

APR::LOCK_FCNTL

since: 1.99_12

APR::LOCK_FLOCK

since: 1.99_12

APR::LOCK_POSIXSEM

since: 1.99_12

APR::LOCK_PROC_PTHREAD

since: 1.99_12

APR::LOCK_SYSVSEM

since: 1.99_12

:poll

  use APR::Const -compile => qw(:poll);

The :poll group is used by poll.

APR::POLLERR

since: 1.99_12

Pending error

APR::POLLHUP

since: 1.99_12

Hangup occurred

APR::POLLIN

since: 1.99_12

Can read without blocking

APR::POLLNVAL

since: 1.99_12

Descriptior invalid

APR::POLLOUT

since: 1.99_12

Can write without blocking

APR::POLLPRI

since: 1.99_12

Priority data available

:read_type

  use APR::Const -compile => qw(:read_type);

The :read_type group is for IO constants.

APR::BLOCK_READ

since: 1.99_12

the read function blocks

APR::NONBLOCK_READ

since: 1.99_12

the read function does not block

:shutdown_how

  use APR::Const -compile => qw(:shutdown_how);

The :shutdown_how group is for XXX constants.

APR::SHUTDOWN_READ

since: 1.99_12

APR::SHUTDOWN_READWRITE

since: 1.99_12

APR::SHUTDOWN_WRITE

since: 1.99_12

:socket

  use APR::Const -compile => qw(:socket);

The :socket group is for the APR::Socket object constants, in methods opt_get and opt_set.

The following section discusses in detail each of the :socket constants.

APR::SO_DEBUG

Possible values:

XXX

since: 1.99_12

Turns on debugging information

APR::SO_DISCONNECTED

Queries the disconnected state of the socket. (Currently only used on Windows)

Possible values:

XXX

since: 1.99_12

APR::SO_KEEPALIVE

Keeps connections active

Possible values:

XXX

since: 1.99_12

APR::SO_LINGER

Lingers on close if data is present

since: 1.99_12

APR::SO_NONBLOCK

Turns blocking IO mode on/off for socket.

Possible values:

  1 nonblocking
  0 blocking

For example, to set a socket to a blocking IO mode:

  use APR::Socket ();
  use APR::Const    -compile => qw(SO_NONBLOCK);
  ...
  if ($socket->opt_get(APR::SO_NONBLOCK)) {
      $socket->opt_set(APR::SO_NONBLOCK => 0);
  }

You don't have to query for this option, before setting it. It was done for the demonstration purpose.

since: 1.99_12

APR::SO_RCVBUF

Controls the ReceiveBufferSize setting

Possible values:

XXX

since: 1.99_12

APR::SO_REUSEADDR

The rules used in validating addresses supplied to bind should allow reuse of local addresses.

Possible values:

XXX

since: 1.99_12

APR::SO_SNDBUF

Controls the SendBufferSize setting

Possible values:

XXX

since: 1.99_12

:status

  use APR::Const -compile => qw(:status);

The :status group is for the API that return status code, or set the error variable XXXXXX.

The following section discusses in detail each of the available :status constants.

APR::TIMEUP

The operation did not finish before the timeout.

since: 1.99_14

:table

  use APR::Const -compile => qw(:table);

The :table group is for overlap() and compress() constants. See APR::Table for details.

APR::OVERLAP_TABLES_MERGE

since: 1.99_12

See APR::Table::compress and APR::Table::overlap.

APR::OVERLAP_TABLES_SET

since: 1.99_12

See APR::Table::compress and APR::Table::overlap.

:uri

  use APR::Const -compile => qw(:uri);

The :uri group of constants is for manipulating URIs.

APR::URI_ACAP_DEFAULT_PORT

since: 1.99_12

APR::URI_FTP_DEFAULT_PORT

since: 1.99_12

APR::URI_GOPHER_DEFAULT_PORT

since: 1.99_12

APR::URI_HTTPS_DEFAULT_PORT

since: 1.99_12

APR::URI_HTTP_DEFAULT_PORT

since: 1.99_12

APR::URI_IMAP_DEFAULT_PORT

since: 1.99_12

APR::URI_LDAP_DEFAULT_PORT

since: 1.99_12

APR::URI_NFS_DEFAULT_PORT

since: 1.99_12

APR::URI_NNTP_DEFAULT_PORT

since: 1.99_12

APR::URI_POP_DEFAULT_PORT

since: 1.99_12

APR::URI_PROSPERO_DEFAULT_PORT

since: 1.99_12

APR::URI_RTSP_DEFAULT_PORT

since: 1.99_12

APR::URI_SIP_DEFAULT_PORT

since: 1.99_12

APR::URI_SNEWS_DEFAULT_PORT

since: 1.99_12

APR::URI_SSH_DEFAULT_PORT

since: 1.99_12

APR::URI_TELNET_DEFAULT_PORT

since: 1.99_12

APR::URI_TIP_DEFAULT_PORT

since: 1.99_12

APR::URI_UNP_OMITPASSWORD

since: 1.99_12

See APR::URI::unparse.

APR::URI_UNP_OMITPATHINFO

since: 1.99_12

See APR::URI::unparse.

APR::URI_UNP_OMITQUERY

since: 1.99_12

See APR::URI::unparse.

APR::URI_UNP_OMITSITEPART

since: 1.99_12

See APR::URI::unparse.

APR::URI_UNP_OMITUSER

since: 1.99_12

See APR::URI::unparse.

APR::URI_UNP_OMITUSERINFO

since: 1.99_12

APR::URI_UNP_REVEALPASSWORD

since: 1.99_12

See APR::URI::unparse.

APR::URI_WAIS_DEFAULT_PORT

since: 1.99_12

Other Constants

APR::PerlIO::PERLIO_LAYERS_ARE_ENABLED

since: 1.99_10

See APR::PerlIO::Constants)

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.