twisted.spread.pb.RemoteReference.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.pb.RemoteReference</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> ::
<a href="twisted.spread.pb.html">Module pb</a> ::
Class RemoteReference
</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.pb.RemoteReference.html" target="_top">no frames</a>]</font></td></tr>
</table></td>
</tr></table>
<!-- =========== START OF CLASS DESCRIPTION =========== -->
<h2 class="class">Class RemoteReference</h2>
<pre class="base-tree">
<a href="twisted.persisted.styles.Ephemeral.html"><code>Ephemeral</code></a> --+
|
<a href="twisted.spread.jelly.Jellyable.html"><code>Jellyable</code></a> --+ |
| |
<a href="twisted.spread.flavors.Serializable.html"><code>Serializable</code></a> --+
|
<b>RemoteReference</b>
</pre><br />
<hr/>
<p>This is a translucent reference to a remote object.</p>
<p>I may be a reference to a <a
href="twisted.spread.flavors.ViewPoint.html"
class="link"><code>flavors.ViewPoint</code></a>, a <a
href="twisted.spread.flavors.Referenceable.html"
class="link"><code>flavors.Referenceable</code></a>, or an <a
href="twisted.spread.pb.IPerspective.html"
class="link"><code>IPerspective</code></a> implementor (e.g., pb.Avatar).
From the client's perspective, it is not possible to tell which except by
convention.</p>
<p>I am a "translucent" reference because although no
additional bookkeeping overhead is given to the application programmer
for manipulating a reference, return values are asynchronous.</p>
See also <a href="twisted.internet.defer.html"
class="link"><code>twisted.internet.defer</code></a>.
<hr/>
<!-- =========== START OF METHOD SUMMARY =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Method Summary</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.spread.pb.RemoteReference.html#__init__" class="summary-sig-name"><code>__init__</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>perspective</span>,
<span class=summary-sig-arg>broker</span>,
<span class=summary-sig-arg>luid</span>,
<span class=summary-sig-arg>doRefCount</span>)</span></code>
<br />
(internal) Initialize me with a broker and a locally-unique ID.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.spread.pb.RemoteReference.html#__cmp__" class="summary-sig-name"><code>__cmp__</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>other</span>)</span></code>
<br />
Compare me [to another <a
href="twisted.spread.pb.RemoteReference.html"
class="link"><code>RemoteReference</code></a>].</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.spread.pb.RemoteReference.html#__del__" class="summary-sig-name"><code>__del__</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Do distributed reference counting on finalization.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.spread.pb.RemoteReference.html#__hash__" class="summary-sig-name"><code>__hash__</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Hash me.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.spread.pb.RemoteReference.html#_disconnected" class="summary-sig-name"><code>_disconnected</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Called if we are disconnected and have callbacks registered.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> <a href="twisted.internet.defer.Deferred.html"
class="link"><code>twisted.internet.defer.Deferred</code></a>
</font></td>
<td><code><span class="summary-sig"><a href="twisted.spread.pb.RemoteReference.html#callRemote" class="summary-sig-name"><code>callRemote</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>_name</span>,
<span class="summary-sig-vararg">*args</span>,
<span class="summary-sig-kwarg">**kw</span>)</span></code>
<br />
Asynchronously invoke a remote method.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.spread.pb.RemoteReference.html#dontNotifyOnDisconnect" class="summary-sig-name"><code>dontNotifyOnDisconnect</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>callback</span>)</span></code>
<br />
Remove a callback that was registered with notifyOnDisconnect.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.spread.pb.RemoteReference.html#jellyFor" class="summary-sig-name"><code>jellyFor</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>jellier</span>)</span></code>
<br />
If I am being sent back to where I came from, serialize as a local
backreference.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.spread.pb.RemoteReference.html#notifyOnDisconnect" class="summary-sig-name"><code>notifyOnDisconnect</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>callback</span>)</span></code>
<br />
Register a callback to be called if our broker gets disconnected.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.spread.pb.RemoteReference.html#remoteMethod" class="summary-sig-name"><code>remoteMethod</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>key</span>)</span></code>
<br />
Get a <a href="twisted.spread.pb.RemoteMethod.html"
class="link"><code>RemoteMethod</code></a> for this key.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="unjellyFor"></a><span class="summary-sig"><span class="summary-sig-name">unjellyFor</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>unjellier</span>,
<span class=summary-sig-arg>unjellyList</span>)</span></code>
</td></tr>
<tr bgcolor="#e8f0f8" class="group">
<th colspan="2"> Inherited from Serializable</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.spread.flavors.Serializable.html#processUniqueID" class="summary-sig-name"><code>processUniqueID</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Return an ID which uniquely represents this object for this
process.</td></tr>
<tr bgcolor="#e8f0f8" class="group">
<th colspan="2"> Inherited from Jellyable</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.spread.jelly.Jellyable.html#getStateFor" class="summary-sig-name"><code>getStateFor</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>jellier</span>)</span></code>
</td></tr>
<tr bgcolor="#e8f0f8" class="group">
<th colspan="2"> Inherited from Ephemeral</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.persisted.styles.Ephemeral.html#__getstate__" class="summary-sig-name"><code>__getstate__</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.persisted.styles.Ephemeral.html#__setstate__" class="summary-sig-name"><code>__setstate__</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>state</span>)</span></code>
</td></tr>
</table><br />
<!-- =========== START OF INSTANCE VARIABLE SUMMARY =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Instance Variable Summary</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><a href="twisted.spread.pb.Broker.html"
class="link"><code>Broker</code></a></font></td>
<td><b><a href="twisted.spread.pb.RemoteReference.html#broker"><code>broker</code></a></b>: The broker I am obtained through.</td></tr>
</table><br />
<!-- =========== START OF CLASS VARIABLE SUMMARY =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Class Variable Summary</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>tuple</code></font></td>
<td><b><a href="twisted.spread.pb.RemoteReference.html#__implements__"><code>__implements__</code></a></b> = <span title="(<class twisted.spread.interfaces.IUnjellyable at 0x84a65dc>,)"><code>(<class twisted.spread.interfaces.IUnje<span class="variable-ellipsis">...</span></code>
</span></td></tr>
</table><br />
<!-- =========== START OF METHOD DETAILS =========== -->
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="details">
<th colspan="2">Method Details</th></tr>
</table>
<a name="__init__"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">__init__</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>perspective</span>,
<span class=sig-arg>broker</span>,
<span class=sig-arg>luid</span>,
<span class=sig-arg>doRefCount</span>)</span>
<br /><i>(Constructor)</i>
</h3>
<p>(internal) Initialize me with a broker and a locally-unique ID.</p>
The ID is unique only to the particular Perspective Broker
instance.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="__cmp__"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">__cmp__</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>other</span>)</span>
<br /><i>(Comparison operator)</i>
</h3>
Compare me [to another <a
href="twisted.spread.pb.RemoteReference.html"
class="link"><code>RemoteReference</code></a>].
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="__del__"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">__del__</span>(<span class=sig-arg>self</span>)</span>
<br /><i>(Destructor)</i>
</h3>
Do distributed reference counting on finalization.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="__hash__"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">__hash__</span>(<span class=sig-arg>self</span>)</span>
<br /><i>(Hashing function)</i>
</h3>
Hash me.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="_disconnected"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">_disconnected</span>(<span class=sig-arg>self</span>)</span>
</h3>
Called if we are disconnected and have callbacks registered.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="callRemote"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">callRemote</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>_name</span>,
<span class="sig-vararg">*args</span>,
<span class="sig-kwarg">**kw</span>)</span>
</h3>
Asynchronously invoke a remote method.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>_name</b></code> -
the name of the remote method to invoke
<br /><i>
(type=<code>string</code>)</i>
<dd><code><b>args</b></code> -
arguments to serialize for the remote function
<dd><code><b>kw</b></code> -
keyword arguments to serialize for the remote function.
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
a Deferred which will be fired when the result of this remote
call is received.
<br /><i>
(type=<a href="twisted.internet.defer.Deferred.html"
class="link"><code>twisted.internet.defer.Deferred</code></a>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="dontNotifyOnDisconnect"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">dontNotifyOnDisconnect</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>callback</span>)</span>
</h3>
Remove a callback that was registered with notifyOnDisconnect.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="jellyFor"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">jellyFor</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>jellier</span>)</span>
</h3>
If I am being sent back to where I came from, serialize as a local
backreference.
<dl><dt></dt><dd>
<dl><dt><b>Overrides:</b></dt>
<dd><a href="twisted.spread.jelly.Jellyable.html#jellyFor"><code>twisted.spread.jelly.Jellyable.jellyFor</code></a></dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="notifyOnDisconnect"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">notifyOnDisconnect</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>callback</span>)</span>
</h3>
<p>Register a callback to be called if our broker gets
disconnected.</p>
This callback will be called with one argument, this instance.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="remoteMethod"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">remoteMethod</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>key</span>)</span>
</h3>
Get a <a href="twisted.spread.pb.RemoteMethod.html"
class="link"><code>RemoteMethod</code></a> for this key.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<br />
<!-- =========== START OF INSTANCE VARIABLE DETAILS =========== -->
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="details">
<th colspan="2">Instance Variable Details</th></tr>
</table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="broker"></a>
<h3>broker</h3>
The broker I am obtained through.
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<a href="twisted.spread.pb.Broker.html"
class="link"><code>Broker</code></a>
</dd>
</dl>
</dd>
</dl></td></tr></table>
<br />
<!-- =========== START OF CLASS VARIABLE DETAILS =========== -->
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="details">
<th colspan="2">Class Variable Details</th></tr>
</table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="__implements__"></a>
<h3>__implements__</h3>
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>tuple</code>
</dd>
<span title="(<class twisted.spread.interfaces.IUnjellyable at 0x84a65dc>,)"> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
(<class twisted.spread.interfaces.IUnjellyable at 0x84a65dc>,) </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:07:45 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>