twisted.im.basesupport.AbstractAccount.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.im.basesupport.AbstractAccount</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.im.html">Package im</a> ::
<a href="twisted.im.basesupport.html">Module basesupport</a> ::
Class AbstractAccount
</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.im.basesupport.AbstractAccount.html" target="_top">no frames</a>]</font></td></tr>
</table></td>
</tr></table>
<!-- =========== START OF CLASS DESCRIPTION =========== -->
<h2 class="class">Class AbstractAccount</h2>
<pre class="base-tree">
<a href="twisted.persisted.styles.Versioned.html"><code>Versioned</code></a> --+
|
<b>AbstractAccount</b>
</pre><br />
<dl><dt><b>Known Subclasses:</b></dt>
<dd>
<a href="twisted.im.ircsupport.IRCAccount.html"><code>IRCAccount</code></a>,
<a href="twisted.im.pbsupport.PBAccount.html"><code>PBAccount</code></a>,
<a href="twisted.im.tocsupport.TOCAccount.html"><code>TOCAccount</code></a></dd></dl>
<hr/>
<p>Base class for Accounts.</p>
I am the start of an implementation of <a
href="twisted.im.interfaces.IAccount.html"
class="link"><code>IAccount</code></a>, I implement <a
href="twisted.im.basesupport.AbstractAccount.html#isOnline"
class="link"><code>isOnline</code></a> and most of <a
href="twisted.im.basesupport.AbstractAccount.html#logOn"
class="link"><code>logOn</code></a>, though you'll need to implement <a
href="twisted.im.basesupport.AbstractAccount.html#_startLogOn"
class="link"><code>_startLogOn</code></a> in a subclass.
<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>accountName</span>,
<span class=summary-sig-arg>autoLogin</span>,
<span class=summary-sig-arg>username</span>,
<span class=summary-sig-arg>password</span>,
<span class=summary-sig-arg>host</span>,
<span class=summary-sig-arg>port</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="__getstate__"></a><span class="summary-sig"><span class="summary-sig-name">__getstate__</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="__repr__"></a><span class="summary-sig"><span class="summary-sig-name">__repr__</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="_cb_logOn"></a><span class="summary-sig"><span class="summary-sig-name">_cb_logOn</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>client</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="_clientLost"></a><span class="summary-sig"><span class="summary-sig-name">_clientLost</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>client</span>,
<span class=summary-sig-arg>reason</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> Failure
</font></td>
<td><code><span class="summary-sig"><a href="twisted.im.basesupport.AbstractAccount.html#_loginFailed" class="summary-sig-name"><code>_loginFailed</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>reason</span>)</span></code>
<br />
Errorback for <a
href="twisted.im.basesupport.AbstractAccount.html#logOn"
class="link"><code>logOn</code></a>.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> Deferred <a href="twisted.im.interfaces.IClient.html"
class="link"><code>interfaces.IClient</code></a>
</font></td>
<td><code><span class="summary-sig"><a href="twisted.im.basesupport.AbstractAccount.html#_startLogOn" class="summary-sig-name"><code>_startLogOn</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>chatui</span>)</span></code>
<br />
Start the sign on process.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.im.basesupport.AbstractAccount.html#getGroup" class="summary-sig-name"><code>getGroup</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>name</span>)</span></code>
<br />
Group factory.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.im.basesupport.AbstractAccount.html#getPerson" class="summary-sig-name"><code>getPerson</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>name</span>)</span></code>
<br />
Person factory.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="isOnline"></a><span class="summary-sig"><span class="summary-sig-name">isOnline</span>(<span class=summary-sig-arg>self</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> Deferred <a href="twisted.im.interfaces.IClient.html"
class="link"><code>interfaces.IClient</code></a>
</font></td>
<td><code><span class="summary-sig"><a href="twisted.im.basesupport.AbstractAccount.html#logOn" class="summary-sig-name"><code>logOn</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>chatui</span>)</span></code>
<br />
Log on to this account.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="upgrateToVersion2"></a><span class="summary-sig"><span class="summary-sig-name">upgrateToVersion2</span>(<span class=summary-sig-arg>self</span>)</span></code>
</td></tr>
<tr bgcolor="#e8f0f8" class="group">
<th colspan="2"> Inherited from Versioned</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.persisted.styles.Versioned.html#__setstate__" class="summary-sig-name"><code>__setstate__</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>state</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.persisted.styles.Versioned.html#versionUpgrade" class="summary-sig-name"><code>versionUpgrade</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
(internal) Do a version upgrade.</td></tr>
</table><br />
<!-- =========== START OF INSTANCE VARIABLE SUMMARY =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Instance Variable Summary</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">boolean</font></td>
<td><b><a href="twisted.im.basesupport.AbstractAccount.html#_isConnecting"><code>_isConnecting</code></a></b>: Whether I am in the process of establishing a connection to the
server.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">boolean</font></td>
<td><b><a href="twisted.im.basesupport.AbstractAccount.html#_isOnline"><code>_isOnline</code></a></b>: Whether I am currently on-line with the server.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><b><a href="twisted.im.basesupport.AbstractAccount.html#accountName"><code>accountName</code></a></b>: </td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><b><a href="twisted.im.basesupport.AbstractAccount.html#autoLogin"><code>autoLogin</code></a></b>: </td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><b><a href="twisted.im.basesupport.AbstractAccount.html#host"><code>host</code></a></b>: </td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><b><a href="twisted.im.basesupport.AbstractAccount.html#password"><code>password</code></a></b>: </td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><b><a href="twisted.im.basesupport.AbstractAccount.html#port"><code>port</code></a></b>: </td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><b><a href="twisted.im.basesupport.AbstractAccount.html#username"><code>username</code></a></b>: </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>class</code></font></td>
<td><a name="_groupFactory"></a><b><code>_groupFactory</code></b> = <a href="twisted.im.basesupport.AbstractGroup.html"><code>twisted.im.basesupport.AbstractGroup</code></a></td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>class</code></font></td>
<td><a name="_personFactory"></a><b><code>_personFactory</code></b> = <a href="twisted.im.basesupport.AbstractPerson.html"><code>twisted.im.basesupport.AbstractPerson</code></a></td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>NoneType</code></font></td>
<td><b><a href="twisted.im.basesupport.AbstractAccount.html#client"><code>client</code></a></b> = <span title="None">None </span></td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td>
<td><b><a href="twisted.im.basesupport.AbstractAccount.html#persistanceVersion"><code>persistanceVersion</code></a></b> = <span title="2">2 </span></td></tr>
<tr bgcolor="#e8f0f8" class="group">
<th colspan="2"> Inherited from Versioned</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>tuple</code></font></td>
<td><b><a href="twisted.persisted.styles.Versioned.html#persistenceForgets"><code>persistenceForgets</code></a></b> = <span title="()"><code>() </code>
</span></td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td>
<td><b><a href="twisted.persisted.styles.Versioned.html#persistenceVersion"><code>persistenceVersion</code></a></b> = <span title="0">0 </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="_loginFailed"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">_loginFailed</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>reason</span>)</span>
</h3>
Errorback for <a
href="twisted.im.basesupport.AbstractAccount.html#logOn"
class="link"><code>logOn</code></a>.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>reason</b></code>
<br /><i>
(type=Failure)</i>
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
<i>reason</i>, for further processing in the callback
chain.
<br /><i>
(type=Failure)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="_startLogOn"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">_startLogOn</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>chatui</span>)</span>
</h3>
<p>Start the sign on process.</p>
Factored out of <a
href="twisted.im.basesupport.AbstractAccount.html#logOn"
class="link"><code>logOn</code></a>.
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
Deferred <a href="twisted.im.interfaces.IClient.html"
class="link"><code>interfaces.IClient</code></a>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="getGroup"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">getGroup</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>name</span>)</span>
</h3>
Group factory.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>name</b></code> -
Name of the group on this account.
<br /><i>
(type=string)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="getPerson"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">getPerson</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>name</span>)</span>
</h3>
Person factory.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>name</b></code> -
Name of the person on this account.
<br /><i>
(type=string)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="logOn"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">logOn</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>chatui</span>)</span>
</h3>
<p>Log on to this account.</p>
Takes care to not start a connection if a connection is already in
progress. You will need to implement <a
href="twisted.im.basesupport.AbstractAccount.html#_startLogOn"
class="link"><code>_startLogOn</code></a> for this to work, and it
would be a good idea to override <a
href="twisted.im.basesupport.AbstractAccount.html#_loginFailed"
class="link"><code>_loginFailed</code></a> too.
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
Deferred <a href="twisted.im.interfaces.IClient.html"
class="link"><code>interfaces.IClient</code></a>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<br />
<!-- =========== START OF INSTANCE VARIABLE DETAILS =========== -->
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="details">
<th colspan="2">Instance Variable Details</th></tr>
</table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="_isConnecting"></a>
<h3>_isConnecting</h3>
Whether I am in the process of establishing a connection to the
server.
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
boolean
</dd>
<span title="0"> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
0 </pre>
</td></tr></table></dd>
</span> </dl>
</dd>
</dl></td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="_isOnline"></a>
<h3>_isOnline</h3>
Whether I am currently on-line with the server.
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
boolean
</dd>
<span title="0"> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
0 </pre>
</td></tr></table></dd>
</span> </dl>
</dd>
</dl></td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="accountName"></a>
<h3>accountName</h3>
</td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="autoLogin"></a>
<h3>autoLogin</h3>
</td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="host"></a>
<h3>host</h3>
</td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="password"></a>
<h3>password</h3>
</td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="port"></a>
<h3>port</h3>
</td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="username"></a>
<h3>username</h3>
</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="client"></a>
<h3>client</h3>
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>NoneType</code>
</dd>
<span title="None"> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
None </pre>
</td></tr></table></dd>
</span> </dl>
</dd>
</dl></td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="persistanceVersion"></a>
<h3>persistanceVersion</h3>
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>int</code>
</dd>
<span title="2"> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
2 </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:16 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>