twisted.protocols.toc.TOCClient.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.TOCClient</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 TOCClient
</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.TOCClient.html" target="_top">no frames</a>]</font></td></tr>
</table></td>
</tr></table>
<!-- =========== START OF CLASS DESCRIPTION =========== -->
<h2 class="class">Class TOCClient</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>TOCClient</b>
</pre><br />
<dl><dt><b>Known Subclasses:</b></dt>
<dd>
<a href="twisted.im.tocsupport.TOCProto.html"><code>TOCProto</code></a></dd></dl>
<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="__init__"></a><span class="summary-sig"><span class="summary-sig-name">__init__</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>username</span>,
<span class=summary-sig-arg>password</span>,
<span class=summary-sig-arg>authhost</span>,
<span class=summary-sig-arg>authport</span>)</span></code>
</td></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="add_buddy"></a><span class="summary-sig"><span class="summary-sig-name">add_buddy</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>buddies</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="add_deny"></a><span class="summary-sig"><span class="summary-sig-name">add_deny</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>users</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="add_permit"></a><span class="summary-sig"><span class="summary-sig-name">add_permit</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>users</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.TOCClient.html#away" class="summary-sig-name"><code>away</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>message</span>)</span></code>
<br />
change away state message := the message, or '' to come back from
awayness</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.TOCClient.html#chat_accept" class="summary-sig-name"><code>chat_accept</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>roomid</span>)</span></code>
<br />
accept an invite to a chat room roomid := the AIM id for 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.TOCClient.html#chat_invite" class="summary-sig-name"><code>chat_invite</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>roomid</span>,
<span class=summary-sig-arg>usernames</span>,
<span class=summary-sig-arg>message</span>)</span></code>
<br />
invite a user[s] to the chat room roomid := the AIM id for the room
usernames := either a string (one username) or a list (more than one)
message := the message to invite them with</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.TOCClient.html#chat_join" class="summary-sig-name"><code>chat_join</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>exchange</span>,
<span class=summary-sig-arg>roomname</span>)</span></code>
<br />
join a chat room exchange := should almost always be 4 roomname :=
room name</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.TOCClient.html#chat_leave" class="summary-sig-name"><code>chat_leave</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>roomid</span>)</span></code>
<br />
leave a 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.TOCClient.html#chat_say" class="summary-sig-name"><code>chat_say</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>roomid</span>,
<span class=summary-sig-arg>message</span>)</span></code>
<br />
send a message to a chatroom roomid := the AIM id for the room message
:= the message to send</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.TOCClient.html#chat_whisper" class="summary-sig-name"><code>chat_whisper</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>roomid</span>,
<span class=summary-sig-arg>user</span>,
<span class=summary-sig-arg>message</span>)</span></code>
<br />
whisper to another user in a chatroom roomid := the AIM id for the
room user := the user to whisper to message := the message to send</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.TOCClient.html#chatHearMessage" class="summary-sig-name"><code>chatHearMessage</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>roomid</span>,
<span class=summary-sig-arg>username</span>,
<span class=summary-sig-arg>message</span>)</span></code>
<br />
a message was sent to the room roomid := the AIM id for the room
username := the user who sent the message message := the 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.TOCClient.html#chatHearWhisper" class="summary-sig-name"><code>chatHearWhisper</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>roomid</span>,
<span class=summary-sig-arg>username</span>,
<span class=summary-sig-arg>message</span>)</span></code>
<br />
someone whispered to us in a chatroom roomid := the AIM for the room
username := the user who whispered to us message := the 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.TOCClient.html#chatInvited" class="summary-sig-name"><code>chatInvited</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>roomid</span>,
<span class=summary-sig-arg>roomname</span>,
<span class=summary-sig-arg>username</span>,
<span class=summary-sig-arg>message</span>)</span></code>
<br />
we were invited to a chat room roomid := the AIM id for the room
roomname := the name of the room username := the user who invited us
message := the invite 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.TOCClient.html#chatJoined" class="summary-sig-name"><code>chatJoined</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>roomid</span>,
<span class=summary-sig-arg>roomname</span>,
<span class=summary-sig-arg>users</span>)</span></code>
<br />
we just joined a chat room roomid := the AIM id for the room roomname
:= the name for the room users := a list of the users already in 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.TOCClient.html#chatLeft" class="summary-sig-name"><code>chatLeft</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>roomid</span>)</span></code>
<br />
we left the room roomid := the AIM id for 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.TOCClient.html#chatUpdate" class="summary-sig-name"><code>chatUpdate</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>roomid</span>,
<span class=summary-sig-arg>username</span>,
<span class=summary-sig-arg>inroom</span>)</span></code>
<br />
a user has joined the room roomid := the AIM id for the room username
:= the username inroom := true if the user is in the room</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.TOCClient.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.TOCClient.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="del_buddy"></a><span class="summary-sig"><span class="summary-sig-name">del_buddy</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>buddies</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="del_deny"></a><span class="summary-sig"><span class="summary-sig-name">del_deny</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>users</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="del_permit"></a><span class="summary-sig"><span class="summary-sig-name">del_permit</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>users</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.TOCClient.html#evil" class="summary-sig-name"><code>evil</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>user</span>,
<span class=summary-sig-arg>anon</span>)</span></code>
<br />
warn a user user := the user to warn anon := if true, an anonymous
warning</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.TOCClient.html#gotConfig" class="summary-sig-name"><code>gotConfig</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>mode</span>,
<span class=summary-sig-arg>buddylist</span>,
<span class=summary-sig-arg>permit</span>,
<span class=summary-sig-arg>deny</span>)</span></code>
<br />
called when we get a configuration from the server mode := permit/deny
mode buddylist := current buddylist permit := permit list deny := 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.TOCClient.html#hearError" class="summary-sig-name"><code>hearError</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>code</span>,
<span class=summary-sig-arg>args</span>)</span></code>
<br />
called when an error is received code := error code args := misc.</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.TOCClient.html#hearMessage" class="summary-sig-name"><code>hearMessage</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>username</span>,
<span class=summary-sig-arg>message</span>,
<span class=summary-sig-arg>autoreply</span>)</span></code>
<br />
called when you receive an IM username := the user who the IM is from
message := the message autoreply := true if the message is an autoreply
from an 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.TOCClient.html#hearWarning" class="summary-sig-name"><code>hearWarning</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>newamount</span>,
<span class=summary-sig-arg>username</span>)</span></code>
<br />
called when we get warned newamount := the current warning level
username := the user who warned us, or '' if it's anonymous</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.TOCClient.html#idle" class="summary-sig-name"><code>idle</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>idletime</span>)</span></code>
<br />
change idle state idletime := the seconds that the user has been away,
or 0 if they're back</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.TOCClient.html#isaway" class="summary-sig-name"><code>isaway</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
return our away status</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.TOCClient.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="modeData"></a><span class="summary-sig"><span class="summary-sig-name">modeData</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>flap</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="modeSendNick"></a><span class="summary-sig"><span class="summary-sig-name">modeSendNick</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>flap</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.TOCClient.html#onLine" class="summary-sig-name"><code>onLine</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
called when we are first online</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="readFlap"></a><span class="summary-sig"><span class="summary-sig-name">readFlap</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.TOCClient.html#receiveBytes" class="summary-sig-name"><code>receiveBytes</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>user</span>,
<span class=summary-sig-arg>file</span>,
<span class=summary-sig-arg>chunk</span>,
<span class=summary-sig-arg>sofar</span>,
<span class=summary-sig-arg>total</span>)</span></code>
<br />
we received part of a file from a file transfer file := the name of
the file chunk := the chunk of data sofar := how much data we've gotten
so far total := the total amount of data</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="rvous_accept"></a><span class="summary-sig"><span class="summary-sig-name">rvous_accept</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>cookie</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="rvous_cancel"></a><span class="summary-sig"><span class="summary-sig-name">rvous_cancel</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>cookie</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.TOCClient.html#rvousProposal" class="summary-sig-name"><code>rvousProposal</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>type</span>,
<span class=summary-sig-arg>cookie</span>,
<span class=summary-sig-arg>user</span>,
<span class=summary-sig-arg>vip</span>,
<span class=summary-sig-arg>port</span>,
<span class="summary-sig-kwarg">**kw</span>)</span></code>
<br />
we were asked for a rondevouz type := the type of rondevous.</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.TOCClient.html#say" class="summary-sig-name"><code>say</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>user</span>,
<span class=summary-sig-arg>message</span>,
<span class=summary-sig-arg>autoreply</span>)</span></code>
<br />
send a message user := the user to send to message := the message
autoreply := true if the message is an autoreply (good for away
messages)</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="sendFlap"></a><span class="summary-sig"><span class="summary-sig-name">sendFlap</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>type</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.TOCClient.html#set_config" class="summary-sig-name"><code>set_config</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>mode</span>,
<span class=summary-sig-arg>buddylist</span>,
<span class=summary-sig-arg>permit</span>,
<span class=summary-sig-arg>deny</span>)</span></code>
<br />
set the server configuration mode := permit mode buddylist := buddy
list permit := permit list deny := 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.TOCClient.html#signon" class="summary-sig-name"><code>signon</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
called to finish the setup, and signon to the network</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.TOCClient.html#tocCHAT_IN" class="summary-sig-name"><code>tocCHAT_IN</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>data</span>)</span></code>
<br />
CHAT_IN:<room id>:<username>:<whisper
T/F>:<message> whisper isn't used</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.TOCClient.html#tocCHAT_INVITE" class="summary-sig-name"><code>tocCHAT_INVITE</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>data</span>)</span></code>
<br />
CHAT_INVITE:<room name>:<room
id>:<username>:<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.TOCClient.html#tocCHAT_JOIN" class="summary-sig-name"><code>tocCHAT_JOIN</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>data</span>)</span></code>
<br />
CHAT_JOIN:<room id>:<room name></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.TOCClient.html#tocCHAT_LEFT" class="summary-sig-name"><code>tocCHAT_LEFT</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>data</span>)</span></code>
<br />
CHAT_LEFT:<room id></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.TOCClient.html#tocCHAT_UPDATE_BUDDY" class="summary-sig-name"><code>tocCHAT_UPDATE_BUDDY</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>data</span>)</span></code>
<br />
CHAT_UPDATE_BUDDY:<room id>:<in room? T/F>:<user
1>:<user 2>...</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.TOCClient.html#tocCONFIG" class="summary-sig-name"><code>tocCONFIG</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>data</span>)</span></code>
<br />
CONFIG:<config> format of config data:</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.TOCClient.html#tocERROR" class="summary-sig-name"><code>tocERROR</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>data</span>)</span></code>
<br />
ERROR:<error code>:<misc.</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.TOCClient.html#tocEVILED" class="summary-sig-name"><code>tocEVILED</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>data</span>)</span></code>
<br />
EVILED:<current warning level>:<user who warned us></td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="tocGET_FILE"></a><span class="summary-sig"><span class="summary-sig-name">tocGET_FILE</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>user</span>,
<span class=summary-sig-arg>cookie</span>,
<span class=summary-sig-arg>seq</span>,
<span class=summary-sig-arg>pip</span>,
<span class=summary-sig-arg>vip</span>,
<span class=summary-sig-arg>port</span>,
<span class=summary-sig-arg>tlvs</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.TOCClient.html#tocIM_IN" class="summary-sig-name"><code>tocIM_IN</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>data</span>)</span></code>
<br />
IM_IN:<user>:<autoreply T|F>: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.TOCClient.html#tocNICK" class="summary-sig-name"><code>tocNICK</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>data</span>)</span></code>
<br />
NICK:<format of 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.TOCClient.html#tocRVOUS_PROPOSE" class="summary-sig-name"><code>tocRVOUS_PROPOSE</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>data</span>)</span></code>
<br />
RVOUS_PROPOSE:<user>:<uuid>:<cookie>:<seq>:<rip>:<pip>:<vip>:<port>...</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="tocSEND_FILE"></a><span class="summary-sig"><span class="summary-sig-name">tocSEND_FILE</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>user</span>,
<span class=summary-sig-arg>cookie</span>,
<span class=summary-sig-arg>seq</span>,
<span class=summary-sig-arg>pip</span>,
<span class=summary-sig-arg>vip</span>,
<span class=summary-sig-arg>port</span>,
<span class=summary-sig-arg>tlvs</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="tocSIGN_ON"></a><span class="summary-sig"><span class="summary-sig-name">tocSIGN_ON</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="tocUNKNOWN"></a><span class="summary-sig"><span class="summary-sig-name">tocUNKNOWN</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>command</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.TOCClient.html#tocUPDATE_BUDDY" class="summary-sig-name"><code>tocUPDATE_BUDDY</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>data</span>)</span></code>
<br />
UPDATE_BUDDY:<username>:<online T|F>:<warning
level>:<signon time>:<idle time (minutes)>:<user
class></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.TOCClient.html#updateBuddy" class="summary-sig-name"><code>updateBuddy</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>username</span>,
<span class=summary-sig-arg>online</span>,
<span class=summary-sig-arg>evilness</span>,
<span class=summary-sig-arg>signontime</span>,
<span class=summary-sig-arg>idletime</span>,
<span class=summary-sig-arg>userclass</span>,
<span class=summary-sig-arg>away</span>)</span></code>
<br />
called when a buddy changes state username := the user whos state
changed online := true if the user is online evilness := the users
current warning level signontime := the time the user signed on (UNIX
epoch) idletime := the time the user has been idle (minutes) away := true
if the user is away userclass := the class of the user (generally "
O")</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 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="away"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">away</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>message</span>=<span class=sig-default>''</span>)</span>
</h3>
change away state message := the message, or '' to come back from
awayness
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="chat_accept"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">chat_accept</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>roomid</span>)</span>
</h3>
accept an invite to a chat room roomid := the AIM id for the
room
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="chat_invite"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">chat_invite</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>roomid</span>,
<span class=sig-arg>usernames</span>,
<span class=sig-arg>message</span>)</span>
</h3>
invite a user[s] to the chat room roomid := the AIM id for the room
usernames := either a string (one username) or a list (more than one)
message := the message to invite them with
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="chat_join"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">chat_join</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>exchange</span>,
<span class=sig-arg>roomname</span>)</span>
</h3>
join a chat room exchange := should almost always be 4 roomname :=
room name
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="chat_leave"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">chat_leave</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>roomid</span>)</span>
</h3>
leave a chat room. roomid := the AIM id for the room
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="chat_say"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">chat_say</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>roomid</span>,
<span class=sig-arg>message</span>)</span>
</h3>
send a message to a chatroom roomid := the AIM id for the room
message := the message to send
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="chat_whisper"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">chat_whisper</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>roomid</span>,
<span class=sig-arg>user</span>,
<span class=sig-arg>message</span>)</span>
</h3>
whisper to another user in a chatroom roomid := the AIM id for the
room user := the user to whisper to message := the message to send
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="chatHearMessage"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">chatHearMessage</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>roomid</span>,
<span class=sig-arg>username</span>,
<span class=sig-arg>message</span>)</span>
</h3>
a message was sent to the room roomid := the AIM id for the room
username := the user who sent the message message := the message
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="chatHearWhisper"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">chatHearWhisper</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>roomid</span>,
<span class=sig-arg>username</span>,
<span class=sig-arg>message</span>)</span>
</h3>
someone whispered to us in a chatroom roomid := the AIM for the room
username := the user who whispered to us message := the message
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="chatInvited"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">chatInvited</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>roomid</span>,
<span class=sig-arg>roomname</span>,
<span class=sig-arg>username</span>,
<span class=sig-arg>message</span>)</span>
</h3>
we were invited to a chat room roomid := the AIM id for the room
roomname := the name of the room username := the user who invited us
message := the invite message
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="chatJoined"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">chatJoined</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>roomid</span>,
<span class=sig-arg>roomname</span>,
<span class=sig-arg>users</span>)</span>
</h3>
we just joined a chat room roomid := the AIM id for the room
roomname := the name for the room users := a list of the users already
in the room
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="chatLeft"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">chatLeft</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>roomid</span>)</span>
</h3>
we left the room roomid := the AIM id for the room
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="chatUpdate"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">chatUpdate</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>roomid</span>,
<span class=sig-arg>username</span>,
<span class=sig-arg>inroom</span>)</span>
</h3>
a user has joined the room roomid := the AIM id for the room
username := the username inroom := true if the user is in the room
<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="evil"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">evil</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>user</span>,
<span class=sig-arg>anon</span>=<span class=sig-default>0</span>)</span>
</h3>
warn a user user := the user to warn anon := if true, an anonymous
warning
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="gotConfig"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">gotConfig</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>mode</span>,
<span class=sig-arg>buddylist</span>,
<span class=sig-arg>permit</span>,
<span class=sig-arg>deny</span>)</span>
</h3>
called when we get a configuration from the server mode :=
permit/deny mode buddylist := current buddylist permit := permit list
deny := deny list
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="hearError"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">hearError</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>code</span>,
<span class=sig-arg>args</span>)</span>
</h3>
called when an error is received code := error code args := misc.
arguments (username, etc.)
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="hearMessage"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">hearMessage</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>username</span>,
<span class=sig-arg>message</span>,
<span class=sig-arg>autoreply</span>)</span>
</h3>
called when you receive an IM username := the user who the IM is
from message := the message autoreply := true if the message is an
autoreply from an away message
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="hearWarning"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">hearWarning</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>newamount</span>,
<span class=sig-arg>username</span>)</span>
</h3>
called when we get warned newamount := the current warning level
username := the user who warned us, or '' if it's anonymous
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="idle"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">idle</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>idletime</span>=<span class=sig-default>0</span>)</span>
</h3>
change idle state idletime := the seconds that the user has been
away, or 0 if they're back
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="isaway"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">isaway</span>(<span class=sig-arg>self</span>)</span>
</h3>
return our away status
<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="onLine"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">onLine</span>(<span class=sig-arg>self</span>)</span>
</h3>
called when we are first online
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="receiveBytes"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">receiveBytes</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>user</span>,
<span class=sig-arg>file</span>,
<span class=sig-arg>chunk</span>,
<span class=sig-arg>sofar</span>,
<span class=sig-arg>total</span>)</span>
</h3>
we received part of a file from a file transfer file := the name of
the file chunk := the chunk of data sofar := how much data we've gotten
so far total := the total amount of data
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="rvousProposal"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">rvousProposal</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>type</span>,
<span class=sig-arg>cookie</span>,
<span class=sig-arg>user</span>,
<span class=sig-arg>vip</span>,
<span class=sig-arg>port</span>,
<span class="sig-kwarg">**kw</span>)</span>
</h3>
we were asked for a rondevouz type := the type of rondevous.
currently, one of ["send"] cookie := the cookie. pass this to
rvous_accept() user := the user who asked us vip := their verified_ip
port := the port they want us to conenct to kw := misc. args
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="say"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">say</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>user</span>,
<span class=sig-arg>message</span>,
<span class=sig-arg>autoreply</span>=<span class=sig-default>0</span>)</span>
</h3>
send a message user := the user to send to message := the message
autoreply := true if the message is an autoreply (good for away
messages)
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="set_config"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">set_config</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>mode</span>,
<span class=sig-arg>buddylist</span>,
<span class=sig-arg>permit</span>,
<span class=sig-arg>deny</span>)</span>
</h3>
set the server configuration mode := permit mode buddylist := buddy
list permit := permit list deny := deny list
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="signon"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">signon</span>(<span class=sig-arg>self</span>)</span>
</h3>
called to finish the setup, and signon to the network
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="tocCHAT_IN"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">tocCHAT_IN</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>data</span>)</span>
</h3>
CHAT_IN:<room id>:<username>:<whisper
T/F>:<message> whisper isn't used
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="tocCHAT_INVITE"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">tocCHAT_INVITE</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>data</span>)</span>
</h3>
CHAT_INVITE:<room name>:<room
id>:<username>:<message>
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="tocCHAT_JOIN"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">tocCHAT_JOIN</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>data</span>)</span>
</h3>
CHAT_JOIN:<room id>:<room name>
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="tocCHAT_LEFT"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">tocCHAT_LEFT</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>data</span>)</span>
</h3>
CHAT_LEFT:<room id>
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="tocCHAT_UPDATE_BUDDY"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">tocCHAT_UPDATE_BUDDY</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>data</span>)</span>
</h3>
CHAT_UPDATE_BUDDY:<room id>:<in room? T/F>:<user
1>:<user 2>...
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="tocCONFIG"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">tocCONFIG</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>data</span>)</span>
</h3>
CONFIG:<config> format of config data:
<ul>
<li>
g: group. all users until next g or end of config are in this
group
</li>
<li>
b: buddy
</li>
<li>
p: person on the permit list
</li>
<li>
d: person on the deny list
</li>
<li>
m: permit/deny mode (1: permit all, 2: deny all, 3: permit some,
4: deny some)
</li>
</ul>
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="tocERROR"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">tocERROR</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>data</span>)</span>
</h3>
ERROR:<error code>:<misc. data>
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="tocEVILED"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">tocEVILED</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>data</span>)</span>
</h3>
EVILED:<current warning level>:<user who warned us>
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="tocIM_IN"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">tocIM_IN</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>data</span>)</span>
</h3>
IM_IN:<user>:<autoreply T|F>:message
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="tocNICK"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">tocNICK</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>data</span>)</span>
</h3>
NICK:<format of nickname>
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="tocRVOUS_PROPOSE"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">tocRVOUS_PROPOSE</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>data</span>)</span>
</h3>
<pre class="literalblock">
RVOUS_PROPOSE:<user>:<uuid>:<cookie>:<seq>:<rip>:<pip>:<vip>:<port>
[:tlv tag1:tlv value1[:tlv tag2:tlv value2[:...]]]
</pre>
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="tocUPDATE_BUDDY"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">tocUPDATE_BUDDY</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>data</span>)</span>
</h3>
UPDATE_BUDDY:<username>:<online T|F>:<warning
level>:<signon time>:<idle time (minutes)>:<user
class>
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="updateBuddy"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">updateBuddy</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>username</span>,
<span class=sig-arg>online</span>,
<span class=sig-arg>evilness</span>,
<span class=sig-arg>signontime</span>,
<span class=sig-arg>idletime</span>,
<span class=sig-arg>userclass</span>,
<span class=sig-arg>away</span>)</span>
</h3>
called when a buddy changes state username := the user whos state
changed online := true if the user is online evilness := the users
current warning level signontime := the time the user signed on (UNIX
epoch) idletime := the time the user has been idle (minutes) away :=
true if the user is away userclass := the class of the user (generally
" O")
<dl><dt></dt><dd>
</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:30 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>