twisted.spread.pb.Perspective.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.Perspective</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 Perspective
</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.Perspective.html" target="_top">no frames</a>]</font></td></tr>
</table></td>
</tr></table>
<!-- =========== START OF CLASS DESCRIPTION =========== -->
<h2 class="class">Class Perspective</h2>
<pre class="base-tree">
<a href="twisted.spread.pb.Avatar.html"><code>Avatar</code></a> --+
|
<a href="twisted.cred.perspective.Perspective.html"><code>Perspective</code></a> --+
|
<b>Perspective</b>
</pre><br />
<dl><dt><b>Known Subclasses:</b></dt>
<dd>
<a href="twisted.words.service.Participant.html"><code>Participant</code></a></dd></dl>
<hr/>
This class is DEPRECATED, because it relies on old cred APIs. Please
use <a href="twisted.spread.pb.Avatar.html"
class="link"><code>Avatar</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.Perspective.html#brokerAttached" class="summary-sig-name"><code>brokerAttached</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>reference</span>,
<span class=summary-sig-arg>identity</span>,
<span class=summary-sig-arg>broker</span>)</span></code>
<br />
An intermediary method to override.</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.Perspective.html#brokerDetached" class="summary-sig-name"><code>brokerDetached</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>reference</span>,
<span class=summary-sig-arg>identity</span>,
<span class=summary-sig-arg>broker</span>)</span></code>
<br />
See <a href="twisted.spread.pb.Perspective.html#brokerAttached"
class="link"><code>brokerAttached</code></a>.</td></tr>
<tr bgcolor="#e8f0f8" class="group">
<th colspan="2"> Inherited from Perspective</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.cred.perspective.Perspective.html#__init__" class="summary-sig-name"><code>__init__</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>perspectiveName</span>,
<span class=summary-sig-arg>identityName</span>)</span></code>
<br />
Create 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.cred.perspective.Perspective.html#attached" class="summary-sig-name"><code>attached</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>reference</span>,
<span class=summary-sig-arg>identity</span>)</span></code>
<br />
Called when a remote reference is 'attached' to 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.cred.perspective.Perspective.html#detached" class="summary-sig-name"><code>detached</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>reference</span>,
<span class=summary-sig-arg>identity</span>)</span></code>
<br />
Called when a broker is 'detached' from 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.cred.perspective.Perspective.html#getIdentityRequest" class="summary-sig-name"><code>getIdentityRequest</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Request my identity.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.cred.perspective.Perspective.html#getPerspectiveName" class="summary-sig-name"><code>getPerspectiveName</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Return the unique name of this perspective.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.cred.perspective.Perspective.html#getService" class="summary-sig-name"><code>getService</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Return a service.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.cred.perspective.Perspective.html#isCached" class="summary-sig-name"><code>isCached</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.cred.perspective.Perspective.html#makeIdentity" class="summary-sig-name"><code>makeIdentity</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>password</span>)</span></code>
<br />
Make an identity from this perspective with a password.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.cred.perspective.Perspective.html#setCached" class="summary-sig-name"><code>setCached</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.cred.perspective.Perspective.html#setIdentity" class="summary-sig-name"><code>setIdentity</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>ident</span>)</span></code>
<br />
Determine which identity I connect to.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.cred.perspective.Perspective.html#setIdentityName" class="summary-sig-name"><code>setIdentityName</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>name</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.cred.perspective.Perspective.html#setService" class="summary-sig-name"><code>setService</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>service</span>)</span></code>
<br />
Change what service I am a part of.</td></tr>
<tr bgcolor="#e8f0f8" class="group">
<th colspan="2"> Inherited from Avatar</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.Avatar.html#perspectiveMessageReceived" class="summary-sig-name"><code>perspectiveMessageReceived</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>broker</span>,
<span class=summary-sig-arg>message</span>,
<span class=summary-sig-arg>args</span>,
<span class=summary-sig-arg>kw</span>)</span></code>
<br />
This method is called when a network message is received.</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 bgcolor="#e8f0f8" class="group">
<th colspan="2"> Inherited from Perspective</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>tuple</code></font></td>
<td><b><a href="twisted.cred.perspective.Perspective.html#__implements__"><code>__implements__</code></a></b> = <span title="(<class twisted.cred.perspective.IPerspective at 0x85727dc>,)"><code>(<class twisted.cred.perspective.IPersp<span class="variable-ellipsis">...</span></code>
</span></td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td>
<td><b><a href="twisted.cred.perspective.Perspective.html#_attachedCount"><code>_attachedCount</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.cred.perspective.Perspective.html#_service_cached"><code>_service_cached</code></a></b> = <span title="0">0 </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="brokerAttached"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">brokerAttached</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>reference</span>,
<span class=sig-arg>identity</span>,
<span class=sig-arg>broker</span>)</span>
</h3>
<p>An intermediary method to override.</p>
Normally you will want to use 'attached', as described in <a
href="twisted.cred.perspective.Perspective.html"
class="link"><code>twisted.cred.perspective.Perspective</code></a>.attached;
however, this method serves the same purpose, and in some
circumstances, you are sure that the protocol that objects will be
attaching to your Perspective with is Perspective Broker, and in that
case you may wish to get the Broker object they are connecting with,
for example, to determine what host they are connecting from. Bear in
mind that when overriding this method, other, non-PB protocols will not
notify you of being attached or detached.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="brokerDetached"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">brokerDetached</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>reference</span>,
<span class=sig-arg>identity</span>,
<span class=sig-arg>broker</span>)</span>
</h3>
See <a href="twisted.spread.pb.Perspective.html#brokerAttached"
class="link"><code>brokerAttached</code></a>.
<dl><dt></dt><dd>
</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:31 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>