~soren/nova/iptables-security-groups

<?xml version="1.0" encoding="utf-8"?><!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Transitional//EN' 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd'><html lang="en" xmlns="http://www.w3.org/1999/xhtml">

<head>

<title>Twisted Documentation: Overview of Twisted IM</title>

</head>

<h1 class="title">Overview of Twisted IM</h1>

<div class="toc"><ol><li><a href="#auto0">Code flow</a></li><ul><li><a href="#auto1">AccountManager</a></li><li><a href="#auto2">ChatUI</a></li><li><a href="#auto3">Conversation and GroupConversation</a></li><li><a href="#auto4">Accounts</a></li></ul></ol></div>

<span/>

<div class="note"><strong>Note: </strong>Twisted IM and Twisted Words are both known to be in a state

of flux at the moment. Several of the APIs discussed here have fallen short of

their original goals and <em>will</em> be changing within the next few releases

of Twisted. The good news is that newer versions will be based on our

experiences with the current ones and will provide much more access to features

beyond plain-text chat message relaying in different protocols.</div>

<p>Twisted IM (Instance Messenger) is a multi-protocol chat

framework, based on the Twisted framework we've all come to know

and love. It's fairly simple and extensible in two directions -

it's pretty easy to add new protocols, and it's also quite easy

to add new front-ends.</p>

<p>Twisted IM is usually started from the file

<code>twisted/scripts/im.py</code> (maybe with a shell-script

wrapper or similar). Twisted currently comes with two

interfaces for Twisted IM - one written in GTK for Python

under Linux, and one written in Swing for Jython.

<code>im.py</code> picks an implementation and starts it - if

you want to write your own interface, you can modify

<code>im.py</code> to start it under appropriate

conditions.</p>

<p>Once started, both interfaces behave in a very similar

fashion, so I won't be getting into differences here.</p>

<h3>AccountManager<a name="auto1"/></h3>

<p>Control flow starts at the relevant subclass of <code class="API"><a href="http://twistedmatrix.com/documents/10.0.0/api/twisted.im.baseaccount.AccountManager.html" title="twisted.im.baseaccount.AccountManager">baseaccount.AccountManager</a></code>.

The AccountManager is responsible for, well, managing accounts

- remembering what accounts are available, their

settings, adding and removal of accounts, and making accounts

log on at startup.</p>

<p>This would be a good place to start your interface, load a

list of accounts from disk and tell them to login. Most of the

method names in <code class="API"><a href="http://twistedmatrix.com/documents/10.0.0/api/twisted.im.baseaccount.AccountManager.html" title="twisted.im.baseaccount.AccountManager">AccountManager</a></code>

are pretty self-explanatory, and your subclass can override

whatever it wants, but you <em>need</em> to override <code class="python">__init__</code>. Something like

this:</p>

<pre class="python"><p class="py-linenumber">1

</p><span class="py-src-keyword">def</span> <span class="py-src-identifier">__init__</span>(<span class="py-src-parameter">self</span>):

<span class="py-src-variable">self</span>.<span class="py-src-variable">chatui</span> = ... <span class="py-src-comment"># Your subclass of basechat.ChatUI</span>

<span class="py-src-variable">self</span>.<span class="py-src-variable">accounts</span> = ... <span class="py-src-comment"># Load account list</span>

<span class="py-src-keyword">for</span> <span class="py-src-variable">a</span> <span class="py-src-keyword">in</span> <span class="py-src-variable">self</span>.<span class="py-src-variable">accounts</span>:

<span class="py-src-variable">a</span>.<span class="py-src-variable">logOn</span>(<span class="py-src-variable">self</span>.<span class="py-src-variable">chatui</span>)

</pre>

<h3>ChatUI<a name="auto2"/></h3>

<p>Account objects talk to the user via a subclass of <code class="API"><a href="http://twistedmatrix.com/documents/10.0.0/api/twisted.im.basechat.ChatUI.html" title="twisted.im.basechat.ChatUI">basechat.ChatUI</a></code>.

This class keeps track of all the various conversations that

are currently active, so that when an account receives and

incoming message, it can put that message in its correct

context.</p>

<p>How much of this class you need to override depends on what

you need to do. You will need to override

<code>getConversation</code> (a one-on-one conversation, like

an IRC DCC chat) and <code>getGroupConversation</code> (a

multiple user conversation, like an IRC channel). You might

want to override <code>getGroup</code> and

<code>getPerson</code>.</p>

<p>The main problem with the default versions of the above

routines is that they take a parameter, <code>Class</code>,

which defaults to an abstract implementation of that class -

for example, <code>getConversation</code> has a

<code>Class</code> parameter that defaults to <code class="API"><a href="http://twistedmatrix.com/documents/10.0.0/api/twisted.im.basechat.Conversation.html" title="twisted.im.basechat.Conversation">basechat.Conversation</a></code> which

raises a lot of <code>NotImplementedError</code>s. In your

subclass, override the method with a new method whose Class

parameter defaults to your own implementation of

<code>Conversation</code>, that simply calls the parent

class' implementation.</p>

<h3>Conversation and GroupConversation<a name="auto3"/></h3>

<p>These classes are where your interface meets the chat

protocol. Chat protocols get a message, find the appropriate

<code>Conversation</code> or <code>GroupConversation</code>

object, and call its methods when various interesting things

happen.</p>

<p>Override whatever methods you want to get the information

100

you want to display. You must override the <code>hide</code>

101

and <code>show</code> methods, however - they are called

102

frequently and the default implementation raises

103

<code>NotImplementedError</code>.</p>

104

105

<h3>Accounts<a name="auto4"/></h3>

106

<p>An account is an instance of a subclass of <code class="API"><a href="http://twistedmatrix.com/documents/10.0.0/api/twisted.im.basesupport.AbstractAccount.html" title="twisted.im.basesupport.AbstractAccount">basesupport.AbstractAccount</a></code>.

107

For more details and sample code, see the various

108

<code>*support</code> files in <code>twisted.im</code>.</p>

109

110

</div>

111

112

<p><a href="index.html">Index</a></p>

113

<span class="version">Version: 10.0.0</span>

114

</body>

115

</html>

b'\\ No newline at end of file'

Older »