.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "docs::api::APR::PerlIO 3pm"
.TH docs::api::APR::PerlIO 3pm 2024-01-10 "perl v5.38.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
APR::PerlIO \-\- Perl IO layer for APR
.SH Synopsis
.IX Header "Synopsis"
.Vb 2
\&  # under mod_perl
\&  use APR::PerlIO ();
\&  
\&  sub handler {
\&      my $r = shift;
\&  
\&      die "This Perl build doesn\*(Aqt support PerlIO layers"
\&          unless APR::PerlIO::PERLIO_LAYERS_ARE_ENABLED;
\&  
\&      open my $fh, ">:APR", $filename, $r\->pool or die $!;
\&      # work with $fh as normal $fh
\&      close $fh;
\&  
\&      return Apache2::Const::OK;
\&  }
\&
\&  # outside mod_perl
\&  % perl \-MAPR \-MAPR::PerlIO \-MAPR::Pool \-le \e
\&  \*(Aqopen my $fh, ">:APR", "/tmp/apr", APR::Pool\->new or die "$!"; \e
\&   print $fh "whoah!"; \e
\&   close $fh;\*(Aq
.Ve
.SH Description
.IX Header "Description"
\&\f(CW\*(C`APR::PerlIO\*(C'\fR implements a Perl IO layer using APR's file
manipulation API internally.
.PP
Why do you want to use this? Normally you shouldn't, probably it won't
be faster than Perl's default layer. It's only useful when you need to
manipulate a filehandle opened at the APR side, while using Perl.
.PP
Normally you won't call \fBopen()\fR with APR layer attribute, but some
mod_perl functions will return a filehandle which is internally hooked
to APR. But you can use APR Perl IO directly if you want.
.SH Prerequisites
.IX Header "Prerequisites"
Not every Perl will have full \f(CW\*(C`APR::PerlIO\*(C'\fR functionality available.
.PP
Before using the Perl IO APR layer one has to check whether it's
supported by the used APR/Perl build. Perl 5.8.x or higher with perlio
enabled is required. You can check whether your Perl fits the bill by
running:
.PP
.Vb 2
\&  % perl \-V:useperlio
\&  useperlio=\*(Aqdefine\*(Aq;
.Ve
.PP
It should say \fIdefine\fR.
.PP
If you need to do the checking in the code, there is a special
constant provided by \f(CW\*(C`APR::PerlIO\*(C'\fR, which can be used as follows:
.PP
.Vb 3
\&  use APR::PerlIO ();
\&  die "This Perl build doesn\*(Aqt support PerlIO layers"
\&      unless APR::PerlIO::PERLIO_LAYERS_ARE_ENABLED;
.Ve
.PP
Notice that loading \f(CW\*(C`APR::PerlIO\*(C'\fR won't fail when Perl IO layers
aren't available since \f(CW\*(C`APR::PerlIO\*(C'\fR provides functionality for Perl
builds not supporting Perl IO layers.
.SH Constants
.IX Header "Constants"
.ie n .SS """APR::PerlIO::PERLIO_LAYERS_ARE_ENABLED"""
.el .SS \f(CWAPR::PerlIO::PERLIO_LAYERS_ARE_ENABLED\fP
.IX Subsection "APR::PerlIO::PERLIO_LAYERS_ARE_ENABLED"
See Prerequisites.
.SH API
.IX Header "API"
Most of the API is as in normal perl IO with a few nuances listed in
the following sections.
.PP
META: need to rework the exception mechanism here. Current success in
using errno ($!) being set (e.g. on \fBopen()\fR) is purely accidental and
not guaranteed across all platforms and functions. So don't rely on
$!. Will use \f(CW\*(C`APR::Error\*(C'\fR for that
purpose.
.ie n .SS """open"""
.el .SS \f(CWopen\fP
.IX Subsection "open"
Open a file via APR Perl IO layer.
.PP
.Vb 1
\&  open my $fh, ">:APR", $filename, $r\->pool or die $!;
.Ve
.ie n .IP "arg1: $fh ( GLOB filehandle )" 4
.el .IP "arg1: \f(CW$fh\fR ( GLOB filehandle )" 4
.IX Item "arg1: $fh ( GLOB filehandle )"
The filehandle.
.ie n .IP "arg2: $mode ( string )" 4
.el .IP "arg2: \f(CW$mode\fR ( string )" 4
.IX Item "arg2: $mode ( string )"
The mode to open the file, constructed from two sections separated by
the \f(CW\*(C`:\*(C'\fR character: the first section is the mode to open the file
under (>, <, etc) and the second section must be a string
\&\fIAPR\fR. For more information refer to the \fIopen\fR entry in the
\&\fIperlfunc\fR manpage.
.ie n .IP "arg3: $filename ( string )" 4
.el .IP "arg3: \f(CW$filename\fR ( string )" 4
.IX Item "arg3: $filename ( string )"
The path to the filename to open
.ie n .IP "arg4: $p ( ""APR::Pool"" )" 4
.el .IP "arg4: \f(CW$p\fR ( \f(CWAPR::Pool\fR )" 4
.IX Item "arg4: $p ( APR::Pool )"
The pool object to use to allocate APR::PerlIO layer.
.IP "ret: ( integer )" 4
.IX Item "ret: ( integer )"
success or failure value (boolean).
.IP "since: 2.0.00" 4
.IX Item "since: 2.0.00"
.ie n .SS """seek"""
.el .SS \f(CWseek\fP
.IX Subsection "seek"
Sets \f(CW$fh\fR's position, just like the \f(CWseek()\fR Perl call:
.PP
.Vb 1
\&  seek($fh, $offset, $whence);
.Ve
.PP
If \f(CW$offset\fR is zero, \f(CWseek()\fR works normally.
.PP
However if \f(CW$offset\fR is non-zero and Perl has been compiled with with
large files support (\f(CW\*(C`\-Duselargefiles\*(C'\fR), whereas APR wasn't, this
function will croak. This is because largefile size \f(CW\*(C`Off_t\*(C'\fR simply
cannot fit into a non-largefile size \f(CW\*(C`apr_off_t\*(C'\fR.
.PP
To solve the problem, rebuild Perl with \f(CW\*(C`\-Uuselargefiles\*(C'\fR. Currently
there is no way to force APR to build with large files support.
.IP "since: 2.0.00" 4
.IX Item "since: 2.0.00"
.SH "C API"
.IX Header "C API"
The C API provides functions to convert between Perl IO and APR Perl
IO filehandles.
.PP
META: document these
.SH "See Also"
.IX Header "See Also"
mod_perl 2.0 documentation. The \fR\f(BIperliol\fR\fI\|(1)\fR,
\&\fI\fR\f(BIperlapio\fR\fI\|(1)\fR and \fI\fR\f(BIperl\fR\fI\|(1)\fR manpages.
.SH Copyright
.IX Header "Copyright"
mod_perl 2.0 and its core modules are copyrighted under
The Apache Software License, Version 2.0.
.SH Authors
.IX Header "Authors"
The mod_perl development team and numerous
contributors.