.\" -*- 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::Apache2::FilterRec 3pm"
.TH docs::api::Apache2::FilterRec 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
Apache2::FilterRec \- Perl API for manipulating the Apache filter record
.SH Synopsis
.IX Header "Synopsis"
.Vb 2
\&  use Apache2::Filter ();
\&  use Apache2::FilterRec ();
\&  
\&  my $frec = $filter\->frec;
\&  print "filter name is:", $frec\->name;
.Ve
.SH Description
.IX Header "Description"
\&\f(CW\*(C`Apache2::FilterRec\*(C'\fR provides an access to the filter record
structure.
.PP
The \f(CW\*(C`Apache2::FilterRec\*(C'\fR object is retrieved by calling
\&\f(CWfrec()\fR:
.PP
.Vb 1
\&  $frec = $filter\->frec;
.Ve
.SH API
.IX Header "API"
\&\f(CW\*(C`Apache2::FilterRec\*(C'\fR provides the following functions and/or methods:
.ie n .SS """name"""
.el .SS \f(CWname\fP
.IX Subsection "name"
The registered name for this filter
.PP
.Vb 1
\&  $name = $frec\->name();
.Ve
.ie n .IP "obj: $frec ( ""Apache2::FilterRec object"" )" 4
.el .IP "obj: \f(CW$frec\fR ( \f(CWApache2::FilterRec object\fR )" 4
.IX Item "obj: $frec ( Apache2::FilterRec object )"
.PD 0
.ie n .IP "ret: $name (string)" 4
.el .IP "ret: \f(CW$name\fR (string)" 4
.IX Item "ret: $name (string)"
.IP "since: 2.0.00" 4
.IX Item "since: 2.0.00"
.PD
.PP
mod_perl filters have four names:
.PP
.Vb 4
\&  modperl_request_output
\&  modperl_request_input
\&  modperl_connection_output
\&  modperl_connection_input
.Ve
.PP
You can see the names of the non\-mod_perl filters as well. By calling
\&\f(CW\*(C`$filter\->next\->frec\->name\*(C'\fR
you can get the name of the next filter in the chain.
.PP
Example:
.PP
Let's print the name of the current and the filter that follows it:
.PP
.Vb 5
\&  use Apache2::Filter ();
\&  use Apache2::FilterRec ();
\&  for my $frec ($filter\->frec, $filter\->next\->frec) {
\&      print "Name: ", $frec\->name;
\&  }
.Ve
.SH "See Also"
.IX Header "See Also"
mod_perl 2.0 documentation.
.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.