1
<?xml version="1.0" encoding="iso-8859-1"?>
2
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3
"DTD/xhtml1-transitional.dtd">
4
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
6
<title>twisted.protocols.oscar.ChatService</title>
7
<link rel="stylesheet" href="epydoc.css" type="text/css"></link>
9
<body bgcolor="white" text="black" link="blue" vlink="#204080"
12
<!-- =========== START OF NAVBAR =========== -->
13
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
15
<th class="navbar"> <a class="navbar" href="twisted.html">Home</a> </th>
16
<th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>
17
<th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
18
<th class="navbar"> <a class="navbar" href="help.html">Help</a> </th>
19
<th class="navbar" align="right" width="100%">
20
<table border="0" cellpadding="0" cellspacing="0">
21
<tr><th class="navbar" align="center">
23
<a class="navbar" target="_top" href="http://twistedmatrix.com/">Twisted 1.3.0rc1</a>
24
</p></th></tr></table>
28
<table width="100%" cellpadding="0" cellspacing="0">
31
<font size="-1"><b class="breadcrumbs">
32
<a href="twisted.html">Package twisted</a> ::
33
<a href="twisted.protocols.html">Package protocols</a> ::
34
<a href="twisted.protocols.oscar.html">Module oscar</a> ::
35
Class ChatService
38
<td><table cellpadding="0" cellspacing="0">
39
<tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="twisted.protocols.oscar.ChatService.html" target="_top">no frames</a>]</font></td></tr>
43
<!-- =========== START OF CLASS DESCRIPTION =========== -->
44
<h2 class="class">Class ChatService</h2>
46
<pre class="base-tree">
47
<a href="twisted.internet.protocol.BaseProtocol.html"><code>BaseProtocol</code></a> --+
49
<a href="twisted.internet.protocol.Protocol.html"><code>Protocol</code></a> --+
51
<a href="twisted.protocols.oscar.OscarConnection.html"><code>OscarConnection</code></a> --+
53
<a href="twisted.protocols.oscar.SNACBased.html"><code>SNACBased</code></a> --+
55
<a href="twisted.protocols.oscar.OSCARService.html"><code>OSCARService</code></a> --+
63
<!-- =========== START OF METHOD SUMMARY =========== -->
64
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
65
<tr bgcolor="#70b0f0" class="summary">
66
<th colspan="2">Method Summary</th></tr>
67
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
68
<td><code><a name="__init__"></a><span class="summary-sig"><span class="summary-sig-name">__init__</span>(<span class=summary-sig-arg>self</span>,
69
<span class=summary-sig-arg>bos</span>,
70
<span class=summary-sig-arg>cookie</span>,
71
<span class=summary-sig-arg>d</span>)</span></code>
73
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
74
<td><code><span class="summary-sig"><a href="twisted.protocols.oscar.ChatService.html#clientReady" class="summary-sig-name"><code>clientReady</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
76
called when the client is ready to be online</td></tr>
77
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
78
<td><code><a name="leaveChat"></a><span class="summary-sig"><span class="summary-sig-name">leaveChat</span>(<span class=summary-sig-arg>self</span>)</span></code>
80
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
81
<td><code><a name="oscar_01_07"></a><span class="summary-sig"><span class="summary-sig-name">oscar_01_07</span>(<span class=summary-sig-arg>self</span>,
82
<span class=summary-sig-arg>snac</span>)</span></code>
84
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
85
<td><code><a name="oscar_0E_02"></a><span class="summary-sig"><span class="summary-sig-name">oscar_0E_02</span>(<span class=summary-sig-arg>self</span>,
86
<span class=summary-sig-arg>snac</span>)</span></code>
88
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
89
<td><code><a name="oscar_0E_03"></a><span class="summary-sig"><span class="summary-sig-name">oscar_0E_03</span>(<span class=summary-sig-arg>self</span>,
90
<span class=summary-sig-arg>snac</span>)</span></code>
92
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
93
<td><code><a name="oscar_0E_04"></a><span class="summary-sig"><span class="summary-sig-name">oscar_0E_04</span>(<span class=summary-sig-arg>self</span>,
94
<span class=summary-sig-arg>snac</span>)</span></code>
96
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
97
<td><code><a name="oscar_0E_06"></a><span class="summary-sig"><span class="summary-sig-name">oscar_0E_06</span>(<span class=summary-sig-arg>self</span>,
98
<span class=summary-sig-arg>snac</span>)</span></code>
100
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
101
<td><code><a name="sendMessage"></a><span class="summary-sig"><span class="summary-sig-name">sendMessage</span>(<span class=summary-sig-arg>self</span>,
102
<span class=summary-sig-arg>message</span>)</span></code>
104
<tr bgcolor="#e8f0f8" class="group">
105
<th colspan="2"> Inherited from OSCARService</th></tr>
106
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
107
<td><code><span class="summary-sig"><a href="twisted.protocols.oscar.OSCARService.html#connectionLost" class="summary-sig-name"><code>connectionLost</code></a>(<span class=summary-sig-arg>self</span>,
108
<span class=summary-sig-arg>reason</span>)</span></code>
110
<tr bgcolor="#e8f0f8" class="group">
111
<th colspan="2"> Inherited from SNACBased</th></tr>
112
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
113
<td><code><span class="summary-sig"><a href="twisted.protocols.oscar.SNACBased.html#_ebDeferredError" class="summary-sig-name"><code>_ebDeferredError</code></a>(<span class=summary-sig-arg>self</span>,
114
<span class=summary-sig-arg>error</span>,
115
<span class=summary-sig-arg>fam</span>,
116
<span class=summary-sig-arg>sub</span>,
117
<span class=summary-sig-arg>data</span>)</span></code>
119
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
120
<td><code><span class="summary-sig"><a href="twisted.protocols.oscar.SNACBased.html#oscar_" class="summary-sig-name"><code>oscar_</code></a>(<span class=summary-sig-arg>self</span>,
121
<span class=summary-sig-arg>data</span>)</span></code>
123
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
124
<td><code><span class="summary-sig"><a href="twisted.protocols.oscar.SNACBased.html#oscar_01_03" class="summary-sig-name"><code>oscar_01_03</code></a>(<span class=summary-sig-arg>self</span>,
125
<span class=summary-sig-arg>snac</span>)</span></code>
127
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
128
<td><code><span class="summary-sig"><a href="twisted.protocols.oscar.SNACBased.html#oscar_01_0A" class="summary-sig-name"><code>oscar_01_0A</code></a>(<span class=summary-sig-arg>self</span>,
129
<span class=summary-sig-arg>snac</span>)</span></code>
131
change of rate information.</td></tr>
132
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
133
<td><code><span class="summary-sig"><a href="twisted.protocols.oscar.SNACBased.html#oscar_01_18" class="summary-sig-name"><code>oscar_01_18</code></a>(<span class=summary-sig-arg>self</span>,
134
<span class=summary-sig-arg>snac</span>)</span></code>
136
host versions, in the same format as we sent</td></tr>
137
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
138
<td><code><span class="summary-sig"><a href="twisted.protocols.oscar.SNACBased.html#oscar_Data" class="summary-sig-name"><code>oscar_Data</code></a>(<span class=summary-sig-arg>self</span>,
139
<span class=summary-sig-arg>data</span>)</span></code>
141
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
142
<td><code><span class="summary-sig"><a href="twisted.protocols.oscar.SNACBased.html#oscar_unknown" class="summary-sig-name"><code>oscar_unknown</code></a>(<span class=summary-sig-arg>self</span>,
143
<span class=summary-sig-arg>snac</span>)</span></code>
145
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
146
<td><code><span class="summary-sig"><a href="twisted.protocols.oscar.SNACBased.html#sendSNAC" class="summary-sig-name"><code>sendSNAC</code></a>(<span class=summary-sig-arg>self</span>,
147
<span class=summary-sig-arg>fam</span>,
148
<span class=summary-sig-arg>sub</span>,
149
<span class=summary-sig-arg>data</span>,
150
<span class=summary-sig-arg>flags</span>)</span></code>
152
send a snac and wait for the response by returning a Deferred.</td></tr>
153
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
154
<td><code><span class="summary-sig"><a href="twisted.protocols.oscar.SNACBased.html#sendSNACnr" class="summary-sig-name"><code>sendSNACnr</code></a>(<span class=summary-sig-arg>self</span>,
155
<span class=summary-sig-arg>fam</span>,
156
<span class=summary-sig-arg>sub</span>,
157
<span class=summary-sig-arg>data</span>,
158
<span class=summary-sig-arg>flags</span>)</span></code>
160
send a snac, but don't bother adding a deferred, we don't care.</td></tr>
161
<tr bgcolor="#e8f0f8" class="group">
162
<th colspan="2"> Inherited from OscarConnection</th></tr>
163
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
164
<td><code><span class="summary-sig"><a href="twisted.protocols.oscar.OscarConnection.html#connectionMade" class="summary-sig-name"><code>connectionMade</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
166
Called when a connection is made.</td></tr>
167
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
168
<td><code><span class="summary-sig"><a href="twisted.protocols.oscar.OscarConnection.html#dataReceived" class="summary-sig-name"><code>dataReceived</code></a>(<span class=summary-sig-arg>self</span>,
169
<span class=summary-sig-arg>data</span>)</span></code>
171
Called whenever data is received.</td></tr>
172
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
173
<td><code><span class="summary-sig"><a href="twisted.protocols.oscar.OscarConnection.html#disconnect" class="summary-sig-name"><code>disconnect</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
175
send the disconnect flap, and sever the connection</td></tr>
176
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
177
<td><code><span class="summary-sig"><a href="twisted.protocols.oscar.OscarConnection.html#readFlap" class="summary-sig-name"><code>readFlap</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
179
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
180
<td><code><span class="summary-sig"><a href="twisted.protocols.oscar.OscarConnection.html#sendFLAP" class="summary-sig-name"><code>sendFLAP</code></a>(<span class=summary-sig-arg>self</span>,
181
<span class=summary-sig-arg>data</span>,
182
<span class=summary-sig-arg>channel</span>)</span></code>
184
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
185
<td><code><span class="summary-sig"><a href="twisted.protocols.oscar.OscarConnection.html#sendKeepAlive" class="summary-sig-name"><code>sendKeepAlive</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
187
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
188
<td><code><span class="summary-sig"><a href="twisted.protocols.oscar.OscarConnection.html#setKeepAlive" class="summary-sig-name"><code>setKeepAlive</code></a>(<span class=summary-sig-arg>self</span>,
189
<span class=summary-sig-arg>t</span>)</span></code>
191
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
192
<td><code><span class="summary-sig"><a href="twisted.protocols.oscar.OscarConnection.html#stopKeepAlive" class="summary-sig-name"><code>stopKeepAlive</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
194
<tr bgcolor="#e8f0f8" class="group">
195
<th colspan="2"> Inherited from Protocol</th></tr>
196
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
197
<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>
199
(Deprecated)</td></tr>
200
<tr bgcolor="#e8f0f8" class="group">
201
<th colspan="2"> Inherited from BaseProtocol</th></tr>
202
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
203
<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>,
204
<span class=summary-sig-arg>transport</span>)</span></code>
206
Make a connection to a transport and a server.</td></tr>
210
<!-- =========== START OF CLASS VARIABLE SUMMARY =========== -->
211
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
212
<tr bgcolor="#70b0f0" class="summary">
213
<th colspan="2">Class Variable Summary</th></tr>
214
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>dict</code></font></td>
215
<td><b><a href="twisted.protocols.oscar.ChatService.html#snacFamilies"><code>snacFamilies</code></a></b> = <span title="{1: (3, 16, 1435), 14: (1, 16, 1435)}"><code>{1: (3, 16, 1435), 14: (1, 16, 1435)} </code>
217
<tr bgcolor="#e8f0f8" class="group">
218
<th colspan="2"> Inherited from Protocol</th></tr>
219
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>tuple</code></font></td>
220
<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>
222
<tr bgcolor="#e8f0f8" class="group">
223
<th colspan="2"> Inherited from BaseProtocol</th></tr>
224
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td>
225
<td><b><a href="twisted.internet.protocol.BaseProtocol.html#connected"><code>connected</code></a></b> = <span title="0">0 </span></td></tr>
226
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>NoneType</code></font></td>
227
<td><b><a href="twisted.internet.protocol.BaseProtocol.html#transport"><code>transport</code></a></b> = <span title="None">None </span></td></tr>
231
<!-- =========== START OF METHOD DETAILS =========== -->
232
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
233
<tr bgcolor="#70b0f0" class="details">
234
<th colspan="2">Method Details</th></tr>
237
<a name="clientReady"></a>
238
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
239
<h3><span class="sig"><span class="sig-name">clientReady</span>(<span class=sig-arg>self</span>)</span>
241
called when the client is ready to be online
248
<!-- =========== START OF CLASS VARIABLE DETAILS =========== -->
249
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
250
<tr bgcolor="#70b0f0" class="details">
251
<th colspan="2">Class Variable Details</th></tr>
253
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
254
<a name="snacFamilies"></a>
255
<h3>snacFamilies</h3>
260
<dt><b>Type:</b></dt>
265
<span title="{1: (3, 16, 1435), 14: (1, 16, 1435)}"> <dt><b>Value:</b></dt>
267
<pre class="variable">
268
{1: (3, 16, 1435), 14: (1, 16, 1435)} </pre>
269
</td></tr></table></dd>
272
</dl></td></tr></table>
276
<!-- =========== START OF NAVBAR =========== -->
277
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
279
<th class="navbar"> <a class="navbar" href="twisted.html">Home</a> </th>
280
<th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>
281
<th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
282
<th class="navbar"> <a class="navbar" href="help.html">Help</a> </th>
283
<th class="navbar" align="right" width="100%">
284
<table border="0" cellpadding="0" cellspacing="0">
285
<tr><th class="navbar" align="center">
287
<a class="navbar" target="_top" href="http://twistedmatrix.com/">Twisted 1.3.0rc1</a>
288
</p></th></tr></table>
293
<table border="0" cellpadding="0" cellspacing="0" width="100%">
295
<td align="left"><font size="-2">Generated by Epydoc 2.0 on Sat May 15 20:08:20 2004</font></td>
296
<td align="right"><a href="http://epydoc.sourceforge.net"
297
><font size="-2">http://epydoc.sf.net</font></a></td>