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
:error
use APR::Const -compile => qw(:error);
The :error
group is for XXX constants.
APR::EABOVEROOT
APR::EABSOLUTE
APR::EACCES
APR::EAGAIN
The error Resource temporarily unavailable, may be returned by many different system calls, especially IO calls.
APR::EBADDATE
APR::EBADF
APR::EBADIP
APR::EBADMASK
APR::EBADPATH
APR::EBUSY
APR::ECONNABORTED
APR::ECONNREFUSED
APR::ECONNRESET
APR::EDSOOPEN
APR::EEXIST
APR::EFTYPE
APR::EGENERAL
APR::EHOSTUNREACH
APR::EINCOMPLETE
APR::EINIT
APR::EINPROGRESS
APR::EINTR
APR::EINVAL
APR::EINVALSOCK
APR::EMFILE
APR::EMISMATCH
APR::ENAMETOOLONG
APR::END
APR::ENETUNREACH
APR::ENFILE
APR::ENODIR
APR::ENOENT
APR::ENOLOCK
APR::ENOMEM
APR::ENOPOLL
APR::ENOPOOL
APR::ENOPROC
APR::ENOSHMAVAIL
APR::ENOSOCKET
APR::ENOSPC
APR::ENOSTAT
APR::ENOTDIR
APR::ENOTEMPTY
APR::ENOTHDKEY
APR::ENOTHREAD
APR::ENOTIME
APR::ENOTIMPL
Something is not implemented
APR::ENOTSOCK
APR::EOF
APR::EPATHWILD
APR::EPIPE
APR::EPROC_UNKNOWN
APR::ERELATIVE
APR::ESPIPE
APR::ESYMNOTFOUND
APR::ETIMEDOUT
APR::EXDEV
:filemode
use APR::Const -compile => qw(:filemode);
The :filemode
group is for XXX constants.
APR::BINARY
APR::BUFFERED
APR::CREATE
APR::DELONCLOSE
APR::EXCL
APR::PEND
APR::READ
APR::TRUNCATE
APR::WRITE
:filepath
use APR::Const -compile => qw(:filepath);
The :filepath
group is for XXX constants.
APR::FILEPATH_ENCODING_LOCALE
APR::FILEPATH_ENCODING_UNKNOWN
APR::FILEPATH_ENCODING_UTF8
APR::FILEPATH_NATIVE
APR::FILEPATH_NOTABOVEROOT
APR::FILEPATH_NOTABSOLUTE
APR::FILEPATH_NOTRELATIVE
APR::FILEPATH_SECUREROOT
APR::FILEPATH_SECUREROOTTEST
APR::FILEPATH_TRUENAME
:fileprot
use APR::Const -compile => qw(:fileprot);
The :fileprot
group is used by $finfo->protection
.
APR_FILEPROT_GEXECUTE
Execute by group
APR_FILEPROT_GREAD
Read by group
APR_FILEPROT_GSETID
Set group id
APR_FILEPROT_GWRITE
Write by group
APR_FILEPROT_OS_DEFAULT
use OS's default permissions
APR_FILEPROT_UEXECUTE
Execute by user
APR_FILEPROT_UREAD
Read by user
APR_FILEPROT_USETID
Set user id
APR_FILEPROT_UWRITE
Write by user
APR_FILEPROT_WEXECUTE
Execute by others
APR_FILEPROT_WREAD
Read by others
APR_FILEPROT_WSTICKY
Sticky bit
APR_FILEPROT_WWRITE
Write by others
:filetype
use APR::Const -compile => qw(:filetype);
The :filetype
group is used by $finfo->filetype
.
APR::FILETYPE_BLK
a file is a block device
APR::FILETYPE_CHR
a file is a character device
APR::FILETYPE_DIR
a file is a directory
APR::FILETYPE_LNK
a file is a symbolic link
APR::FILETYPE_NOFILE
the file type is undedetermined.
APR::FILETYPE_PIPE
a file is a FIFO or a pipe.
APR::FILETYPE_REG
a file is a regular file.
APR::FILETYPE_SOCK
a file is a [unix domain] socket.
APR::FILETYPE_UNKFILE
a file is of some other unknown type or the type cannot be determined.
:finfo
use APR::Const -compile => qw(:finfo);
The :finfo
group is used by stat()
and $finfo->valid
.
APR::FINFO_ATIME
Access Time
APR::FINFO_CSIZE
Storage size consumed by the file
APR::FINFO_CTIME
Creation Time
APR::FINFO_DEV
Device
APR::FINFO_DIRENT
an atomic unix apr_dir_read()
APR::FINFO_GPROT
Group protection bits
APR::FINFO_GROUP
Group id
APR::FINFO_ICASE
whether device is case insensitive
APR::FINFO_IDENT
device and inode
APR::FINFO_INODE
Inode
APR::FINFO_LINK
Stat the link not the file itself if it is a link
APR::FINFO_MIN
type, mtime, ctime, atime, size
APR::FINFO_MTIME
Modification Time
APR::FINFO_NAME
name in proper case
APR::FINFO_NLINK
Number of links
APR::FINFO_NORM
All fields provided by an atomic unix apr_stat()
APR::FINFO_OWNER
user and group
APR::FINFO_PROT
all protections
APR::FINFO_SIZE
Size of the file
APR::FINFO_TYPE
Type
APR::FINFO_UPROT
User protection bits
APR::FINFO_USER
User id
APR::FINFO_WPROT
World protection bits
:flock
use APR::Const -compile => qw(:flock);
The :flock
group is for XXX constants.
APR::FLOCK_EXCLUSIVE
APR::FLOCK_NONBLOCK
APR::FLOCK_SHARED
APR::FLOCK_TYPEMASK
:hook
use APR::Const -compile => qw(:hook);
The :hook
group is for XXX constants.
APR::HOOK_FIRST
APR::HOOK_LAST
APR::HOOK_MIDDLE
APR::HOOK_REALLY_FIRST
APR::HOOK_REALLY_LAST
:limit
use APR::Const -compile => qw(:limit);
The :limit
group is for XXX constants.
APR::LIMIT_CPU
APR::LIMIT_MEM
APR::LIMIT_NOFILE
APR::LIMIT_NPROC
:lockmech
use APR::Const -compile => qw(:lockmech);
The :lockmech
group is for XXX constants.
APR::LOCK_DEFAULT
APR::LOCK_FCNTL
APR::LOCK_FLOCK
APR::LOCK_POSIXSEM
APR::LOCK_PROC_PTHREAD
APR::LOCK_SYSVSEM
:poll
use APR::Const -compile => qw(:poll);
The :poll
group is used by poll
.
APR::POLLERR
Pending error
APR::POLLHUP
Hangup occurred
APR::POLLIN
Can read without blocking
APR::POLLNVAL
Descriptior invalid
APR::POLLOUT
Can write without blocking
APR::POLLPRI
Priority data available
:read_type
use APR::Const -compile => qw(:read_type);
The :read_type
group is for IO constants.
APR::BLOCK_READ
the read function blocks
APR::NONBLOCK_READ
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
APR::SHUTDOWN_READWRITE
APR::SHUTDOWN_WRITE
: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
Turns on debugging information
APR::SO_DISCONNECTED
Queries the disconnected state of the socket. (Currently only used on Windows)
Possible values:
XXX
APR::SO_KEEPALIVE
Keeps connections active
Possible values:
XXX
APR::SO_LINGER
Lingers on close if data is present
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.
APR::SO_RCVBUF
Controls the ReceiveBufferSize
setting
Possible values:
XXX
APR::SO_REUSEADDR
The rules used in validating addresses supplied to bind should allow reuse of local addresses.
Possible values:
XXX
APR::SO_SNDBUF
Controls the SendBufferSize
setting
Possible values:
XXX
: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.
: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
See APR::Table::compress
and APR::Table::overlap
.
APR::OVERLAP_TABLES_SET
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
APR::URI_FTP_DEFAULT_PORT
APR::URI_GOPHER_DEFAULT_PORT
APR::URI_HTTPS_DEFAULT_PORT
APR::URI_HTTP_DEFAULT_PORT
APR::URI_IMAP_DEFAULT_PORT
APR::URI_LDAP_DEFAULT_PORT
APR::URI_NFS_DEFAULT_PORT
APR::URI_NNTP_DEFAULT_PORT
APR::URI_POP_DEFAULT_PORT
APR::URI_PROSPERO_DEFAULT_PORT
APR::URI_RTSP_DEFAULT_PORT
APR::URI_SIP_DEFAULT_PORT
APR::URI_SNEWS_DEFAULT_PORT
APR::URI_SSH_DEFAULT_PORT
APR::URI_TELNET_DEFAULT_PORT
APR::URI_TIP_DEFAULT_PORT
APR::URI_UNP_OMITPASSWORD
See APR::URI::unparse
.
APR::URI_UNP_OMITPATHINFO
See APR::URI::unparse
.
APR::URI_UNP_OMITQUERY
See APR::URI::unparse
.
APR::URI_UNP_OMITSITEPART
See APR::URI::unparse
.
APR::URI_UNP_OMITUSER
See APR::URI::unparse
.
APR::URI_UNP_OMITUSERINFO
APR::URI_UNP_REVEALPASSWORD
See APR::URI::unparse
.
APR::URI_WAIS_DEFAULT_PORT
Other Constants
APR::PerlIO::PERLIO_LAYERS_ARE_ENABLED
See Also
Copyright
mod_perl 2.0 and its core modules are copyrighted under The Apache Software License, Version 2.0.