doc/core/howto/glossary.html

   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">
   2   <head>
   3 <title>Twisted Documentation: Twisted Glossary</title>
   4 <link href="stylesheet.css" rel="stylesheet" type="text/css"/>
   5   </head>
   6
   7   <body bgcolor="white">
   8     <h1 class="title">Twisted Glossary</h1>
   9     <div class="toc"><ol/></div>
  10     <div class="content">
  11 <span/>
  12
  13 <dl>
  14
  15 <dt><a name="adaptee" shape="rect">adaptee</a></dt>
  16 <dd>
  17   An object that has been adapted, also called <q>original</q>.  See <a href="#Adapter" shape="rect">Adapter</a>.
  18 </dd>
  19
  20 <dt><a name="Adapter" shape="rect"><code class="API" noexpand="1"><a href="http://twistedmatrix.com/documents/12.1.0/api/twisted.python.components.Adapter.html" title="twisted.python.components.Adapter">Adapter</a></code></a></dt>
  21 <dd>
  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>.
  24 </dd>
  25
  26 <dt><a name="Application" shape="rect"><code class="API" noexpand="1"><a href="http://twistedmatrix.com/documents/12.1.0/api/twisted.application.service.Application.html" title="twisted.application.service.Application">Application</a></code></a></dt>
  27 <dd>
  28   A <code class="API"><a href="http://twistedmatrix.com/documents/12.1.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
  31   your code.
  32 </dd>
  33
  34 <dt><a name="Avatar" shape="rect">Avatar</a></dt>
  35 <dd>
  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.
  39 </dd>
  40
  41 <dt><a name="Banana" shape="rect"><code class="API" noexpand="1"><a href="http://twistedmatrix.com/documents/12.1.0/api/twisted.spread.banana.Banana.html" title="twisted.spread.banana.Banana">Banana</a></code></a></dt>
  42 <dd>
  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/12.1.0/api/twisted.spread.banana.html" title="twisted.spread.banana">twisted.spread.banana</a></code>.
  45 </dd>
  46
  47 <dt><a name="Broker" shape="rect"><code class="API" noexpand="1"><a href="http://twistedmatrix.com/documents/12.1.0/api/twisted.spread.pb.Broker.html" title="twisted.spread.pb.Broker">Broker</a></code></a></dt>
  48 <dd>
  49   A <code class="API"><a href="http://twistedmatrix.com/documents/12.1.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>.
  51 </dd>
  52
  53 <dt><a name="cache" shape="rect">cache</a></dt>
  54 <dd>
  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.
  58 </dd>
  59
  60 <dt><a name="component" shape="rect">component</a></dt>
  61 <dd>
  62   A special kind of (persistent) <code class="API"><a href="http://twistedmatrix.com/documents/12.1.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/12.1.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>.
  63 </dd>
  64
  65 <dt><a name="Componentized" shape="rect"><code class="API" noexpand="1"><a href="http://twistedmatrix.com/documents/12.1.0/api/twisted.python.components.Componentized.html" title="twisted.python.components.Componentized">Componentized</a></code></a></dt>
  66 <dd>
  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/12.1.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>.
  72 </dd>
  73
  74 <dt><a name="conch" shape="rect"><code class="API" noexpand="1"><a href="http://twistedmatrix.com/documents/12.1.0/api/twisted.conch.html" title="twisted.conch">conch</a></code></a></dt>
  75 <dd>Twisted's SSH implementation.</dd>
  76
  77 <dt><a name="Connector" shape="rect">Connector</a></dt>
  78 <dd>
  79   Object used to interface between client connections and protocols, usually
  80   used with a <code class="API"><a href="http://twistedmatrix.com/documents/12.1.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/12.1.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>.
  82 </dd>
  83
  84 <dt><a name="Consumer" shape="rect">Consumer</a></dt>
  85 <dd>
  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/12.1.0/api/twisted.internet.interfaces.IConsumer.html" title="twisted.internet.interfaces.IConsumer">twisted.internet.interfaces.IConsumer</a></code>.
  88 </dd>
  89
  90 <dt><a name="Cred" shape="rect">Cred</a></dt>
  91 <dd>
  92   Twisted's authentication API, <code class="API"><a href="http://twistedmatrix.com/documents/12.1.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>.
  95 </dd>
  96
  97 <dt><a name="credentials" shape="rect">credentials</a></dt>
  98 <dd>
  99   A username/password, public key, or some other information used for
 100   authentication.
 101 </dd>
 102
 103 <dt><a name="credential-checker" shape="rect">credential checker</a></dt>
 104 <dd>
 105   Where authentication actually happens.  See
 106   <code class="API"><a href="http://twistedmatrix.com/documents/12.1.0/api/twisted.cred.checkers.ICredentialsChecker.html" title="twisted.cred.checkers.ICredentialsChecker">ICredentialsChecker</a></code>.
 107 </dd>
 108
 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>
 112
 113 <dt><a name="Daemon" shape="rect">Daemon</a></dt>
 114 <dd>
 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 Windows equivalent.
 117 </dd>
 118
 119 <dt><a name="Deferred" shape="rect"><code class="API"><a href="http://twistedmatrix.com/documents/12.1.0/api/twisted.internet.defer.Deferred.html" title="twisted.internet.defer.Deferred">Deferred</a></code></a></dt>
 120 <dd>
 121   A instance of <code class="API"><a href="http://twistedmatrix.com/documents/12.1.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
 123   (<q>errbacks</q>).
 124   See the <a href="defer.html" shape="rect">Deferring Execution</a> HOWTO.
 125 </dd>
 126
 127 <dt><a name="Enterprise" shape="rect">Enterprise</a></dt>
 128 <dd>
 129   Twisted's RDBMS support.  It contains <code class="API"><a href="http://twistedmatrix.com/documents/12.1.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. See <a href="rdbms.html" shape="rect">Introduction to
 131   Twisted Enterprise</a> for more details.
 132 </dd>
 133
 134 <dt><a name="errback" shape="rect">errback</a></dt>
 135 <dd>
 136   A callback attached to a <a href="#Deferred" shape="rect">Deferred</a> with
 137   <code>.addErrback</code> to handle errors.
 138 </dd>
 139
 140 <dt><a name="Factory" shape="rect"><code class="API" noexpand="1"><a href="http://twistedmatrix.com/documents/12.1.0/api/twisted.internet.protocol.Factory.html" title="twisted.internet.protocol.Factory">Factory</a></code></a></dt>
 141 <dd>
 142   In general, an object that constructs other objects.  In Twisted, a Factory
 143   usually refers to a <code class="API"><a href="http://twistedmatrix.com/documents/12.1.0/api/twisted.internet.protocol.Factory.html" title="twisted.internet.protocol.Factory">twisted.internet.protocol.Factory</a></code>, which constructs
 144   <a href="#Protocol" shape="rect">Protocol</a> instances for incoming or outgoing
 145   connections.  See <a href="servers.html" shape="rect">Writing Servers</a> and <a href="clients.html" shape="rect">Writing Clients</a>.
 146 </dd>
 147
 148 <dt><a name="Failure" shape="rect"><code class="API" noexpand="1"><a href="http://twistedmatrix.com/documents/12.1.0/api/twisted.python.failure.Failure.html" title="twisted.python.failure.Failure">Failure</a></code></a></dt>
 149 <dd>
 150   Basically, an asynchronous exception that contains traceback information;
 151   these are used for passing errors through asynchronous callbacks.
 152 </dd>
 153
 154 <dt><a name="im" shape="rect">im</a></dt>
 155 <dd>
 156   Abbreviation of <q>(Twisted) <a href="#InstanceMessenger" shape="rect">Instance
 157   Messenger</a></q>.
 158   </dd>
 159
 160 <dt><a name="InstanceMessenger" shape="rect">Instance Messenger</a></dt>
 161 <dd>
 162   Instance Messenger is a multi-protocol chat program that comes with
 163   Twisted.  It can communicate via TOC with the AOL servers, via IRC, as well as
 164   via <a href="#PerspectiveBroker" shape="rect">PB</a> with
 165   <a href="#Words" shape="rect">Twisted Words</a>.  See <code class="API"><a href="http://twistedmatrix.com/documents/12.1.0/api/twisted.words.im.html" title="twisted.words.im">twisted.words.im</a></code>.
 166 </dd>
 167
 168 <dt><a name="Interface" shape="rect">Interface</a></dt>
 169 <dd>
 170   A class that defines and documents methods that a class conforming to that
 171   interface needs to have.  A collection of core <code class="API"><a href="http://twistedmatrix.com/documents/12.1.0/api/twisted.internet.html" title="twisted.internet">twisted.internet</a></code> interfaces can
 172   be found in <code class="API"><a href="http://twistedmatrix.com/documents/12.1.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>.
 173 </dd>
 174
 175 <dt><a name="Jelly" shape="rect">Jelly</a></dt>
 176 <dd>
 177   The serialization layer for <a href="#Spread" shape="rect">Twisted Spread</a>, although it
 178   can be used seperately from Twisted Spread as well.  It is similar in purpose
 179   to Python's standard <code>pickle</code> module, but is more
 180   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/12.1.0/api/twisted.spread.jelly.html" title="twisted.spread.jelly">twisted.spread.jelly</a></code>.
 181 </dd>
 182
 183 <dt><a name="Lore" shape="rect">Lore</a></dt>
 184
 185 <dd><a href="http://twistedmatrix.com/trac/wiki/TwistedLore/" shape="rect">Lore</a> is
 186 Twisted's documentation system.  The source format is a subset of
 187 XHTML, and output formats include HTML and LaTeX.</dd>
 188
 189 <dt><a name="Manhole" shape="rect">Manhole</a></dt>
 190 <dd>
 191   A debugging/administration interface to a Twisted application.
 192 </dd>
 193
 194 <dt><a name="Microdom" shape="rect">Microdom</a></dt>
 195 <dd>
 196   A partial DOM implementation using <a href="#SUX" shape="rect">SUX</a>.  It is simple and
 197   pythonic, rather than strictly standards-compliant.  See <code class="API"><a href="http://twistedmatrix.com/documents/12.1.0/api/twisted.web.microdom.html" title="twisted.web.microdom">twisted.web.microdom</a></code>.
 198 </dd>
 199
 200 <dt><a name="Names" shape="rect">Names</a></dt>
 201 <dd>Twisted's DNS server, found in <code class="API"><a href="http://twistedmatrix.com/documents/12.1.0/api/twisted.names.html" title="twisted.names">twisted.names</a></code>.</dd>
 202
 203 <dt><a name="Nevow" shape="rect">Nevow</a></dt>
 204 <dd>The successor to <a href="#Woven" shape="rect">Woven</a>; available from <a href="http://launchpad.net/nevow" shape="rect">Divmod</a>.
 205 </dd>
 206
 207 <dt><a name="PB" shape="rect">PB</a></dt>
 208 <dd>
 209   Abbreviation of <q><a href="#PerspectiveBroker" shape="rect">Perspective
 210   Broker</a></q>.
 211 </dd>
 212
 213 <dt><a name="PerspectiveBroker" shape="rect">Perspective Broker</a></dt>
 214 <dd>
 215   The high-level object layer of Twisted <a href="#Spread" shape="rect">Spread</a>,
 216   implementing semantics for method calling and object copying, caching, and
 217   referencing.  See <code class="API"><a href="http://twistedmatrix.com/documents/12.1.0/api/twisted.spread.pb.html" title="twisted.spread.pb">twisted.spread.pb</a></code>.
 218 </dd>
 219
 220 <dt><a name="Portal" shape="rect">Portal</a></dt>
 221 <dd>
 222   Glues <a href="#credential-checker" shape="rect">credential checkers</a> and
 223   <a href="#realm" shape="rect">realm</a>s together.
 224 </dd>
 225
 226 <dt><a name="Producer" shape="rect">Producer</a></dt>
 227 <dd>
 228   An object that generates data a chunk at a time, usually to be processed by a
 229   <a href="#Consumer" shape="rect">Consumer</a>.  See
 230   <code class="API"><a href="http://twistedmatrix.com/documents/12.1.0/api/twisted.internet.interfaces.IProducer.html" title="twisted.internet.interfaces.IProducer">twisted.internet.interfaces.IProducer</a></code>.
 231 </dd>
 232
 233 <dt><a name="Protocol" shape="rect"><code class="API" noexpand="1"><a href="http://twistedmatrix.com/documents/12.1.0/api/twisted.internet.protocol.Protocol.html" title="twisted.internet.protocol.Protocol">Protocol</a></code></a></dt>
 234 <dd>
 235   In general each network connection has its own Protocol instance to manage
 236   connection-specific state.  There is a collection of standard
 237   protocol implementations in <code class="API"><a href="http://twistedmatrix.com/documents/12.1.0/api/twisted.protocols.html" title="twisted.protocols">twisted.protocols</a></code>.  See
 238   also <a href="servers.html" shape="rect">Writing Servers</a> and <a href="clients.html" shape="rect">Writing Clients</a>.
 239 </dd>
 240
 241 <dt><a name="PSU" shape="rect">PSU</a></dt>
 242 <dd>There is no PSU.</dd>
 243
 244 <dt><a name="Reactor" shape="rect">Reactor</a></dt>
 245 <dd>
 246   The core event-loop of a Twisted application.  See
 247   <a href="reactor-basics.html" shape="rect">Reactor Basics</a>.
 248 </dd>
 249
 250 <dt><a name="Reality" shape="rect">Reality</a></dt>
 251 <dd>See <q><a href="#TwistedReality" shape="rect">Twisted Reality</a></q></dd>
 252
 253 <dt><a name="realm" shape="rect">realm</a></dt>
 254 <dd>
 255   (in <a href="#Cred" shape="rect">Twisted Cred</a>) stores <a href="#Avatar" shape="rect">avatars</a>
 256   and perhaps general business logic.  See
 257   <code class="API"><a href="http://twistedmatrix.com/documents/12.1.0/api/twisted.cred.portal.IRealm.html" title="twisted.cred.portal.IRealm">IRealm</a></code>.
 258 </dd>
 259
 260 <dt><a name="Resource" shape="rect"><code class="API" noexpand="1"><a href="http://twistedmatrix.com/documents/12.1.0/api/twisted.web.resource.Resource.html" title="twisted.web.resource.Resource">Resource</a></code></a></dt>
 261 <dd>
 262   A <code class="API"><a href="http://twistedmatrix.com/documents/12.1.0/api/twisted.web.resource.Resource.html" title="twisted.web.resource.Resource">twisted.web.resource.Resource</a></code>, which are served
 263   by Twisted Web.  Resources can be as simple as a static file on disk, or they
 264   can have dynamically generated content.
 265 </dd>
 266
 267 <dt><a name="Service" shape="rect">Service</a></dt>
 268 <dd>
 269   A <code class="API"><a href="http://twistedmatrix.com/documents/12.1.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
 270   relate to <a href="#Application" shape="rect">Applications</a>.
 271 </dd>
 272
 273 <dt><a name="Spread" shape="rect">Spread</a></dt>
 274 <dd>Twisted Spread is
 275 Twisted's remote-object suite.  It consists of three layers:
 276 <a href="#PerspectiveBroker" shape="rect">Perspective Broker</a>, <a href="#Jelly" shape="rect">Jelly</a>
 277 and <a href="#Banana" shape="rect">Banana.</a>  See <a href="pb.html" shape="rect">Writing Applications
 278 with Perspective Broker</a>.</dd>
 279
 280 <dt><a name="SUX" shape="rect">SUX</a></dt>
 281 <dd><em>S</em>mall <em>U</em>ncomplicated <em>X</em>ML, Twisted's simple XML
 282 parser written in pure Python.  See <code class="API"><a href="http://twistedmatrix.com/documents/12.1.0/api/twisted.web.sux.html" title="twisted.web.sux">twisted.web.sux</a></code>.</dd>
 283
 284 <dt><a name="TAC" shape="rect">TAC</a></dt>
 285 <dd>A <em>T</em>wisted <em>A</em>pplication <em>C</em>onfiguration is a Python
 286 source file, generally with the <em>.tac</em> extension, which defines
 287 configuration to make an application runnable using <code>twistd</code>.</dd>
 288
 289 <dt><a name="TAP" shape="rect">TAP</a></dt>
 290 <dd><em>T</em>wisted <em>A</em>pplication <em>P</em>ickle (no longer supported), or simply just a
 291 <em>T</em>wisted <em>AP</em>plication.  A serialised application that was created
 292 with <code>mktap</code> (no longer supported) and runnable by <code>twistd</code>.  See
 293 <a href="basics.html" shape="rect">Using the Utilities</a>.</dd>
 294
 295 <dt><a name="Trial" shape="rect">Trial</a></dt>
 296 <dd><code class="API"><a href="http://twistedmatrix.com/documents/12.1.0/api/twisted.trial.html" title="twisted.trial">twisted.trial</a></code>, Twisted's unit-testing framework,
 297 based on the <code>unittest</code> standard library module.  See also <a href="testing.html" shape="rect">Writing tests for Twisted code</a>.</dd>
 298
 299 <dt><a name="TwistedMatrixLaboratories" shape="rect">Twisted Matrix Laboratories</a></dt>
 300 <dd>The team behind Twisted.
 301 <a href="http://twistedmatrix.com/" shape="rect">http://twistedmatrix.com/</a>.</dd>
 302
 303 <dt><a name="TwistedReality" shape="rect">Twisted Reality</a></dt>
 304 <dd>
 305 In days of old, the Twisted Reality multiplayer text-based interactive-fiction
 306 system was the main focus of Twisted Matrix Labs; Twisted, the general networking
 307 framework, grew out of Reality's need for better network functionality. Twisted
 308 Reality has been superseded by the <a href="http://launchpad.net/imaginary" shape="rect">Imaginary</a> project.
 309 </dd>
 310
 311 <dt><a name="usage" shape="rect"><code class="API" noexpand="1"><a href="http://twistedmatrix.com/documents/12.1.0/api/twisted.python.usage.html" title="twisted.python.usage">usage</a></code></a></dt>
 312 <dd>The <code class="API"><a href="http://twistedmatrix.com/documents/12.1.0/api/twisted.python.usage.html" title="twisted.python.usage">twisted.python.usage</a></code> module, a replacement for
 313 the standard <code>getopt</code> module for parsing command-lines which is much
 314 easier to work with.  See <a href="options.html" shape="rect">Parsing command-lines</a>.</dd>
 315
 316 <dt><a name="Words" shape="rect">Words</a></dt>
 317 <dd>Twisted Words is a multi-protocol chat server that uses the
 318 <a href="#PerspectiveBroker" shape="rect">Perspective Broker</a> protocol as its native
 319 communication style.  See <code class="API"><a href="http://twistedmatrix.com/documents/12.1.0/api/twisted.words.html" title="twisted.words">twisted.words</a></code>.</dd>
 320
 321 <dt><a name="Woven" shape="rect">Woven</a></dt>
 322 <dd><em>W</em>eb <em>O</em>bject <em>V</em>isualization <em>En</em>vironment.
 323 A templating system previously, but no longer, included with Twisted.  Woven
 324 has largely been superceded by <a href="http://launchpad.net/nevow" shape="rect">
 325 Divmod Nevow</a>.</dd>
 326
 327 </dl>
 328
 329 </div>
 330
 331     <p><a href="index.html">Index</a></p>
 332     <span class="version">Version: 12.1.0</span>
 333   </body>
 334 </html>