twisted.protocols.toc.TOC.html [plain text]
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>twisted.protocols.toc.TOC</title>
<link rel="stylesheet" href="epydoc.css" type="text/css"></link>
</head>
<body bgcolor="white" text="black" link="blue" vlink="#204080"
alink="#204080">
<!-- =========== START OF NAVBAR =========== -->
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
<tr valign="center">
<th class="navbar"> <a class="navbar" href="twisted.html">Home</a> </th>
<th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>
<th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
<th class="navbar"> <a class="navbar" href="help.html">Help</a> </th>
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center">
<p class="nomargin">
<a class="navbar" target="_top" href="http://twistedmatrix.com/">Twisted 1.3.0rc1</a>
</p></th></tr></table>
</th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<font size="-1"><b class="breadcrumbs">
<a href="twisted.html">Package twisted</a> ::
<a href="twisted.protocols.html">Package protocols</a> ::
<a href="twisted.protocols.toc.html">Module toc</a> ::
Class TOC
</b></font></br>
</td>
<td><table cellpadding="0" cellspacing="0">
<tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="twisted.protocols.toc.TOC.html" target="_top">no frames</a>]</font></td></tr>
</table></td>
</tr></table>
<!-- =========== START OF CLASS DESCRIPTION =========== -->
<h2 class="class">Class TOC</h2>
<pre class="base-tree">
<a href="twisted.internet.protocol.BaseProtocol.html"><code>BaseProtocol</code></a> --+
|
<a href="twisted.internet.protocol.Protocol.html"><code>Protocol</code></a> --+
|
<b>TOC</b>
</pre><br />
<hr/>
<!-- =========== START OF METHOD SUMMARY =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Method Summary</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="_debug"></a><span class="summary-sig"><span class="summary-sig-name">_debug</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>data</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="authorize"></a><span class="summary-sig"><span class="summary-sig-name">authorize</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>server</span>,
<span class=summary-sig-arg>port</span>,
<span class=summary-sig-arg>username</span>,
<span class=summary-sig-arg>password</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.protocols.toc.TOC.html#buddyUpdate" class="summary-sig-name"><code>buddyUpdate</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>user</span>)</span></code>
<br />
Update the buddy.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="canContact"></a><span class="summary-sig"><span class="summary-sig-name">canContact</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>user</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="chatInvite"></a><span class="summary-sig"><span class="summary-sig-name">chatInvite</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>room</span>,
<span class=summary-sig-arg>user</span>,
<span class=summary-sig-arg>message</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="chatJoin"></a><span class="summary-sig"><span class="summary-sig-name">chatJoin</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>room</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="chatLeave"></a><span class="summary-sig"><span class="summary-sig-name">chatLeave</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>room</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="chatMessage"></a><span class="summary-sig"><span class="summary-sig-name">chatMessage</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>room</span>,
<span class=summary-sig-arg>user</span>,
<span class=summary-sig-arg>message</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="chatUserUpdate"></a><span class="summary-sig"><span class="summary-sig-name">chatUserUpdate</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>room</span>,
<span class=summary-sig-arg>user</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="chatWhisper"></a><span class="summary-sig"><span class="summary-sig-name">chatWhisper</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>room</span>,
<span class=summary-sig-arg>user</span>,
<span class=summary-sig-arg>message</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="connectionLost"></a><span class="summary-sig"><span class="summary-sig-name">connectionLost</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>reason</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.protocols.toc.TOC.html#connectionMade" class="summary-sig-name"><code>connectionMade</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Called when a connection is made.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.protocols.toc.TOC.html#dataReceived" class="summary-sig-name"><code>dataReceived</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>data</span>)</span></code>
<br />
Called whenever data is received.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="evilFrom"></a><span class="summary-sig"><span class="summary-sig-name">evilFrom</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>user</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="getStatus"></a><span class="summary-sig"><span class="summary-sig-name">getStatus</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>user</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.protocols.toc.TOC.html#hearWhisper" class="summary-sig-name"><code>hearWhisper</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>user</span>,
<span class=summary-sig-arg>data</span>,
<span class=summary-sig-arg>auto</span>)</span></code>
<br />
Called when you get an IM.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.protocols.toc.TOC.html#isFlap" class="summary-sig-name"><code>isFlap</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
tests to see if a flap is actually on the buffer</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="modeConnected"></a><span class="summary-sig"><span class="summary-sig-name">modeConnected</span>(<span class=summary-sig-arg>self</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="modeFlapon"></a><span class="summary-sig"><span class="summary-sig-name">modeFlapon</span>(<span class=summary-sig-arg>self</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="modeSignon"></a><span class="summary-sig"><span class="summary-sig-name">modeSignon</span>(<span class=summary-sig-arg>self</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="modeTocSignon"></a><span class="summary-sig"><span class="summary-sig-name">modeTocSignon</span>(<span class=summary-sig-arg>self</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.protocols.toc.TOC.html#readFlap" class="summary-sig-name"><code>readFlap</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
read the first FLAP off self._buf, raising errors if it isn't in the
right form.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.protocols.toc.TOC.html#sendError" class="summary-sig-name"><code>sendError</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>code</span>,
<span class="summary-sig-vararg">*varargs</span>)</span></code>
<br />
send an error to the user.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.protocols.toc.TOC.html#sendFlap" class="summary-sig-name"><code>sendFlap</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>type</span>,
<span class=summary-sig-arg>data</span>)</span></code>
<br />
send a FLAP to the client</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.protocols.toc.TOC.html#toc_add_buddy" class="summary-sig-name"><code>toc_add_buddy</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>data</span>)</span></code>
<br />
adds users to the buddy list</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.protocols.toc.TOC.html#toc_add_deny" class="summary-sig-name"><code>toc_add_deny</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>data</span>)</span></code>
<br />
adds users to the deny list.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.protocols.toc.TOC.html#toc_add_permit" class="summary-sig-name"><code>toc_add_permit</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>data</span>)</span></code>
<br />
adds users to the permit list.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="toc_change_passwd"></a><span class="summary-sig"><span class="summary-sig-name">toc_change_passwd</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>data</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.protocols.toc.TOC.html#toc_chat_accept" class="summary-sig-name"><code>toc_chat_accept</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>data</span>)</span></code>
<br />
accept an invitation.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.protocols.toc.TOC.html#toc_chat_invite" class="summary-sig-name"><code>toc_chat_invite</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>data</span>)</span></code>
<br />
invite others to the room.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.protocols.toc.TOC.html#toc_chat_join" class="summary-sig-name"><code>toc_chat_join</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>data</span>)</span></code>
<br />
joins the chat room.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.protocols.toc.TOC.html#toc_chat_leave" class="summary-sig-name"><code>toc_chat_leave</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>data</span>)</span></code>
<br />
leave the room.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.protocols.toc.TOC.html#toc_chat_send" class="summary-sig-name"><code>toc_chat_send</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>data</span>)</span></code>
<br />
send a message to the chat room.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="toc_chat_whisper"></a><span class="summary-sig"><span class="summary-sig-name">toc_chat_whisper</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>data</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.protocols.toc.TOC.html#toc_evil" class="summary-sig-name"><code>toc_evil</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>data</span>)</span></code>
<br />
warns a user.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.protocols.toc.TOC.html#toc_format_nickname" class="summary-sig-name"><code>toc_format_nickname</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>data</span>)</span></code>
<br />
change the format of your nickname.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.protocols.toc.TOC.html#toc_get_info" class="summary-sig-name"><code>toc_get_info</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>data</span>)</span></code>
<br />
get the user info for a user</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.protocols.toc.TOC.html#toc_init_done" class="summary-sig-name"><code>toc_init_done</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>data</span>)</span></code>
<br />
called when all the setup is done.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.protocols.toc.TOC.html#toc_remove_buddy" class="summary-sig-name"><code>toc_remove_buddy</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>data</span>)</span></code>
<br />
removes users from the buddy list</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.protocols.toc.TOC.html#toc_send_im" class="summary-sig-name"><code>toc_send_im</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>data</span>)</span></code>
<br />
incoming instant message</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.protocols.toc.TOC.html#toc_set_away" class="summary-sig-name"><code>toc_set_away</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>data</span>)</span></code>
<br />
set/unset away message</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.protocols.toc.TOC.html#toc_set_config" class="summary-sig-name"><code>toc_set_config</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>data</span>)</span></code>
<br />
set the saved config.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.protocols.toc.TOC.html#toc_set_idle" class="summary-sig-name"><code>toc_set_idle</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>data</span>)</span></code>
<br />
set/unset idle</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.protocols.toc.TOC.html#toc_set_info" class="summary-sig-name"><code>toc_set_info</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>data</span>)</span></code>
<br />
set the users information, retrivable with toc_get_info</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="toc_unknown"></a><span class="summary-sig"><span class="summary-sig-name">toc_unknown</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>tocname</span>,
<span class=summary-sig-arg>data</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.protocols.toc.TOC.html#updateUsers" class="summary-sig-name"><code>updateUsers</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Update the users who have us on their buddylist.</td></tr>
<tr bgcolor="#e8f0f8" class="group">
<th colspan="2"> Inherited from Protocol</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.internet.protocol.Protocol.html#connectionFailed" class="summary-sig-name"><code>connectionFailed</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
(Deprecated)</td></tr>
<tr bgcolor="#e8f0f8" class="group">
<th colspan="2"> Inherited from BaseProtocol</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.internet.protocol.BaseProtocol.html#makeConnection" class="summary-sig-name"><code>makeConnection</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>transport</span>)</span></code>
<br />
Make a connection to a transport and a server.</td></tr>
</table><br />
<!-- =========== START OF CLASS VARIABLE SUMMARY =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Class Variable Summary</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>dict</code></font></td>
<td><b><a href="twisted.protocols.toc.TOC.html#users"><code>users</code></a></b> = <span title="{}"><code>{} </code>
</span></td></tr>
<tr bgcolor="#e8f0f8" class="group">
<th colspan="2"> Inherited from Protocol</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>tuple</code></font></td>
<td><b><a href="twisted.internet.protocol.Protocol.html#__implements__"><code>__implements__</code></a></b> = <span title="(<class twisted.internet.interfaces.IProtocol at 0x8278f0c>,)"><code>(<class twisted.internet.interfaces.IPr<span class="variable-ellipsis">...</span></code>
</span></td></tr>
<tr bgcolor="#e8f0f8" class="group">
<th colspan="2"> Inherited from BaseProtocol</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td>
<td><b><a href="twisted.internet.protocol.BaseProtocol.html#connected"><code>connected</code></a></b> = <span title="0">0 </span></td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>NoneType</code></font></td>
<td><b><a href="twisted.internet.protocol.BaseProtocol.html#transport"><code>transport</code></a></b> = <span title="None">None </span></td></tr>
</table><br />
<!-- =========== START OF METHOD DETAILS =========== -->
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="details">
<th colspan="2">Method Details</th></tr>
</table>
<a name="buddyUpdate"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">buddyUpdate</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>user</span>)</span>
</h3>
Update the buddy. Called from updateUsers()
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="connectionMade"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">connectionMade</span>(<span class=sig-arg>self</span>)</span>
</h3>
<p>Called when a connection is made.</p>
This may be considered the initializer of the protocol, because it
is called when the connection is completed. For clients, this is called
once the connection to the server has been established; for servers,
this is called after an accept() call stops blocking and a socket has
been received. If you need to send any greeting or initial message, do
it here.
<dl><dt></dt><dd>
<dl><dt><b>Overrides:</b></dt>
<dd><a href="twisted.internet.protocol.BaseProtocol.html#connectionMade"><code>twisted.internet.protocol.BaseProtocol.connectionMade</code></a> <i>(inherited documentation)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="dataReceived"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">dataReceived</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>data</span>)</span>
</h3>
<p>Called whenever data is received.</p>
Use this method to translate to a higher-level message. Usually,
some callback will be made upon the receipt of each complete protocol
message.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>data</b></code> -
a string of indeterminate length. Please keep in mind that you
will probably need to buffer some data, as partial (or multiple)
protocol messages may be received! I recommend that unit tests
for protocols call through to this method with differing chunk
sizes, down to one byte at a time.
</dd>
</dl>
<dl><dt><b>Overrides:</b></dt>
<dd><a href="twisted.internet.protocol.Protocol.html#dataReceived"><code>twisted.internet.protocol.Protocol.dataReceived</code></a> <i>(inherited documentation)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="hearWhisper"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">hearWhisper</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>user</span>,
<span class=sig-arg>data</span>,
<span class=sig-arg>auto</span>=<span class=sig-default>0</span>)</span>
</h3>
Called when you get an IM. If auto=1, it's an autoreply from an away
message.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="isFlap"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">isFlap</span>(<span class=sig-arg>self</span>)</span>
</h3>
tests to see if a flap is actually on the buffer
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="readFlap"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">readFlap</span>(<span class=sig-arg>self</span>)</span>
</h3>
read the first FLAP off self._buf, raising errors if it isn't in the
right form. the FLAP is the basic TOC message format, and is logically
equivilant to a packet in TCP
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="sendError"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">sendError</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>code</span>,
<span class="sig-vararg">*varargs</span>)</span>
</h3>
send an error to the user. listing of error messages is below.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="sendFlap"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">sendFlap</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>type</span>,
<span class=sig-arg>data</span>)</span>
</h3>
send a FLAP to the client
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="toc_add_buddy"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">toc_add_buddy</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>data</span>)</span>
</h3>
<p>adds users to the buddy list</p>
toc_add_buddy <buddyname1> [<buddyname2>]
[<buddyname3>]...
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="toc_add_deny"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">toc_add_deny</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>data</span>)</span>
</h3>
adds users to the deny list. if the list is null, then set the mode
to PERMITALL
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="toc_add_permit"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">toc_add_permit</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>data</span>)</span>
</h3>
adds users to the permit list. if the list is null, then set the
mode to DENYALL
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="toc_chat_accept"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">toc_chat_accept</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>data</span>)</span>
</h3>
<p>accept an invitation.</p>
toc_chat_accept <room id>
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="toc_chat_invite"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">toc_chat_invite</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>data</span>)</span>
</h3>
<p>invite others to the room.</p>
toc_chat_invite <room id> <invite message> <buddy
1> [<buddy2>]...
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="toc_chat_join"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">toc_chat_join</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>data</span>)</span>
</h3>
<p>joins the chat room.</p>
toc_chat_join <exchange> <room name>
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="toc_chat_leave"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">toc_chat_leave</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>data</span>)</span>
</h3>
<p>leave the room.</p>
toc_chat_leave <room id>
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="toc_chat_send"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">toc_chat_send</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>data</span>)</span>
</h3>
<p>send a message to the chat room.</p>
toc_chat_send <room id> <message>
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="toc_evil"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">toc_evil</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>data</span>)</span>
</h3>
<p>warns a user.</p>
toc_evil <username> <anon|norm>
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="toc_format_nickname"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">toc_format_nickname</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>data</span>)</span>
</h3>
<p>change the format of your nickname.</p>
toc_format_nickname <new format>
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="toc_get_info"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">toc_get_info</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>data</span>)</span>
</h3>
<p>get the user info for a user</p>
toc_get_info <username>
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="toc_init_done"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">toc_init_done</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>data</span>)</span>
</h3>
<p>called when all the setup is done.</p>
toc_init_done
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="toc_remove_buddy"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">toc_remove_buddy</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>data</span>)</span>
</h3>
<p>removes users from the buddy list</p>
toc_remove_buddy <buddyname1> [<buddyname2>]
[<buddyname3>]...
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="toc_send_im"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">toc_send_im</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>data</span>)</span>
</h3>
<p>incoming instant message</p>
toc_send_im <screenname> <quoted message> [auto]
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="toc_set_away"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">toc_set_away</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>data</span>)</span>
</h3>
<p>set/unset away message</p>
toc_set_away [<away message>]
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="toc_set_config"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">toc_set_config</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>data</span>)</span>
</h3>
<p>set the saved config. this gets send when you log in.</p>
toc_set_config <config>
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="toc_set_idle"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">toc_set_idle</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>data</span>)</span>
</h3>
<p>set/unset idle</p>
toc_set_idle <seconds>
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="toc_set_info"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">toc_set_info</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>data</span>)</span>
</h3>
<p>set the users information, retrivable with toc_get_info</p>
toc_set_info <user info (quoted)>
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="updateUsers"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">updateUsers</span>(<span class=sig-arg>self</span>)</span>
</h3>
Update the users who have us on their buddylist. Called when the
user changes anything (idle,away) so people can get updates.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<br />
<!-- =========== START OF CLASS VARIABLE DETAILS =========== -->
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="details">
<th colspan="2">Class Variable Details</th></tr>
</table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="users"></a>
<h3>users</h3>
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>dict</code>
</dd>
<span title="{}"> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
{} </pre>
</td></tr></table></dd>
</span> </dl>
</dd>
</dl></td></tr></table>
<br />
<!-- =========== START OF NAVBAR =========== -->
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
<tr valign="center">
<th class="navbar"> <a class="navbar" href="twisted.html">Home</a> </th>
<th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>
<th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
<th class="navbar"> <a class="navbar" href="help.html">Help</a> </th>
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center">
<p class="nomargin">
<a class="navbar" target="_top" href="http://twistedmatrix.com/">Twisted 1.3.0rc1</a>
</p></th></tr></table>
</th>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td align="left"><font size="-2">Generated by Epydoc 2.0 on Sat May 15 20:08:45 2004</font></td>
<td align="right"><a href="http://epydoc.sourceforge.net"
><font size="-2">http://epydoc.sf.net</font></a></td>
</tr>
</table>
</body>
</html>