docs::a...R::Const(3)

πŸ“¦ version 2.0.13, in nixos 26.05, nixpkgs unstable

🌸 NAME 🌸

APR::Const β€” Perl Interface for APR Constants. This is the manual page docs::a...R::Const(3), from User Contributed Perl Documentation, and it's basically the constant stash for APR stuff. πŸ’…


✨ 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 ...);

Three ways to summon the constants, bestie. Pick your vibe. 🫢


πŸ¦‹ Description πŸ¦‹

This package contains constants specific to APR features.

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


🌈 Constants 🌈

πŸŽ€ :common πŸŽ€

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

The :common group is for XXX constants. (Yes, the page literally says XXX β€” no cap, that's what's here. πŸ‘€)

  • APR::Const::SUCCESS β€” since: 2.0.00

πŸ’– :error πŸ’–

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

The :error group is for XXX constants.

  • APR::Const::EABOVEROOT β€” since: 2.0.00
  • APR::Const::EABSOLUTE β€” since: 2.0.00
  • APR::Const::EACCES β€” since: 2.0.00. Due to possible variants in conditions matching EACCES, for checking error codes against this you most likely want to use the APR::Status::is_EACCES function instead.
  • APR::Const::EAGAIN β€” since: 2.0.00. The error Resource temporarily unavailable, may be returned by many different system calls, especially IO calls. Most likely you want to use the APR::Status::is_EAGAIN function instead.
  • APR::Const::EBADDATE β€” since: 2.0.00
  • APR::Const::EBADF β€” since: 2.0.00
  • APR::Const::EBADIP β€” since: 2.0.00
  • APR::Const::EBADMASK β€” since: 2.0.00
  • APR::Const::EBADPATH β€” since: 2.0.00
  • APR::Const::EBUSY β€” since: 2.0.00
  • APR::Const::ECONNABORTED β€” since: 2.0.00. Due to possible variants in conditions matching ECONNABORTED, for checking error codes against this you most likely want to use the APR::Status::is_ECONNABORTED function instead.
  • APR::Const::ECONNREFUSED β€” since: 2.0.00
  • APR::Const::ECONNRESET β€” since: 2.0.00. Due to possible variants in conditions matching ECONNRESET, for checking error codes against this you most likely want to use the APR::Status::is_ECONNRESET function instead.
  • APR::Const::EDSOOPEN β€” since: 2.0.00
  • APR::Const::EEXIST β€” since: 2.0.00
  • APR::Const::EFTYPE β€” since: 2.0.00
  • APR::Const::EGENERAL β€” since: 2.0.00
  • APR::Const::EHOSTUNREACH β€” since: 2.0.00
  • APR::Const::EINCOMPLETE β€” since: 2.0.00
  • APR::Const::EINIT β€” since: 2.0.00
  • APR::Const::EINPROGRESS β€” since: 2.0.00
  • APR::Const::EINTR β€” since: 2.0.00
  • APR::Const::EINVAL β€” since: 2.0.00
  • APR::Const::EINVALSOCK β€” since: 2.0.00
  • APR::Const::EMFILE β€” since: 2.0.00
  • APR::Const::EMISMATCH β€” since: 2.0.00
  • APR::Const::ENAMETOOLONG β€” since: 2.0.00
  • APR::Const::END β€” since: 2.0.00
  • APR::Const::ENETUNREACH β€” since: 2.0.00
  • APR::Const::ENFILE β€” since: 2.0.00
  • APR::Const::ENODIR β€” since: 2.0.00
  • APR::Const::ENOENT β€” since: 2.0.00. Due to possible variants in conditions matching ENOENT, for checking error codes against this you most likely want to use the APR::Status::is_ENOENT function instead.
  • APR::Const::ENOLOCK β€” since: 2.0.00
  • APR::Const::ENOMEM β€” since: 2.0.00
  • APR::Const::ENOPOLL β€” since: 2.0.00
  • APR::Const::ENOPOOL β€” since: 2.0.00
  • APR::Const::ENOPROC β€” since: 2.0.00
  • APR::Const::ENOSHMAVAIL β€” since: 2.0.00
  • APR::Const::ENOSOCKET β€” since: 2.0.00
  • APR::Const::ENOSPC β€” since: 2.0.00
  • APR::Const::ENOSTAT β€” since: 2.0.00
  • APR::Const::ENOTDIR β€” since: 2.0.00
  • APR::Const::ENOTEMPTY β€” since: 2.0.00
  • APR::Const::ENOTHDKEY β€” since: 2.0.00
  • APR::Const::ENOTHREAD β€” since: 2.0.00
  • APR::Const::ENOTIME β€” since: 2.0.00
  • APR::Const::ENOTIMPL β€” Something is not implemented. since: 2.0.00
  • APR::Const::ENOTSOCK β€” since: 2.0.00
  • APR::Const::EOF β€” since: 2.0.00. Due to possible variants in conditions matching EOF, for checking error codes against this you most likely want to use the APR::Status::is_EOF function instead.
  • APR::Const::EPATHWILD β€” since: 2.0.00
  • APR::Const::EPIPE β€” since: 2.0.00
  • APR::Const::EPROC_UNKNOWN β€” since: 2.0.00
  • APR::Const::ERELATIVE β€” since: 2.0.00
  • APR::Const::ESPIPE β€” since: 2.0.00
  • APR::Const::ESYMNOTFOUND β€” since: 2.0.00
  • APR::Const::ETIMEDOUT β€” since: 2.0.00
  • APR::Const::EXDEV β€” since: 2.0.00

πŸ¦‹ :fopen πŸ¦‹

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

The :fopen group is for XXX constants.

  • APR::Const::FOPEN_BINARY β€” since: 2.0.00
  • APR::Const::FOPEN_BUFFERED β€” since: 2.0.00
  • APR::Const::FOPEN_CREATE β€” since: 2.0.00
  • APR::Const::FOPEN_DELONCLOSE β€” since: 2.0.00
  • APR::Const::FOPEN_EXCL β€” since: 2.0.00
  • APR::Const::FOPEN_PEND β€” since: 2.0.00
  • APR::Const::FOPEN_READ β€” since: 2.0.00
  • APR::Const::FOPEN_TRUNCATE β€” since: 2.0.00
  • APR::Const::FOPEN_WRITE β€” since: 2.0.00

🌸 :filepath 🌸

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

The :filepath group is for XXX constants.

  • APR::Const::FILEPATH_ENCODING_LOCALE β€” since: 2.0.00
  • APR::Const::FILEPATH_ENCODING_UNKNOWN β€” since: 2.0.00
  • APR::Const::FILEPATH_ENCODING_UTF8 β€” since: 2.0.00
  • APR::Const::FILEPATH_NATIVE β€” since: 2.0.00
  • APR::Const::FILEPATH_NOTABOVEROOT β€” since: 2.0.00
  • APR::Const::FILEPATH_NOTABSOLUTE β€” since: 2.0.00
  • APR::Const::FILEPATH_NOTRELATIVE β€” since: 2.0.00
  • APR::Const::FILEPATH_SECUREROOT β€” since: 2.0.00
  • APR::Const::FILEPATH_SECUREROOTTEST β€” since: 2.0.00
  • APR::Const::FILEPATH_TRUENAME β€” since: 2.0.00

πŸ’œ :fprot πŸ’œ

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

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

  • APR::Const::FPROT_GEXECUTE β€” Execute by group. since: 2.0.00
  • APR::Const::FPROT_GREAD β€” Read by group. since: 2.0.00
  • APR::Const::FPROT_GSETID β€” Set group id. since: 2.0.00
  • APR::Const::FPROT_GWRITE β€” Write by group. since: 2.0.00
  • APR::Const::FPROT_OS_DEFAULT β€” use OS's default permissions. since: 2.0.00
  • APR::Const::FPROT_UEXECUTE β€” Execute by user. since: 2.0.00
  • APR::Const::FPROT_UREAD β€” Read by user. since: 2.0.00
  • APR::Const::FPROT_USETID β€” Set user id. since: 2.0.00
  • APR::Const::FPROT_UWRITE β€” Write by user. since: 2.0.00
  • APR::Const::FPROT_WEXECUTE β€” Execute by others. since: 2.0.00
  • APR::Const::FPROT_WREAD β€” Read by others. since: 2.0.00
  • APR::Const::FPROT_WSTICKY β€” Sticky bit. since: 2.0.00
  • APR::Const::FPROT_WWRITE β€” Write by others. since: 2.0.00

🧚 :filetype 🧚

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

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

  • APR::Const::FILETYPE_BLK β€” a file is a block device. since: 2.0.00
  • APR::Const::FILETYPE_CHR β€” a file is a character device. since: 2.0.00
  • APR::Const::FILETYPE_DIR β€” a file is a directory. since: 2.0.00
  • APR::Const::FILETYPE_LNK β€” a file is a symbolic link. since: 2.0.00
  • APR::Const::FILETYPE_NOFILE β€” the file type is undedetermined. since: 2.0.00
  • APR::Const::FILETYPE_PIPE β€” a file is a FIFO or a pipe. since: 2.0.00
  • APR::Const::FILETYPE_REG β€” a file is a regular file. since: 2.0.00
  • APR::Const::FILETYPE_SOCK β€” a file is a [unix domain] socket. since: 2.0.00
  • APR::Const::FILETYPE_UNKFILE β€” a file is of some other unknown type or the type cannot be determined. since: 2.0.00

πŸ‘‘ :finfo πŸ‘‘

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

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

  • APR::Const::FINFO_ATIME β€” Access Time. since: 2.0.00
  • APR::Const::FINFO_CSIZE β€” Storage size consumed by the file. since: 2.0.00
  • APR::Const::FINFO_CTIME β€” Creation Time. since: 2.0.00
  • APR::Const::FINFO_DEV β€” Device. since: 2.0.00
  • APR::Const::FINFO_DIRENT β€” an atomic unix apr_dir_read(). since: 2.0.00
  • APR::Const::FINFO_GPROT β€” Group protection bits. since: 2.0.00
  • APR::Const::FINFO_GROUP β€” Group id. since: 2.0.00
  • APR::Const::FINFO_ICASE β€” whether device is case insensitive. since: 2.0.00
  • APR::Const::FINFO_IDENT β€” device and inode. since: 2.0.00
  • APR::Const::FINFO_INODE β€” Inode. since: 2.0.00
  • APR::Const::FINFO_LINK β€” Stat the link not the file itself if it is a link. since: 2.0.00
  • APR::Const::FINFO_MIN β€” type, mtime, ctime, atime, size. since: 2.0.00
  • APR::Const::FINFO_MTIME β€” Modification Time. since: 2.0.00
  • APR::Const::FINFO_NAME β€” name in proper case. since: 2.0.00
  • APR::Const::FINFO_NLINK β€” Number of links. since: 2.0.00
  • APR::Const::FINFO_NORM β€” All fields provided by an atomic unix apr_stat(). since: 2.0.00
  • APR::Const::FINFO_OWNER β€” user and group. since: 2.0.00
  • APR::Const::FINFO_PROT β€” all protections. since: 2.0.00
  • APR::Const::FINFO_SIZE β€” Size of the file. since: 2.0.00
  • APR::Const::FINFO_TYPE β€” Type. since: 2.0.00
  • APR::Const::FINFO_UPROT β€” User protection bits. since: 2.0.00
  • APR::Const::FINFO_USER β€” User id. since: 2.0.00
  • APR::Const::FINFO_WPROT β€” World protection bits. since: 2.0.00

πŸ”₯ :flock πŸ”₯

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

The :flock group is for XXX constants.

  • APR::Const::FLOCK_EXCLUSIVE β€” since: 2.0.00
  • APR::Const::FLOCK_NONBLOCK β€” since: 2.0.00
  • APR::Const::FLOCK_SHARED β€” since: 2.0.00
  • APR::Const::FLOCK_TYPEMASK β€” since: 2.0.00

πŸ“ :hook πŸ“

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

The :hook group is for XXX constants.

  • APR::Const::HOOK_FIRST β€” since: 2.0.00
  • APR::Const::HOOK_LAST β€” since: 2.0.00
  • APR::Const::HOOK_MIDDLE β€” since: 2.0.00
  • APR::Const::HOOK_REALLY_FIRST β€” since: 2.0.00
  • APR::Const::HOOK_REALLY_LAST β€” since: 2.0.00

⭐ :limit ⭐

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

The :limit group is for XXX constants.

  • APR::Const::LIMIT_CPU β€” since: 2.0.00
  • APR::Const::LIMIT_MEM β€” since: 2.0.00
  • APR::Const::LIMIT_NOFILE β€” since: 2.0.00
  • APR::Const::LIMIT_NPROC β€” since: 2.0.00

πŸŽ€ :lockmech πŸŽ€

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

The :lockmech group is for XXX constants.

Okay bestie, picking up right where we left off β€” here come the rest of the constants, and they're serving πŸ’…

  • APR::Const::LOCK_DEFAULT β€” since: 2.0.00 ✨
  • APR::Const::LOCK_FCNTL β€” since: 2.0.00
  • APR::Const::LOCK_FLOCK β€” since: 2.0.00
  • APR::Const::LOCK_POSIXSEM β€” since: 2.0.00
  • APR::Const::LOCK_PROC_PTHREAD β€” since: 2.0.00
  • APR::Const::LOCK_SYSVSEM β€” since: 2.0.00

:poll πŸŒ€

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

The :poll group is used by poll. (iykyk)

  • APR::Const::POLLERR β€” since: 2.0.00 β€” Pending error
  • APR::Const::POLLHUP β€” since: 2.0.00 β€” Hangup occurred
  • APR::Const::POLLIN β€” since: 2.0.00 β€” Can read without blocking
  • APR::Const::POLLNVAL β€” since: 2.0.00 β€” Descriptior invalid (yes, that's the typo in the original, bestie πŸ’€)
  • APR::Const::POLLOUT β€” since: 2.0.00 β€” Can write without blocking
  • APR::Const::POLLPRI β€” since: 2.0.00 β€” Priority data available

:read_type 🌸

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

The :read_type group is for IO constants. (periodt)

  • APR::Const::BLOCK_READ β€” since: 2.0.00 β€” the read function blocks
  • APR::Const::NONBLOCK_READ β€” since: 2.0.00 β€” the read function does not block

:shutdown_how πŸ›‘

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

The :shutdown_how group is for XXX constants. (not me writing XXX in the docs, but go off πŸ’€)

  • APR::Const::SHUTDOWN_READ β€” since: 2.0.00
  • APR::Const::SHUTDOWN_READWRITE β€” since: 2.0.00
  • APR::Const::SHUTDOWN_WRITE β€” since: 2.0.00

: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. (get ready, bestie)

  • APR::Const::SO_DEBUG
    • Possible values: XXX
    • since: 2.0.00
    • Turns on debugging information
  • APR::Const::SO_DISCONNECTED
    • Queries the disconnected state of the socket. (Currently only used on Windows)
    • Possible values: XXX
    • since: 2.0.00
  • APR::Const::SO_KEEPALIVE
    • Keeps connections active
    • Possible values: XXX
    • since: 2.0.00
  • APR::Const::SO_LINGER
    • Lingers on close if data is present
    • since: 2.0.00
  • APR::Const::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::Const::SO_NONBLOCK)) {
    $socket->opt_set(APR::Const::SO_NONBLOCK => 0);
}
  • You don't have to query for this option, before setting it. It was done for the demonstration purpose.
  • since: 2.0.00
  • APR::Const::SO_RCVBUF
    • Controls the ReceiveBufferSize setting
    • Possible values: XXX
    • since: 2.0.00
  • APR::Const::SO_REUSEADDR
    • The rules used in validating addresses supplied to bind should allow reuse of local addresses.
    • Possible values: XXX
    • since: 2.0.00
  • APR::Const::SO_SNDBUF
    • Controls the SendBufferSize setting
    • Possible values: XXX
    • since: 2.0.00

:status πŸ“Š

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

The :status group is for the API that return status code, or set the error variable XXXXXX. (yes, literally XXXXXX, no cap)

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

  • APR::Const::TIMEUP
    • The operation did not finish before the timeout.
    • since: 2.0.00
    • Due to possible variants in conditions matching TIMEUP, for checking error codes against this you most likely want to use the APR::Status::is_TIMEUP function instead. (pro tip, bestie)

:table πŸ“‹

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

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

  • APR::Const::OVERLAP_TABLES_MERGE β€” since: 2.0.00 β€” See APR::Table::compress and APR::Table::overlap.
  • APR::Const::OVERLAP_TABLES_SET β€” since: 2.0.00 β€” See APR::Table::compress and APR::Table::overlap.

:uri 🌐

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

The :uri group of constants is for manipulating URIs. (we love a good URI manipulation era)

  • APR::Const::URI_ACAP_DEFAULT_PORT β€” since: 2.0.00
  • APR::Const::URI_FTP_DEFAULT_PORT β€” since: 2.0.00
  • APR::Const::URI_GOPHER_DEFAULT_PORT β€” since: 2.0.00
  • APR::Const::URI_HTTPS_DEFAULT_PORT β€” since: 2.0.00
  • APR::Const::URI_HTTP_DEFAULT_PORT β€” since: 2.0.00
  • APR::Const::URI_IMAP_DEFAULT_PORT β€” since: 2.0.00
  • APR::Const::URI_LDAP_DEFAULT_PORT β€” since: 2.0.00
  • APR::Const::URI_NFS_DEFAULT_PORT β€” since: 2.0.00
  • APR::Const::URI_NNTP_DEFAULT_PORT β€” since: 2.0.00
  • APR::Const::URI_POP_DEFAULT_PORT β€” since: 2.0.00
  • APR::Const::URI_PROSPERO_DEFAULT_PORT β€” since: 2.0.00
  • APR::Const::URI_RTSP_DEFAULT_PORT β€” since: 2.0.00
  • APR::Const::URI_SIP_DEFAULT_PORT β€” since: 2.0.00
  • APR::Const::URI_SNEWS_DEFAULT_PORT β€” since: 2.0.00
  • APR::Const::URI_SSH_DEFAULT_PORT β€” since: 2.0.00
  • APR::Const::URI_TELNET_DEFAULT_PORT β€” since: 2.0.00
  • APR::Const::URI_TIP_DEFAULT_PORT β€” since: 2.0.00
  • APR::Const::URI_UNP_OMITPASSWORD β€” since: 2.0.00 β€” See APR::URI::unparse.
  • APR::Const::URI_UNP_OMITPATHINFO β€” since: 2.0.00 β€” See APR::URI::unparse.
  • APR::Const::URI_UNP_OMITQUERY β€” since: 2.0.00 β€” See APR::URI::unparse.
  • APR::Const::URI_UNP_OMITSITEPART β€” since: 2.0.00 β€” See APR::URI::unparse.
  • APR::Const::URI_UNP_OMITUSER β€” since: 2.0.00 β€” See APR::URI::unparse.
  • APR::Const::URI_UNP_OMITUSERINFO β€” since: 2.0.00
  • APR::Const::URI_UNP_REVEALPASSWORD β€” since: 2.0.00 β€” See APR::URI::unparse.
  • APR::Const::URI_WAIS_DEFAULT_PORT β€” since: 2.0.00

Other Constants πŸŽ€

  • APR::PerlIO::PERLIO_LAYERS_ARE_ENABLED β€” since: 2.0.00 β€” See "APR::PerlIO::Constants") (yes, with the stray closing paren, iconic πŸ’€)

See Also πŸ‘€

mod_perl 2.0 documentation.

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.


πŸ’– And that's a wrap, bestie! This iconic page is from perl v5.42.3, dated 2023-10-21, and it's docs::a...R::Const(3). Now go forth and constant-slaying! βœ¨πŸ‘‘

πŸ“¦ where this page comes from