twisted.spread.flavors.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.spread.flavors</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.spread.html">Package spread</a> ::
Module flavors
</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.spread.flavors.html" target="_top">no frames</a>]</font></td></tr>
</table></td>
</tr></table>
<!-- =========== START OF MODULE DESCRIPTION =========== -->
<h2 class="module">Module twisted.spread.flavors</h2>
<p>This module represents flavors of remotely acessible objects.</p>
<p>Currently this is only objects accessible through Perspective Broker,
but will hopefully encompass all forms of remote access which can emulate
subsets of PB (such as XMLRPC or SOAP).</p>
<p>Stability: semi-stable</p>
Future Plans: Optimization. Exploitation of new-style object model.
Optimizations to this module should not affect external-use semantics at
all, but may have a small impact on users who subclass and override
methods.
<hr/>
<p><b>Author:</b> <a href="mailto:glyph@twistedmatrix.com">Glyph Lefkowitz</a>
</p>
<!-- =========== 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.spread.flavors.Cacheable.html"><code>Cacheable</code></a></b></td>
<td>A cached instance.</td></tr>
<tr><td width="15%">
<b><a href="twisted.spread.flavors.Copyable.html"><code>Copyable</code></a></b></td>
<td>Subclass me to get copied each time you are returned from or passed to
a remote method.</td></tr>
<tr><td width="15%">
<b><a href="twisted.spread.flavors.IPBRoot.html"><code>IPBRoot</code></a></b></td>
<td>Factory for root Referenceable objects for PB servers.</td></tr>
<tr><td width="15%">
<b><a href="twisted.spread.flavors.Referenceable.html"><code>Referenceable</code></a></b></td>
<td> </td></tr>
<tr><td width="15%">
<b><a href="twisted.spread.flavors.RemoteCache.html"><code>RemoteCache</code></a></b></td>
<td>A cache is a local representation of a remote <a
href="twisted.spread.flavors.Cacheable.html"
class="link"><code>Cacheable</code></a> object.</td></tr>
<tr><td width="15%">
<b><a href="twisted.spread.flavors.RemoteCacheMethod.html"><code>RemoteCacheMethod</code></a></b></td>
<td>A method on a reference to a <a
href="twisted.spread.flavors.RemoteCache.html"
class="link"><code>RemoteCache</code></a>.</td></tr>
<tr><td width="15%">
<b><a href="twisted.spread.flavors.RemoteCacheObserver.html"><code>RemoteCacheObserver</code></a></b></td>
<td>I am a reverse-reference to the peer's <a
href="twisted.spread.flavors.RemoteCache.html"
class="link"><code>RemoteCache</code></a>.</td></tr>
<tr><td width="15%">
<b><a href="twisted.spread.flavors.RemoteCopy.html"><code>RemoteCopy</code></a></b></td>
<td>I am a remote copy of a Copyable object.</td></tr>
<tr><td width="15%">
<b><a href="twisted.spread.flavors.Root.html"><code>Root</code></a></b></td>
<td>I provide a root object to <a href="twisted.spread.pb.Broker.html"
class="link"><code>pb.Broker</code></a>s for a <a
href="twisted.spread.pb.BrokerFactory.html"
class="link"><code>pb.BrokerFactory</code></a>.</td></tr>
<tr><td width="15%">
<b><a href="twisted.spread.flavors.Serializable.html"><code>Serializable</code></a></b></td>
<td>An object that can be passed remotely.</td></tr>
<tr><td width="15%">
<b><a href="twisted.spread.flavors.Viewable.html"><code>Viewable</code></a></b></td>
<td>I will be converted to a <a
href="twisted.spread.flavors.ViewPoint.html"
class="link"><code>ViewPoint</code></a> when passed to or returned from a
remote method.</td></tr>
<tr><td width="15%">
<b><a href="twisted.spread.flavors.ViewPoint.html"><code>ViewPoint</code></a></b></td>
<td>I act as an indirect reference to an object accessed through a <a
href="twisted.spread.pb.Perspective.html"
class="link"><code>pb.Perspective</code></a>.</td></tr>
</table><br />
<!-- =========== START OF FUNCTION SUMMARY =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Function Summary</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="unjellyCached"></a><span class="summary-sig"><span class="summary-sig-name">unjellyCached</span>(<span class=summary-sig-arg>unjellier</span>,
<span class=summary-sig-arg>unjellyList</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="unjellyLCache"></a><span class="summary-sig"><span class="summary-sig-name">unjellyLCache</span>(<span class=summary-sig-arg>unjellier</span>,
<span class=summary-sig-arg>unjellyList</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="unjellyLocal"></a><span class="summary-sig"><span class="summary-sig-name">unjellyLocal</span>(<span class=summary-sig-arg>unjellier</span>,
<span class=summary-sig-arg>unjellyList</span>)</span></code>
</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>str</code></font></td>
<td><b><a href="twisted.spread.flavors.html#__version__"><code>__version__</code></a></b> = <span title="'1.32'"><code><span class="variable-quote">'</span>1.32<span class="variable-quote">'</span> </code>
</span></td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>str</code></font></td>
<td><b><a href="twisted.spread.flavors.html#cache_atom"><code>cache_atom</code></a></b> = <span title="'cache'"><code><span class="variable-quote">'</span>cache<span class="variable-quote">'</span> </code>
</span></td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>str</code></font></td>
<td><b><a href="twisted.spread.flavors.html#cached_atom"><code>cached_atom</code></a></b> = <span title="'cached'"><code><span class="variable-quote">'</span>cached<span class="variable-quote">'</span> </code>
</span></td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>str</code></font></td>
<td><b><a href="twisted.spread.flavors.html#copy_atom"><code>copy_atom</code></a></b> = <span title="'copy'"><code><span class="variable-quote">'</span>copy<span class="variable-quote">'</span> </code>
</span></td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>dict</code></font></td>
<td><b><a href="twisted.spread.flavors.html#copyTags"><code>copyTags</code></a></b> = <span title="{'twisted.web.server.Request': <class twisted.web.distrib.Request at 0x86f6b34>, 'remote': <class twisted.spread.pb.RemoteReference at 0x8535084>, 'cached': <function unjellyCached at 0x84628e4>, 'lcache': <function unjellyLCache at 0x846291c>, 'twisted.spread.pb.CopyableFailure': <class twisted.spread.pb.CopiedFailure at 0x8479924>, 'local': <function unjellyLocal at 0x85a807c>}"><code>{'twisted.web.server.Request': <class twisted<span class="variable-ellipsis">...</span></code>
</span></td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>str</code></font></td>
<td><b><a href="twisted.spread.flavors.html#remote_atom"><code>remote_atom</code></a></b> = <span title="'remote'"><code><span class="variable-quote">'</span>remote<span class="variable-quote">'</span> </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="__version__"></a>
<h3>__version__</h3>
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>str</code>
</dd>
<span title="'1.32'"> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
<span class="variable-quote">'</span>1.32<span class="variable-quote">'</span> </pre>
</td></tr></table></dd>
</span> </dl>
</dd>
</dl></td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="cache_atom"></a>
<h3>cache_atom</h3>
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>str</code>
</dd>
<span title="'cache'"> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
<span class="variable-quote">'</span>cache<span class="variable-quote">'</span> </pre>
</td></tr></table></dd>
</span> </dl>
</dd>
</dl></td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="cached_atom"></a>
<h3>cached_atom</h3>
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>str</code>
</dd>
<span title="'cached'"> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
<span class="variable-quote">'</span>cached<span class="variable-quote">'</span> </pre>
</td></tr></table></dd>
</span> </dl>
</dd>
</dl></td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="copy_atom"></a>
<h3>copy_atom</h3>
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>str</code>
</dd>
<span title="'copy'"> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
<span class="variable-quote">'</span>copy<span class="variable-quote">'</span> </pre>
</td></tr></table></dd>
</span> </dl>
</dd>
</dl></td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="copyTags"></a>
<h3>copyTags</h3>
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>dict</code>
</dd>
<span title="{'twisted.web.server.Request': <class twisted.web.distrib.Request at 0x86f6b34>, 'remote': <class twisted.spread.pb.RemoteReference at 0x8535084>, 'cached': <function unjellyCached at 0x84628e4>, 'lcache': <function unjellyLCache at 0x846291c>, 'twisted.spread.pb.CopyableFailure': <class twisted.spread.pb.CopiedFailure at 0x8479924>, 'local': <function unjellyLocal at 0x85a807c>}"> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
{'cached': <function unjellyCached at 0x84628e4>,
'lcache': <function unjellyLCache at 0x846291c>,
'local': <function unjellyLocal at 0x85a807c>,
'remote': <class twisted.spread.pb.RemoteReference at 0x8535084>,
'twisted.spread.pb.CopyableFailure': <class twisted.spread.pb.CopiedF<span class="variable-linewrap">\</span>
ailure at 0x8479924>,
'twisted.web.server.Request': <class twisted.web.distrib.Request at 0<span class="variable-linewrap">\</span>
x86f6b34>} </pre>
</td></tr></table></dd>
</span> </dl>
</dd>
</dl></td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="remote_atom"></a>
<h3>remote_atom</h3>
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>str</code>
</dd>
<span title="'remote'"> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
<span class="variable-quote">'</span>remote<span class="variable-quote">'</span> </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:47 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>