<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> <html> <head> <title>4.5.5.1 Filter Methods</title> <META NAME="description" CONTENT="4.5.5.1 Filter Methods"> <META NAME="keywords" CONTENT="modpython"> <META NAME="resource-type" CONTENT="document"> <META NAME="distribution" CONTENT="global"> <link rel="STYLESHEET" href="modpython.css"> <link rel="first" href="modpython.html"> <link rel="contents" href="contents.html" title="Contents"> <link rel="index" href="genindex.html" title="Index"> <LINK REL="next" href="pyapi-mpfilt-mem.html"> <LINK REL="previous" href="pyapi-mpfilt.html"> <LINK REL="up" href="pyapi-mpfilt.html"> <LINK REL="next" href="pyapi-mpfilt-mem.html"> </head> <body> <DIV CLASS="navigation"> <table align="center" width="100%" cellpadding="0" cellspacing="2"> <tr> <td><A href="pyapi-mpfilt.html"><img src="icons/previous.png" border="0" height="32" alt="Previous Page" width="32"></A></td> <td><A href="pyapi-mpfilt.html"><img src="icons/up.png" border="0" height="32" alt="Up One Level" width="32"></A></td> <td><A href="pyapi-mpfilt-mem.html"><img src="icons/next.png" border="0" height="32" alt="Next Page" width="32"></A></td> <td align="center" width="100%">Mod_python Manual</td> <td><A href="contents.html"><img src="icons/contents.png" border="0" height="32" alt="Contents" width="32"></A></td> <td><img src="icons/blank.png" border="0" height="32" alt="" width="32"></td> <td><A href="genindex.html"><img src="icons/index.png" border="0" height="32" alt="Index" width="32"></A></td> </tr></table> <b class="navlabel">Previous:</b> <a class="sectref" href="pyapi-mpfilt.html">4.5.5 Filter Object (mp_filter) </A> <b class="navlabel">Up:</b> <a class="sectref" href="pyapi-mpfilt.html">4.5.5 Filter Object (mp_filter) </A> <b class="navlabel">Next:</b> <a class="sectref" href="pyapi-mpfilt-mem.html">4.5.5.2 Filter Members</A> <br><hr> </DIV> <!--End of Navigation Panel--> <H3><A NAME="SECTION006551000000000000000"> </A> <BR> 4.5.5.1 Filter Methods </H3> <P> <dl><dt><b><a name="l2h-132"><tt class="method">pass_on</tt></a></b>() <dd> Passes all data through the filter without any processing. </dl> <P> <dl><dt><b><a name="l2h-133"><tt class="method">read</tt></a></b>(<big>[</big><var>length</var><big>]</big>) <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 <i>must</i> 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><b><a name="l2h-134"><tt class="method">readline</tt></a></b>(<big>[</big><var>length</var><big>]</big>) <dd> Reads a line from the next filter or up to <var>length</var> bytes. </dl> <P> <dl><dt><b><a name="l2h-135"><tt class="method">write</tt></a></b>(<var>string</var>) <dd> Writes <var>string</var> to the next filter. </dl> <P> <dl><dt><b><a name="l2h-136"><tt class="method">flush</tt></a></b>() <dd> Flushes the output by sending a FLUSH bucket. </dl> <P> <dl><dt><b><a name="l2h-137"><tt class="method">close</tt></a></b>() <dd> Closes the filter and sends an EOS bucket. Any further IO operations on this filter will throw an exception. </dl> <P> <dl><dt><b><a name="l2h-138"><tt class="method">disable</tt></a></b>() <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"> <p><hr> <table align="center" width="100%" cellpadding="0" cellspacing="2"> <tr> <td><A href="pyapi-mpfilt.html"><img src="icons/previous.png" border="0" height="32" alt="Previous Page" width="32"></A></td> <td><A href="pyapi-mpfilt.html"><img src="icons/up.png" border="0" height="32" alt="Up One Level" width="32"></A></td> <td><A href="pyapi-mpfilt-mem.html"><img src="icons/next.png" border="0" height="32" alt="Next Page" width="32"></A></td> <td align="center" width="100%">Mod_python Manual</td> <td><A href="contents.html"><img src="icons/contents.png" border="0" height="32" alt="Contents" width="32"></A></td> <td><img src="icons/blank.png" border="0" height="32" alt="" width="32"></td> <td><A href="genindex.html"><img src="icons/index.png" border="0" height="32" alt="Index" width="32"></A></td> </tr></table> <b class="navlabel">Previous:</b> <a class="sectref" href="pyapi-mpfilt.html">4.5.5 Filter Object (mp_filter) </A> <b class="navlabel">Up:</b> <a class="sectref" href="pyapi-mpfilt.html">4.5.5 Filter Object (mp_filter) </A> <b class="navlabel">Next:</b> <a class="sectref" href="pyapi-mpfilt-mem.html">4.5.5.2 Filter Members</A> <hr> <span class="release-info">Release 3.1.0a, documentation updated on August 26, 2003.</span> </DIV> <!--End of Navigation Panel--> </BODY> </HTML>