<!DOCTYPE html PUBLIC
"-//W3C//DTD HTML 4.0 Transitional//EN">
<link rel=
"STYLESHEET" href=
"lib.css" type='text/css'
/>
<link rel=
"SHORTCUT ICON" href=
"../icons/pyfav.png" type=
"image/png" />
<link rel='start' href='../index.html' title='Python Documentation Index'
/>
<link rel=
"first" href=
"lib.html" title='Python Library Reference'
/>
<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=
"asynchat-example.html" />
<link rel=
"prev" href=
"module-asynchat.html" />
<link rel=
"parent" href=
"module-asynchat.html" />
<link rel=
"next" href=
"asynchat-example.html" />
<meta name='aesop' content='information'
/>
<title>11.26.1 asynchat - Auxiliary Classes and Functions
</title>
<div id='top-navigation-panel' xml:id='top-navigation-panel'
>
<table align=
"center" width=
"100%" cellpadding=
"0" cellspacing=
"2">
<td class='online-navigation'
><a rel=
"prev" title=
"11.26 asynchat "
href=
"module-asynchat.html"><img src='../icons/previous.png'
border='
0' height='
32' alt='Previous Page' width='
32'
/></A></td>
<td class='online-navigation'
><a rel=
"parent" title=
"11.26 asynchat "
href=
"module-asynchat.html"><img src='../icons/up.png'
border='
0' height='
32' alt='Up One Level' width='
32'
/></A></td>
<td class='online-navigation'
><a rel=
"next" title=
"11.26.2 asynchat Example"
href=
"asynchat-example.html"><img src='../icons/next.png'
border='
0' height='
32' alt='Next Page' width='
32'
/></A></td>
<td align=
"center" width=
"100%">Python Library Reference
</td>
<td class='online-navigation'
><a rel=
"contents" title=
"Table of Contents"
href=
"contents.html"><img src='../icons/contents.png'
border='
0' height='
32' alt='Contents' width='
32'
/></A></td>
<td class='online-navigation'
><a href=
"modindex.html" title=
"Module Index"><img src='../icons/modules.png'
border='
0' height='
32' alt='Module Index' width='
32'
/></a></td>
<td class='online-navigation'
><a rel=
"index" title=
"Index"
href=
"genindex.html"><img src='../icons/index.png'
border='
0' height='
32' alt='Index' width='
32'
/></A></td>
<div class='online-navigation'
>
<b class=
"navlabel">Previous:
</b>
<a class=
"sectref" rel=
"prev" href=
"module-asynchat.html">11.26 asynchat
</A>
<b class=
"navlabel">Up:
</b>
<a class=
"sectref" rel=
"parent" href=
"module-asynchat.html">11.26 asynchat
</A>
<b class=
"navlabel">Next:
</b>
<a class=
"sectref" rel=
"next" href=
"asynchat-example.html">11.26.2 asynchat Example
</A>
<!--End of Navigation Panel-->
<H2><A NAME=
"SECTION00132610000000000000000">
11.26.1 asynchat - Auxiliary Classes and Functions
</A>
<dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline">
<td><nobr><b><span class=
"typelabel">class
</span> <tt id='l2h-
3780' xml:id='l2h-
3780'
class=
"class">simple_producer
</tt></b>(
</nobr></td>
<td><var>data
</var><big>[
</big><var>, buffer_size=
512</var><big>]
</big><var></var>)
</td></tr></table></dt>
A
<tt class=
"class">simple_producer
</tt> takes a chunk of data and an optional buffer size.
Repeated calls to its
<tt class=
"method">more()
</tt> method yield successive chunks of the
data no larger than
<var>buffer_size
</var>.
<dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline">
<td><nobr><b><tt id='l2h-
3781' xml:id='l2h-
3781'
class=
"method">more
</tt></b>(
</nobr></td>
<td><var></var>)
</td></tr></table></dt>
Produces the next chunk of information from the producer, or returns the empty string.
<dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline">
<td><nobr><b><span class=
"typelabel">class
</span> <tt id='l2h-
3782' xml:id='l2h-
3782'
class=
"class">fifo
</tt></b>(
</nobr></td>
<td><var></var><big>[
</big><var>list=None
</var><big>]
</big><var></var>)
</td></tr></table></dt>
Each channel maintains a
<tt class=
"class">fifo
</tt> holding data which has been pushed by the
application but not yet popped for writing to the channel.
A
<tt class=
"class">fifo
</tt> is a list used to hold data and/or producers until they are required.
If the
<var>list
</var> argument is provided then it should contain producers or
data items to be written to the channel.
<dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline">
<td><nobr><b><tt id='l2h-
3783' xml:id='l2h-
3783'
class=
"method">is_empty
</tt></b>(
</nobr></td>
<td><var></var>)
</td></tr></table></dt>
Returns
<code>True
</code> iff the fifo is empty.
<dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline">
<td><nobr><b><tt id='l2h-
3784' xml:id='l2h-
3784'
class=
"method">first
</tt></b>(
</nobr></td>
<td><var></var>)
</td></tr></table></dt>
Returns the least-recently
<tt class=
"method">push()
</tt>ed item from the fifo.
<dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline">
<td><nobr><b><tt id='l2h-
3785' xml:id='l2h-
3785'
class=
"method">push
</tt></b>(
</nobr></td>
<td><var>data
</var>)
</td></tr></table></dt>
Adds the given data (which may be a string or a producer object) to the
<dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline">
<td><nobr><b><tt id='l2h-
3786' xml:id='l2h-
3786'
class=
"method">pop
</tt></b>(
</nobr></td>
<td><var></var>)
</td></tr></table></dt>
If the fifo is not empty, returns
<code>True, first()
</code>, deleting the popped
item. Returns
<code>False, None
</code> for an empty fifo.
The
<tt class=
"module">asynchat
</tt> module also defines one utility function, which may be
of use in network and textual analysis operations.
<dl><dt><table cellpadding=
"0" cellspacing=
"0"><tr valign=
"baseline">
<td><nobr><b><tt id='l2h-
3787' xml:id='l2h-
3787'
class=
"function">find_prefix_at_end
</tt></b>(
</nobr></td>
<td><var>haystack, needle
</var>)
</td></tr></table></dt>
Returns
<code>True
</code> if string
<var>haystack
</var> ends with any non-empty
prefix of string
<var>needle
</var>.
<div class='online-navigation'
>
<table align=
"center" width=
"100%" cellpadding=
"0" cellspacing=
"2">
<td class='online-navigation'
><a rel=
"prev" title=
"11.26 asynchat "
href=
"module-asynchat.html"><img src='../icons/previous.png'
border='
0' height='
32' alt='Previous Page' width='
32'
/></A></td>
<td class='online-navigation'
><a rel=
"parent" title=
"11.26 asynchat "
href=
"module-asynchat.html"><img src='../icons/up.png'
border='
0' height='
32' alt='Up One Level' width='
32'
/></A></td>
<td class='online-navigation'
><a rel=
"next" title=
"11.26.2 asynchat Example"
href=
"asynchat-example.html"><img src='../icons/next.png'
border='
0' height='
32' alt='Next Page' width='
32'
/></A></td>
<td align=
"center" width=
"100%">Python Library Reference
</td>
<td class='online-navigation'
><a rel=
"contents" title=
"Table of Contents"
href=
"contents.html"><img src='../icons/contents.png'
border='
0' height='
32' alt='Contents' width='
32'
/></A></td>
<td class='online-navigation'
><a href=
"modindex.html" title=
"Module Index"><img src='../icons/modules.png'
border='
0' height='
32' alt='Module Index' width='
32'
/></a></td>
<td class='online-navigation'
><a rel=
"index" title=
"Index"
href=
"genindex.html"><img src='../icons/index.png'
border='
0' height='
32' alt='Index' width='
32'
/></A></td>
<div class='online-navigation'
>
<b class=
"navlabel">Previous:
</b>
<a class=
"sectref" rel=
"prev" href=
"module-asynchat.html">11.26 asynchat
</A>
<b class=
"navlabel">Up:
</b>
<a class=
"sectref" rel=
"parent" href=
"module-asynchat.html">11.26 asynchat
</A>
<b class=
"navlabel">Next:
</b>
<a class=
"sectref" rel=
"next" href=
"asynchat-example.html">11.26.2 asynchat Example
</A>
<span class=
"release-info">Release
2.4.2, documentation updated on
28 September
2005.
</span>
<!--End of Navigation Panel-->
See
<i><a href=
"about.html">About this document...
</a></i> for information on suggesting changes.