|
Server : Apache/2.2.2 (Fedora) System : Linux App1.pathumtani.go.th 2.6.20-1.2320.fc5smp #1 SMP Tue Jun 12 19:40:16 EDT 2007 i686 User : apache ( 48) PHP Version : 5.2.9 Disable Function : NONE Directory : /var/www/manual/mod/mod_python/ |
Upload File : |
<!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'> <META NAME="description" CONTENT="Filter Methods"> <META NAME="keywords" CONTENT="modpython"> <META NAME="resource-type" CONTENT="document"> <META NAME="distribution" CONTENT="global"> <title>4.5.5.1 Filter Methods</title> </head> <body> <DIV CLASS="navigation"> <table align="center" width="100%" cellpadding="0" cellspacing="2"> <tr> <td><a rel="prev" title="4.5.5 Filter Object (mp_filter) " href="pyapi-mpfilt.html"><img src='previous.gif' border='0' height='32' alt='Previous Page' width='32'></A></td> <td><a rel="parent" title="4.5.5 Filter Object (mp_filter) " href="pyapi-mpfilt.html"><img src='up.gif' border='0' height='32' alt='Up One Level' width='32'></A></td> <td><a rel="next" title="4.5.5.2 Filter Members" href="pyapi-mpfilt-mem.html"><img src='next.gif' border='0' height='32' alt='Next Page' width='32'></A></td> <td align="center" width="100%">Mod_python Manual</td> <td><a rel="contents" title="Table of Contents" href="contents.html"><img src='contents.gif' border='0' height='32' alt='Contents' width='32'></A></td> <td><img src='blank.gif' border='0' height='32' alt='' width='32'></td> <td><a rel="index" title="Index" href="genindex.html"><img src='index.gif' border='0' height='32' alt='Index' width='32'></A></td> </tr></table> <b class="navlabel">Previous:</b> <a class="sectref" rel="prev" href="pyapi-mpfilt.html">4.5.5 Filter Object (mp_filter) </A> <b class="navlabel">Up:</b> <a class="sectref" rel="parent" href="pyapi-mpfilt.html">4.5.5 Filter Object (mp_filter) </A> <b class="navlabel">Next:</b> <a class="sectref" rel="next" 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><table cellpadding="0" cellspacing="0"><tr valign="baseline"> <td><nobr><b><a name="l2h-146"><tt class="method">pass_on</tt></a></b>(</nobr></td> <td>)</td></tr></table> <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><a name="l2h-147"><tt class="method">read</tt></a></b>(</nobr></td> <td><big>[</big><var>length</var><big>]</big>)</td></tr></table> <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><table cellpadding="0" cellspacing="0"><tr valign="baseline"> <td><nobr><b><a name="l2h-148"><tt class="method">readline</tt></a></b>(</nobr></td> <td><big>[</big><var>length</var><big>]</big>)</td></tr></table> <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><a name="l2h-149"><tt class="method">write</tt></a></b>(</nobr></td> <td><var>string</var>)</td></tr></table> <dd> Writes <var>string</var> to the next filter. </dl> <P> <dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"> <td><nobr><b><a name="l2h-150"><tt class="method">flush</tt></a></b>(</nobr></td> <td>)</td></tr></table> <dd> Flushes the output by sending a FLUSH bucket. </dl> <P> <dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"> <td><nobr><b><a name="l2h-151"><tt class="method">close</tt></a></b>(</nobr></td> <td>)</td></tr></table> <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><a name="l2h-152"><tt class="method">disable</tt></a></b>(</nobr></td> <td>)</td></tr></table> <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 rel="prev" title="4.5.5 Filter Object (mp_filter) " rel="prev" title="4.5.5 Filter Object (mp_filter) " href="pyapi-mpfilt.html"><img src='previous.gif' border='0' height='32' alt='Previous Page' width='32'></A></td> <td><a rel="parent" title="4.5.5 Filter Object (mp_filter) " rel="parent" title="4.5.5 Filter Object (mp_filter) " href="pyapi-mpfilt.html"><img src='up.gif' border='0' height='32' alt='Up One Level' width='32'></A></td> <td><a rel="next" title="4.5.5.2 Filter Members" rel="next" title="4.5.5.2 Filter Members" href="pyapi-mpfilt-mem.html"><img src='next.gif' border='0' height='32' alt='Next Page' width='32'></A></td> <td align="center" width="100%">Mod_python Manual</td> <td><a rel="contents" title="Table of Contents" rel="contents" title="Table of Contents" href="contents.html"><img src='contents.gif' border='0' height='32' alt='Contents' width='32'></A></td> <td><img src='blank.gif' border='0' height='32' alt='' width='32'></td> <td><a rel="index" title="Index" rel="index" title="Index" href="genindex.html"><img src='index.gif' border='0' height='32' alt='Index' width='32'></A></td> </tr></table> <b class="navlabel">Previous:</b> <a class="sectref" rel="prev" href="pyapi-mpfilt.html">4.5.5 Filter Object (mp_filter) </A> <b class="navlabel">Up:</b> <a class="sectref" rel="parent" href="pyapi-mpfilt.html">4.5.5 Filter Object (mp_filter) </A> <b class="navlabel">Next:</b> <a class="sectref" rel="next" href="pyapi-mpfilt-mem.html">4.5.5.2 Filter Members</A> <hr> <span class="release-info">Release 3.2.8, documentation updated on February 19, 2006.</span> </DIV> <!--End of Navigation Panel--> </BODY> </HTML>