twisted.words.service.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.words.service</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.words.html">Package words</a> ::
Module service
</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.words.service.html" target="_top">no frames</a>]</font></td></tr>
</table></td>
</tr></table>
<!-- =========== START OF MODULE DESCRIPTION =========== -->
<h2 class="module">Module twisted.words.service</h2>
<p>Twisted Words Service objects. Chat and messaging for Twisted.</p>
<p>Twisted words is a general-purpose chat and instant messaging system
designed to be a suitable replacement both for Instant Messenger systems
and conferencing systems like IRC.</p>
<p>Currently it provides presence notification, web-based account
creation, and a simple group-chat abstraction.</p>
<p>Stability: incendiary</p>
<p>Maintainer: Maintainer: <a
href="mailto:glyph@twistedmatrix.com">Glyph Lefkowitz</a></p>
<p>Future Plans: Woah boy. This module is incredibly unstable. It has an
incredible deficiency of features. There are also several features which
are pretty controvertial. As far as stability goes, it is lucky that the
current interfaces are really simple: at least the uppermost external
ones will almost certainly be preserved, but there is a lot of plumbing
work.</p>
First of all the fact that users must have accounts generated through
a web interface to sign in is a serious annoyance, especially to people
who are familiar with IRC's semantics. The following features are
proposed to mitigate this annoyance:
<ul>
<li>
account creation through the various client interfaces available
to Words users.
</li>
<li>
guest accounts, so that users who join for an hour once don't
pollute the authentication database with huge amounts of cruft.
</li>
<li>
'mood' metadata for users. Since you can't change nicks, you need
a way to do the equivalent thing on IRC where people will sign in
multiple times and have foo_work and foo_home
</li>
</ul>
<p>There is no plan to make it possible to log-in without an account.
This is simply a broken behavior of IRC; all possible convenience
features that mimic this should be integrated, but authentication is an
important part of chat.</p>
There are also certain things that are just missing.
<ul>
<li>
restricted group operations. Typical IRC-style stuff, except you
don't ever see the @. Permimssions should be grantable in a
capability style, rather than with a single bit.
</li>
<li>
server-to-server communication. As much as possible this should be
decentralized and not have the notion of 'hub' servers; rooms have
'physical' locality. This is really hard to integrate with IRC client
protocol stuff, so it may end up that this feature requires a rewrite
of Twisted Words so that servers that present an IRC gateway are
treated as leaf nodes, and the recommended mode of operation is for
the user to run a lightweight proxy locally.
</li>
<li>
a serious logging, monitoring, and routing framework
</li>
</ul>
Then there's a whole bunch of things that would be nice to have.
<ul>
<li>
public key authentication
</li>
<li>
robust wire-level security
</li>
<li>
integrated consensus web authoring tools
</li>
<li>
management tools and guidelines for community leaders
</li>
<li>
interface to operator functionality through 'bot' interface with
per-channel personality configuration
</li>
<li>
graphical extensions to clients to allow formatted text (but
detect obviously annoying or abusive formatting)
</li>
<li>
rate limiting, simple DoS protection, firewall integration
</li>
<li>
basically everything OPN wants to be able to do, but better
</li>
</ul>
<hr/>
<!-- =========== START OF CLASSES =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Classes</th></tr>
<tr><td width="15%">
<b><a href="twisted.words.service.Group.html"><code>Group</code></a></b></td>
<td>This class represents a group of people engaged in a chat session with
one another.</td></tr>
<tr><td width="15%">
<b><a href="twisted.words.service.IWordsClient.html"><code>IWordsClient</code></a></b></td>
<td>A client to a perspective on the twisted.words service.</td></tr>
<tr><td width="15%">
<b><a href="twisted.words.service.IWordsPolicy.html"><code>IWordsPolicy</code></a></b></td>
<td> </td></tr>
<tr><td width="15%">
<b><a href="twisted.words.service.NormalPolicy.html"><code>NormalPolicy</code></a></b></td>
<td> </td></tr>
<tr><td width="15%">
<b><a href="twisted.words.service.Participant.html"><code>Participant</code></a></b></td>
<td> </td></tr>
<tr><td width="15%">
<b><a href="twisted.words.service.Service.html"><code>Service</code></a></b></td>
<td>I am a chat service.</td></tr>
<tr><td width="15%">
<b><a href="twisted.words.service.Transcript.html"><code>Transcript</code></a></b></td>
<td>I am a transcript of a conversation between multiple parties.</td></tr>
<tr><td width="15%">
<b><a href="twisted.words.service.WordsClient.html"><code>WordsClient</code></a></b></td>
<td> </td></tr>
</table><br />
<!-- =========== START OF EXCEPTIONS =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Exceptions</th></tr>
<tr><td width="15%">
<b><a href="twisted.words.service.NotInCollectionError.html"><code>NotInCollectionError</code></a></b></td>
<td> </td></tr>
<tr><td width="15%">
<b><a href="twisted.words.service.NotInGroupError.html"><code>NotInGroupError</code></a></b></td>
<td> </td></tr>
<tr><td width="15%">
<b><a href="twisted.words.service.UserNonexistantError.html"><code>UserNonexistantError</code></a></b></td>
<td> </td></tr>
<tr><td width="15%">
<b><a href="twisted.words.service.WordsError.html"><code>WordsError</code></a></b></td>
<td> </td></tr>
<tr><td width="15%">
<b><a href="twisted.words.service.WrongStatusError.html"><code>WrongStatusError</code></a></b></td>
<td> </td></tr>
</table><br />
<!-- =========== START OF VARIABLE SUMMARY =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Variable Summary</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td>
<td><b><a href="twisted.words.service.html#AWAY"><code>AWAY</code></a></b> = <span title="2">2 </span></td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td>
<td><b><a href="twisted.words.service.html#OFFLINE"><code>OFFLINE</code></a></b> = <span title="0">0 </span></td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td>
<td><b><a href="twisted.words.service.html#ONLINE"><code>ONLINE</code></a></b> = <span title="1">1 </span></td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>list</code></font></td>
<td><b><a href="twisted.words.service.html#statuses"><code>statuses</code></a></b> = <span title="['Offline', 'Online', 'Away']"><code>['Offline', 'Online', 'Away'] </code>
</span></td></tr>
</table><br />
<!-- =========== START OF VARIABLE DETAILS =========== -->
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="details">
<th colspan="2">Variable Details</th></tr>
</table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="AWAY"></a>
<h3>AWAY</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>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="OFFLINE"></a>
<h3>OFFLINE</h3>
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>int</code>
</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="ONLINE"></a>
<h3>ONLINE</h3>
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>int</code>
</dd>
<span title="1"> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
1 </pre>
</td></tr></table></dd>
</span> </dl>
</dd>
</dl></td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="statuses"></a>
<h3>statuses</h3>
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>list</code>
</dd>
<span title="['Offline', 'Online', 'Away']"> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
['Offline', 'Online', 'Away'] </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:19 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>