1
<?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">
3
<title>Twisted Documentation: Twisted Glossary</title>
4
<link href="stylesheet.css" rel="stylesheet" type="text/css"/>
8
<h1 class="title">Twisted Glossary</h1>
9
<div class="toc"><ol/></div>
15
<dt><a name="adaptee" shape="rect">adaptee</a></dt>
17
An object that has been adapted, also called <q>original</q>. See <a href="#Adapter" shape="rect">Adapter</a>.
20
<dt><a name="Adapter" shape="rect"><code class="API" noexpand="1"><a href="http://twistedmatrix.com/documents/10.0.0/api/twisted.python.components.Adapter.html" title="twisted.python.components.Adapter">Adapter</a></code></a></dt>
22
An object whose sole purpose is to implement an Interface for another object.
23
See <a href="components.html" shape="rect">Interfaces and Adapters</a>.
26
<dt><a name="Application" shape="rect"><code class="API" noexpand="1"><a href="http://twistedmatrix.com/documents/10.0.0/api/twisted.application.service.Application.html" title="twisted.application.service.Application">Application</a></code></a></dt>
28
A <code class="API"><a href="http://twistedmatrix.com/documents/10.0.0/api/twisted.application.service.Application.html" title="twisted.application.service.Application">twisted.application.service.Application</a></code>. There are
29
HOWTOs on <a href="basics.html" shape="rect">creating and manipulating</a> them as a
30
system-administrator, as well as <a href="application.html" shape="rect">using</a> them in
34
<dt><a name="Avatar" shape="rect">Avatar</a></dt>
36
(from <a href="#Cred" shape="rect">Twisted Cred</a>) business logic for specific user.
37
For example, in <a href="#PB" shape="rect">PB</a> these are perspectives, in pop3 these
38
are mailboxes, and so on.
41
<dt><a name="Banana" shape="rect"><code class="API" noexpand="1"><a href="http://twistedmatrix.com/documents/10.0.0/api/twisted.spread.banana.Banana.html" title="twisted.spread.banana.Banana">Banana</a></code></a></dt>
43
The low-level data marshalling layer of <a href="#Spread" shape="rect">Twisted Spread</a>.
44
See <code class="API"><a href="http://twistedmatrix.com/documents/10.0.0/api/twisted.spread.banana.html" title="twisted.spread.banana">twisted.spread.banana</a></code>.
47
<dt><a name="Broker" shape="rect"><code class="API" noexpand="1"><a href="http://twistedmatrix.com/documents/10.0.0/api/twisted.spread.pb.Broker.html" title="twisted.spread.pb.Broker">Broker</a></code></a></dt>
49
A <code class="API"><a href="http://twistedmatrix.com/documents/10.0.0/api/twisted.spread.pb.Broker.html" title="twisted.spread.pb.Broker">twisted.spread.pb.Broker</a></code>, the object request
50
broker for <a href="#Spread" shape="rect">Twisted Spread</a>.
53
<dt><a name="cache" shape="rect">cache</a></dt>
55
A way to store data in readily accessible place for later reuse. Caching data
56
is often done because the data is expensive to produce or access. Caching data
57
risks being stale, or out of sync with the original data.
60
<dt><a name="component" shape="rect">component</a></dt>
62
A special kind of (persistent) <code class="API"><a href="http://twistedmatrix.com/documents/10.0.0/api/twisted.python.components.Adapter.html" title="twisted.python.components.Adapter">Adapter</a></code> that works with a <code class="API"><a href="http://twistedmatrix.com/documents/10.0.0/api/twisted.python.components.Componentized.html" title="twisted.python.components.Componentized">twisted.python.components.Componentized</a></code>. See also <a href="components.html" shape="rect">Interfaces and Adapters</a>.
65
<dt><a name="Componentized" shape="rect"><code class="API" noexpand="1"><a href="http://twistedmatrix.com/documents/10.0.0/api/twisted.python.components.Componentized.html" title="twisted.python.components.Componentized">Componentized</a></code></a></dt>
67
A Componentized object is a collection of information, separated
68
into domain-specific or role-specific instances, that all stick
69
together and refer to each other.
70
Each object is an <code class="API"><a href="http://twistedmatrix.com/documents/10.0.0/api/twisted.python.components.Adapter.html" title="twisted.python.components.Adapter">Adapter</a></code>, which, in the
71
context of Componentized, we call <q>components</q>. See also <a href="components.html" shape="rect">Interfaces and Adapters</a>.
74
<dt><a name="conch" shape="rect"><code class="API" noexpand="1"><a href="http://twistedmatrix.com/documents/10.0.0/api/twisted.conch.html" title="twisted.conch">conch</a></code></a></dt>
75
<dd>Twisted's SSH implementation.</dd>
77
<dt><a name="Connector" shape="rect">Connector</a></dt>
79
Object used to interface between client connections and protocols, usually
80
used with a <code class="API"><a href="http://twistedmatrix.com/documents/10.0.0/api/twisted.internet.protocol.ClientFactory.html" title="twisted.internet.protocol.ClientFactory">twisted.internet.protocol.ClientFactory</a></code>
81
to give you control over how a client connection reconnects. See <code class="API"><a href="http://twistedmatrix.com/documents/10.0.0/api/twisted.internet.interfaces.IConnector.html" title="twisted.internet.interfaces.IConnector">twisted.internet.interfaces.IConnector</a></code> and <a href="clients.html" shape="rect">Writing Clients</a>.
84
<dt><a name="Consumer" shape="rect">Consumer</a></dt>
86
An object that consumes data from a <a href="#Producer" shape="rect">Producer</a>. See
87
<code class="API"><a href="http://twistedmatrix.com/documents/10.0.0/api/twisted.internet.interfaces.IConsumer.html" title="twisted.internet.interfaces.IConsumer">twisted.internet.interfaces.IConsumer</a></code>.
90
<dt><a name="Cred" shape="rect">Cred</a></dt>
92
Twisted's authentication API, <code class="API"><a href="http://twistedmatrix.com/documents/10.0.0/api/twisted.cred.html" title="twisted.cred">twisted.cred</a></code>. See
93
<a href="cred.html" shape="rect">Introduction to Twisted Cred</a> and
94
<a href="pb-cred.html" shape="rect">Twisted Cred usage</a>.
97
<dt><a name="credentials" shape="rect">credentials</a></dt>
99
A username/password, public key, or some other information used for
103
<dt><a name="credential-checker" shape="rect">credential checker</a></dt>
105
Where authentication actually happens. See
106
<code class="API"><a href="http://twistedmatrix.com/documents/10.0.0/api/twisted.cred.checkers.ICredentialChecker.html" title="twisted.cred.checkers.ICredentialChecker">ICredentialChecker</a></code>.
109
<dt><a name="CVSToys" shape="rect">CVSToys</a></dt>
110
<dd>A nifty set of tools for CVS, available at
111
<a href="http://twistedmatrix.com/users/acapnotic/wares/code/CVSToys/" shape="rect">http://twistedmatrix.com/users/acapnotic/wares/code/CVSToys/</a>.</dd>
113
<dt><a name="Daemon" shape="rect">Daemon</a></dt>
115
A background process that does a job or handles client requests.
116
<i>Daemon</i> is a Unix term; <i>service</i> is the NT equivalent.
119
<dt><a name="Deferred" shape="rect"><code class="API"><a href="http://twistedmatrix.com/documents/10.0.0/api/twisted.internet.defer.Deferred.html" title="twisted.internet.defer.Deferred">Deferred</a></code></a></dt>
121
A instance of <code class="API"><a href="http://twistedmatrix.com/documents/10.0.0/api/twisted.internet.defer.Deferred.html" title="twisted.internet.defer.Deferred">twisted.internet.defer.Deferred</a></code>, an
122
abstraction for handling chains of callbacks and error handlers
124
See the <a href="defer.html" shape="rect">Deferring Execution</a> HOWTO.
127
<dt><a name="Enterprise" shape="rect">Enterprise</a></dt>
129
Twisted's RDBMS support. It contains <code class="API"><a href="http://twistedmatrix.com/documents/10.0.0/api/twisted.enterprise.adbapi.html" title="twisted.enterprise.adbapi">twisted.enterprise.adbapi</a></code> for asynchronous access to any
130
standard DB-API 2.0 module, and <code class="API"><a href="http://twistedmatrix.com/documents/10.0.0/api/twisted.enterprise.row.html" title="twisted.enterprise.row">twisted.enterprise.row</a></code>, a <q><a href="#ROW" shape="rect">Relational
131
Object Wrapper</a></q>. See <a href="rdbms.html" shape="rect">Introduction to
132
Twisted Enterprise</a> and <a href="row.html" shape="rect">Twisted Enterprise Row
133
Objects</a> for more details.
136
<dt><a name="errback" shape="rect">errback</a></dt>
138
A callback attached to a <a href="#Deferred" shape="rect">Deferred</a> with
139
<code>.addErrback</code> to handle errors.
142
<dt><a name="Factory" shape="rect"><code class="API" noexpand="1"><a href="http://twistedmatrix.com/documents/10.0.0/api/twisted.internet.protocol.Factory.html" title="twisted.internet.protocol.Factory">Factory</a></code></a></dt>
144
In general, an object that constructs other objects. In Twisted, a Factory
145
usually refers to a <code class="API"><a href="http://twistedmatrix.com/documents/10.0.0/api/twisted.internet.protocol.Factory.html" title="twisted.internet.protocol.Factory">twisted.internet.protocol.Factory</a></code>, which constructs
146
<a href="#Protocol" shape="rect">Protocol</a> instances for incoming or outgoing
147
connections. See <a href="servers.html" shape="rect">Writing Servers</a> and <a href="clients.html" shape="rect">Writing Clients</a>.
150
<dt><a name="Failure" shape="rect"><code class="API" noexpand="1"><a href="http://twistedmatrix.com/documents/10.0.0/api/twisted.python.failure.Failure.html" title="twisted.python.failure.Failure">Failure</a></code></a></dt>
152
Basically, an asynchronous exception that contains traceback information;
153
these are used for passing errors through asynchronous callbacks.
156
<dt><a name="im" shape="rect">im</a></dt>
158
Abbreviation of <q>(Twisted) <a href="#InstanceMessenger" shape="rect">Instance
162
<dt><a name="InstanceMessenger" shape="rect">Instance Messenger</a></dt>
164
Instance Messenger is a multi-protocol chat program that comes with
165
Twisted. It can communicate via TOC with the AOL servers, via IRC, as well as
166
via <a href="#PerspectiveBroker" shape="rect">PB</a> with <a href="#Words" shape="rect">Twisted
167
Words</a>. See <code class="API"><a href="http://twistedmatrix.com/documents/10.0.0/api/twisted.im.html" title="twisted.im">twisted.im</a></code>.
170
<dt><a name="Interface" shape="rect"><code class="API" noexpand="1"><a href="http://twistedmatrix.com/documents/10.0.0/api/twisted.python.components.Interface.html" title="twisted.python.components.Interface">Interface</a></code></a></dt>
172
A class that defines and documents methods that a class conforming to that
173
interface needs to have. A collection of core twisted.internet interfaces can
174
be found in <code class="API"><a href="http://twistedmatrix.com/documents/10.0.0/api/twisted.internet.interfaces.html" title="twisted.internet.interfaces">twisted.internet.interfaces</a></code>. See also <a href="components.html" shape="rect">Interfaces and Adapters</a>.
177
<dt><a name="Jelly" shape="rect">Jelly</a></dt>
179
The serialization layer for <a href="#Spread" shape="rect">Twisted Spread</a>, although it
180
can be used seperately from Twisted Spread as well. It is similar in purpose
181
to Python's standard <code>pickle</code> module, but is more
182
network-friendly, and depends on a separate marshaller (<a href="#Banana" shape="rect">Banana</a>, in most cases). See <code class="API"><a href="http://twistedmatrix.com/documents/10.0.0/api/twisted.spread.jelly.html" title="twisted.spread.jelly">twisted.spread.jelly</a></code>.
185
<dt><a name="Lore" shape="rect">Lore</a></dt>
187
<dd><a href="http://twistedmatrix.com/trac/wiki/TwistedLore/" shape="rect">Lore</a> is
188
Twisted's documentation system. The source format is a subset of
189
XHTML, and output formats include HTML and LaTeX.</dd>
191
<dt><a name="Manhole" shape="rect">Manhole</a></dt>
193
A debugging/administration interface to a Twisted application.
196
<dt><a name="Microdom" shape="rect">Microdom</a></dt>
198
A partial DOM implementation using <a href="#SUX" shape="rect">SUX</a>. It is simple and
199
pythonic, rather than strictly standards-compliant. See <code class="API"><a href="http://twistedmatrix.com/documents/10.0.0/api/twisted.web.microdom.html" title="twisted.web.microdom">twisted.web.microdom</a></code>.
202
<dt><a name="Names" shape="rect">Names</a></dt>
203
<dd>Twisted's DNS server, found in <code class="API"><a href="http://twistedmatrix.com/documents/10.0.0/api/twisted.names.html" title="twisted.names">twisted.names</a></code>.</dd>
205
<dt><a name="Nevow" shape="rect">Nevow</a></dt>
206
<dd>The successor to <a href="#Woven" shape="rect">Woven</a>; available from
207
<a href="http://divmod.org/trac/" shape="rect">Divmod</a>.
210
<dt><a name="PB" shape="rect">PB</a></dt>
212
Abbreviation of <q><a href="#PerspectiveBroker" shape="rect">Perspective
216
<dt><a name="PerspectiveBroker" shape="rect">Perspective Broker</a></dt>
218
The high-level object layer of Twisted <a href="#Spread" shape="rect">Spread</a>,
219
implementing semantics for method calling and object copying, caching, and
220
referencing. See <code class="API"><a href="http://twistedmatrix.com/documents/10.0.0/api/twisted.spread.pb.html" title="twisted.spread.pb">twisted.spread.pb</a></code>.
223
<dt><a name="Portal" shape="rect">Portal</a></dt>
225
Glues <a href="#credential-checker" shape="rect">credential checkers</a> and
226
<a href="#realm" shape="rect">realm</a>s together.
229
<dt><a name="Producer" shape="rect">Producer</a></dt>
231
An object that generates data a chunk at a time, usually to be processed by a
232
<a href="#Consumer" shape="rect">Consumer</a>. See
233
<code class="API"><a href="http://twistedmatrix.com/documents/10.0.0/api/twisted.internet.interfaces.IProducer.html" title="twisted.internet.interfaces.IProducer">twisted.internet.interfaces.IProducer</a></code>.
236
<dt><a name="Protocol" shape="rect"><code class="API" noexpand="1"><a href="http://twistedmatrix.com/documents/10.0.0/api/twisted.internet.protocol.Protocol.html" title="twisted.internet.protocol.Protocol">Protocol</a></code></a></dt>
238
In general each network connection has its own Protocol instance to manage
239
connection-specific state. There is a collection of standard
240
protocol implementations in <code class="API"><a href="http://twistedmatrix.com/documents/10.0.0/api/twisted.protocols.html" title="twisted.protocols">twisted.protocols</a></code>. See
241
also <a href="servers.html" shape="rect">Writing Servers</a> and <a href="clients.html" shape="rect">Writing Clients</a>.
244
<dt><a name="PSU" shape="rect">PSU</a></dt>
245
<dd>There is no PSU.</dd>
247
<dt><a name="Reactor" shape="rect">Reactor</a></dt>
249
The core event-loop of a Twisted application. See
250
<a href="reactor-basics.html" shape="rect">Reactor Basics</a>.
253
<dt><a name="Reality" shape="rect">Reality</a></dt>
254
<dd>See <q><a href="#TwistedReality" shape="rect">Twisted Reality</a></q></dd>
256
<dt><a name="realm" shape="rect">realm</a></dt>
258
(in <a href="#Cred" shape="rect">Twisted Cred</a>) stores <a href="#Avatar" shape="rect">avatars</a>
259
and perhaps general business logic. See
260
<code class="API"><a href="http://twistedmatrix.com/documents/10.0.0/api/twisted.cred.portal.IRealm.html" title="twisted.cred.portal.IRealm">IRealm</a></code>.
263
<dt><a name="Resource" shape="rect"><code class="API" noexpand="1"><a href="http://twistedmatrix.com/documents/10.0.0/api/twisted.web.resource.Resource.html" title="twisted.web.resource.Resource">Resource</a></code></a></dt>
265
A <code class="API"><a href="http://twistedmatrix.com/documents/10.0.0/api/twisted.web.resource.Resource.html" title="twisted.web.resource.Resource">twisted.web.resource.Resource</a></code>, which are served
266
by Twisted Web. Resources can be as simple as a static file on disk, or they
267
can have dynamically generated content.
270
<dt><a name="ROW" shape="rect">ROW</a></dt>
272
<em>R</em>elational <em>O</em>bject <em>W</em>rapper, an object-oriented
273
interface to a relational database. See <a href="row.html" shape="rect">Twisted Enterprise
277
<dt><a name="Service" shape="rect">Service</a></dt>
279
A <code class="API"><a href="http://twistedmatrix.com/documents/10.0.0/api/twisted.application.service.Service.html" title="twisted.application.service.Service">twisted.application.service.Service</a></code>. See <a href="application.html" shape="rect">Application howto</a> for a description of how they
280
relate to <a href="#Application" shape="rect">Applications</a>.
283
<dt><a name="Spread" shape="rect">Spread</a></dt>
284
<dd><a href="http://twistedmatrix.com/products/spread" shape="rect">Twisted Spread</a> is
285
Twisted's remote-object suite. It consists of three layers:
286
<a href="#PerspectiveBroker" shape="rect">Perspective Broker</a>, <a href="#Jelly" shape="rect">Jelly</a>
287
and <a href="#Banana" shape="rect">Banana.</a> See <a href="pb.html" shape="rect">Writing Applications
288
with Perspective Broker</a>.</dd>
290
<dt><a name="SUX" shape="rect">SUX</a></dt>
291
<dd><em>S</em>mall <em>U</em>ncomplicated <em>X</em>ML, Twisted's simple XML
292
parser written in pure Python. See
293
<code class="API"><a href="http://twistedmatrix.com/documents/10.0.0/api/twisted.protocols.sux.html" title="twisted.protocols.sux">twisted.protocols.sux</a></code>.</dd>
295
<dt><a name="TAC" shape="rect">TAC</a></dt>
296
<dd>A <em>T</em>wisted <em>A</em>pplication <em>C</em>onfiguration is a Python
297
source file, generally with the <em>.tac</em> extension, which defines
298
configuration to make an application runnable using <code>twistd</code>.</dd>
300
<dt><a name="TAP" shape="rect">TAP</a></dt>
301
<dd><em>T</em>wisted <em>A</em>pplication <em>P</em>ickle (deprecated), or simply just a
302
<em>T</em>wisted <em>AP</em>plication. A serialised application that was created
303
with <code>mktap</code> and runnable by <code>twistd</code>. See
304
<a href="basics.html" shape="rect">Using the Utilities</a>.</dd>
306
<dt><a name="Trial" shape="rect">Trial</a></dt>
307
<dd><code class="API"><a href="http://twistedmatrix.com/documents/10.0.0/api/twisted.trial.html" title="twisted.trial">twisted.trial</a></code>, Twisted's unit-testing framework,
308
modelled after <a href="http://pyunit.sourceforge.net/" shape="rect">pyunit</a>. See also
309
<a href="testing.html" shape="rect">Writing tests for Twisted code</a>.</dd>
311
<dt><a name="TwistedMatrixLaboratories" shape="rect">Twisted Matrix Laboratories</a></dt>
312
<dd>The team behind Twisted.
313
<a href="http://twistedmatrix.com/" shape="rect">http://twistedmatrix.com/</a>.</dd>
315
<dt><a name="TwistedReality" shape="rect">Twisted Reality</a></dt>
317
In days of old, the Twisted Reality multiplayer text-based interactive-fiction
318
system was the main focus of Twisted Matrix Labs; Twisted, the general networking
319
framework, grew out of Reality's need for better network functionality. Twisted
320
Reality has been superseded by the
321
<a href="http://www.divmod.org/trac/wiki/DivmodImaginary" shape="rect">Imaginary</a> project.
324
<dt><a name="usage" shape="rect"><code class="API" noexpand="1"><a href="http://twistedmatrix.com/documents/10.0.0/api/twisted.python.usage.html" title="twisted.python.usage">usage</a></code></a></dt>
325
<dd>The <code class="API"><a href="http://twistedmatrix.com/documents/10.0.0/api/twisted.python.usage.html" title="twisted.python.usage">twisted.python.usage</a></code> module, a replacement for
326
the standard <code>getopt</code> module for parsing command-lines which is much
327
easier to work with. See <a href="options.html" shape="rect">Parsing command-lines</a>.</dd>
329
<dt><a name="Words" shape="rect">Words</a></dt>
330
<dd>Twisted Words is a multi-protocol chat server that uses the
331
<a href="#PerspectiveBroker" shape="rect">Perspective Broker</a> protocol as its native
332
communication style. See <code class="API"><a href="http://twistedmatrix.com/documents/10.0.0/api/twisted.words.html" title="twisted.words">twisted.words</a></code>.</dd>
334
<dt><a name="Woven" shape="rect">Woven</a></dt>
335
<dd><em>W</em>eb <em>O</em>bject <em>V</em>isualization <em>En</em>vironment.
336
A templating system previously, but no longer, included with Twisted. Woven
337
has largely been superceded by <a href="http://divmod.org/trac/wiki/DivmodNevow" shape="rect">
338
Divmod Nevow</a>.</dd>
344
<p><a href="index.html">Index</a></p>
345
<span class="version">Version: 10.0.0</span>
b'\\ No newline at end of file'
added
removed
vendor/Twisted-10.0.0/doc/core/howto/glossary.html
