/usr/share/doc/libapache2-mod-python-doc/doc-html/pyapi-mpfilt-meth.html is in libapache2-mod-python-doc 3.3.1-11ubuntu2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<link rel="STYLESHEET" href="modpython.css" type='text/css' />
<link rel="first" href="modpython.html" title='Mod_python Manual' />
<link rel='contents' href='contents.html' title="Contents" />
<link rel='index' href='genindex.html' title='Index' />
<link rel='last' href='about.html' title='About this document...' />
<link rel='help' href='about.html' title='About this document...' />
<link rel="next" href="pyapi-mpfilt-mem.html" />
<link rel="prev" href="pyapi-mpfilt.html" />
<link rel="parent" href="pyapi-mpfilt.html" />
<link rel="next" href="pyapi-mpfilt-mem.html" />
<meta name='aesop' content='information' />
<title>4.5.6.1 Filter Methods</title>
</head>
<body>
<DIV CLASS="navigation">
<div id='top-navigation-panel' xml:id='top-navigation-panel'>
<table align="center" width="100%" cellpadding="0" cellspacing="2">
<tr>
<td class='online-navigation'><a rel="prev" title="4.5.6 Filter Object (mp_filter)"
href="pyapi-mpfilt.html"><img src='previous.png'
border='0' height='32' alt='Previous Page' width='32' /></A></td>
<td class='online-navigation'><a rel="parent" title="4.5.6 Filter Object (mp_filter)"
href="pyapi-mpfilt.html"><img src='up.png'
border='0' height='32' alt='Up One Level' width='32' /></A></td>
<td class='online-navigation'><a rel="next" title="4.5.6.2 Filter Members"
href="pyapi-mpfilt-mem.html"><img src='next.png'
border='0' height='32' alt='Next Page' width='32' /></A></td>
<td align="center" width="100%">Mod_python Manual</td>
<td class='online-navigation'><a rel="contents" title="Table of Contents"
href="contents.html"><img src='contents.png'
border='0' height='32' alt='Contents' width='32' /></A></td>
<td class='online-navigation'><img src='blank.png'
border='0' height='32' alt='' width='32' /></td>
<td class='online-navigation'><a rel="index" title="Index"
href="genindex.html"><img src='index.png'
border='0' height='32' alt='Index' width='32' /></A></td>
</tr></table>
<div class='online-navigation'>
<b class="navlabel">Previous:</b>
<a class="sectref" rel="prev" href="pyapi-mpfilt.html">4.5.6 Filter Object (mp_filter)</A>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="pyapi-mpfilt.html">4.5.6 Filter Object (mp_filter)</A>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="pyapi-mpfilt-mem.html">4.5.6.2 Filter Members</A>
</div>
<hr /></div>
</DIV>
<!--End of Navigation Panel-->
<H3><A NAME="SECTION006561000000000000000"></A><A NAME="pyapi-mpfilt-meth"></A>
<BR>
4.5.6.1 Filter Methods
</H3>
<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
<td><nobr><b><tt id='l2h-167' xml:id='l2h-167' class="method">pass_on</tt></b>(</nobr></td>
<td><var></var>)</td></tr></table></dt>
<dd>
Passes all data through the filter without any processing.
</dl>
<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
<td><nobr><b><tt id='l2h-168' xml:id='l2h-168' class="method">read</tt></b>(</nobr></td>
<td><var></var><big>[</big><var>length</var><big>]</big><var></var>)</td></tr></table></dt>
<dd>
Reads at most <var>len</var> bytes from the next filter, returning a string
with the data read or None if End Of Stream (EOS) has been reached. A
filter <em>must</em> be closed once the EOS has been encountered.
<P>
If the <var>len</var> argument is negative or omitted, reads all data
currently available.
</dl>
<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
<td><nobr><b><tt id='l2h-169' xml:id='l2h-169' class="method">readline</tt></b>(</nobr></td>
<td><var></var><big>[</big><var>length</var><big>]</big><var></var>)</td></tr></table></dt>
<dd>
Reads a line from the next filter or up to <var>length</var> bytes.
</dl>
<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
<td><nobr><b><tt id='l2h-170' xml:id='l2h-170' class="method">write</tt></b>(</nobr></td>
<td><var>string</var>)</td></tr></table></dt>
<dd>
Writes <var>string</var> to the next filter.
</dl>
<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
<td><nobr><b><tt id='l2h-171' xml:id='l2h-171' class="method">flush</tt></b>(</nobr></td>
<td><var></var>)</td></tr></table></dt>
<dd>
Flushes the output by sending a FLUSH bucket.
</dl>
<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
<td><nobr><b><tt id='l2h-172' xml:id='l2h-172' class="method">close</tt></b>(</nobr></td>
<td><var></var>)</td></tr></table></dt>
<dd>
Closes the filter and sends an EOS bucket. Any further IO operations on
this filter will throw an exception.
</dl>
<P>
<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
<td><nobr><b><tt id='l2h-173' xml:id='l2h-173' class="method">disable</tt></b>(</nobr></td>
<td><var></var>)</td></tr></table></dt>
<dd>
Tells mod_python to ignore the provided handler and just pass the data
on. Used internally by mod_python to print traceback from exceptions
encountered in filter handlers to avoid an infinite loop.
</dl>
<P>
<DIV CLASS="navigation">
<div class='online-navigation'>
<p></p><hr />
<table align="center" width="100%" cellpadding="0" cellspacing="2">
<tr>
<td class='online-navigation'><a rel="prev" title="4.5.6 Filter Object (mp_filter)"
href="pyapi-mpfilt.html"><img src='previous.png'
border='0' height='32' alt='Previous Page' width='32' /></A></td>
<td class='online-navigation'><a rel="parent" title="4.5.6 Filter Object (mp_filter)"
href="pyapi-mpfilt.html"><img src='up.png'
border='0' height='32' alt='Up One Level' width='32' /></A></td>
<td class='online-navigation'><a rel="next" title="4.5.6.2 Filter Members"
href="pyapi-mpfilt-mem.html"><img src='next.png'
border='0' height='32' alt='Next Page' width='32' /></A></td>
<td align="center" width="100%">Mod_python Manual</td>
<td class='online-navigation'><a rel="contents" title="Table of Contents"
href="contents.html"><img src='contents.png'
border='0' height='32' alt='Contents' width='32' /></A></td>
<td class='online-navigation'><img src='blank.png'
border='0' height='32' alt='' width='32' /></td>
<td class='online-navigation'><a rel="index" title="Index"
href="genindex.html"><img src='index.png'
border='0' height='32' alt='Index' width='32' /></A></td>
</tr></table>
<div class='online-navigation'>
<b class="navlabel">Previous:</b>
<a class="sectref" rel="prev" href="pyapi-mpfilt.html">4.5.6 Filter Object (mp_filter)</A>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="pyapi-mpfilt.html">4.5.6 Filter Object (mp_filter)</A>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="pyapi-mpfilt-mem.html">4.5.6.2 Filter Members</A>
</div>
</div>
<hr />
<span class="release-info">Release 3.3.1, documentation updated on January 29, 2007.</span>
</DIV>
<!--End of Navigation Panel-->
</BODY>
</HTML>
|