File: FilterRec.pod

package info (click to toggle)
libapache2-mod-perl2 2.0.13-2
  • links: PTS, VCS
  • area: main
  • in suites: sid, trixie
  • size: 12,016 kB
  • sloc: perl: 97,771; ansic: 14,493; makefile: 51; sh: 18
file content (104 lines) | stat: -rw-r--r-- 1,679 bytes parent folder | download | duplicates (11)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
=head1 NAME

Apache2::FilterRec - Perl API for manipulating the Apache filter record




=head1 Synopsis

  use Apache2::Filter ();
  use Apache2::FilterRec ();
  
  my $frec = $filter->frec;
  print "filter name is:", $frec->name;




=head1 Description

C<Apache2::FilterRec> provides an access to the filter record
structure.

The C<Apache2::FilterRec> object is retrieved by calling
C<L<frec()|docs::2.0::api::Apache2::Filter/C_frec_>>:

  $frec = $filter->frec;






=head1 API

C<Apache2::FilterRec> provides the following functions and/or methods:




=head2 C<name>

The registered name for this filter

  $name = $frec->name();

=over 4

=item obj: C<$frec>
( C<L<Apache2::FilterRec object|docs::2.0::api::Apache2::FilterRec>> )

=item ret: C<$name> (string)

=item since: 2.0.00

=back

mod_perl filters have four names:

  modperl_request_output
  modperl_request_input
  modperl_connection_output
  modperl_connection_input

You can see the names of the non-mod_perl filters as well. By calling
C<L<$filter-E<gt>next-E<gt>frec-E<gt>name|docs::2.0::api::Apache2::Filter/C_next_>>
you can get the name of the next filter in the chain.

Example:

Let's print the name of the current and the filter that follows it:

  use Apache2::Filter ();
  use Apache2::FilterRec ();
  for my $frec ($filter->frec, $filter->next->frec) {
      print "Name: ", $frec->name;
  }





=head1 See Also

L<mod_perl 2.0 documentation|docs::2.0::index>.




=head1 Copyright

mod_perl 2.0 and its core modules are copyrighted under
The Apache Software License, Version 2.0.




=head1 Authors

L<The mod_perl development team and numerous
contributors|about::contributors::people>.

=cut