twisted.spread.pb.IdentityConnector.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.IdentityConnector</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 IdentityConnector
</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.IdentityConnector.html" target="_top">no frames</a>]</font></td></tr>
</table></td>
</tr></table>
<!-- =========== START OF CLASS DESCRIPTION =========== -->
<h2 class="class">Class IdentityConnector</h2>
<hr/>
<p>DEPRECATED.</p>
I support connecting to multiple Perspective Broker services that are
in a service tree.
<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.IdentityConnector.html#__init__" class="summary-sig-name"><code>__init__</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>host</span>,
<span class=summary-sig-arg>port</span>,
<span class=summary-sig-arg>identityName</span>,
<span class=summary-sig-arg>password</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="_cbGotAuthRoot"></a><span class="summary-sig"><span class="summary-sig-name">_cbGotAuthRoot</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>authroot</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="_cbGotIdentity"></a><span class="summary-sig"><span class="summary-sig-name">_cbGotIdentity</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>i</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="_ebGotIdentity"></a><span class="summary-sig"><span class="summary-sig-name">_ebGotIdentity</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>e</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.spread.pb.IdentityConnector.html#disconnect" class="summary-sig-name"><code>disconnect</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Lose my connection to the server.</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.IdentityConnector.html#requestLogin" class="summary-sig-name"><code>requestLogin</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Attempt to authenticate about the PB server, but don't request any
services, yet.</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.IdentityConnector.html#requestService" class="summary-sig-name"><code>requestService</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>serviceName</span>,
<span class=summary-sig-arg>perspectiveName</span>,
<span class=summary-sig-arg>client</span>)</span></code>
<br />
Request a perspective on the specified service.</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>host</span>,
<span class=sig-arg>port</span>,
<span class=sig-arg>identityName</span>,
<span class=sig-arg>password</span>)</span>
<br /><i>(Constructor)</i>
</h3>
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>host</b></code> -
The host to connect to or the PB server. If this is
<code>"unix"</code>, then a UNIX socket will be used
rather than a TCP socket.
<br /><i>
(type=<code>string</code>)</i>
<dd><code><b>port</b></code> -
The port to connect to for the PB server.
<br /><i>
(type=<code>integer</code>)</i>
<dd><code><b>identityName</b></code> -
The name of the identity to use to autheticate with the PB
server.
<br /><i>
(type=<code>string</code>)</i>
<dd><code><b>password</b></code> -
The password to use to autheticate with the PB server.
<br /><i>
(type=<code>string</code>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="disconnect"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">disconnect</span>(<span class=sig-arg>self</span>)</span>
</h3>
<p>Lose my connection to the server.</p>
Useful to free up resources if you've completed requestLogin but
then change your mind.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="requestLogin"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">requestLogin</span>(<span class=sig-arg>self</span>)</span>
</h3>
Attempt to authenticate about the PB server, but don't request any
services, yet.
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
<a href="twisted.spread.pb.IdentityWrapper.html"
class="link"><code>IdentityWrapper</code></a>
<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="requestService"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">requestService</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>serviceName</span>,
<span class=sig-arg>perspectiveName</span>=<span class=sig-default>None</span>,
<span class=sig-arg>client</span>=<span class=sig-default>None</span>)</span>
</h3>
Request a perspective on the specified service. This will
authenticate against the server as well if <a
href="twisted.spread.pb.IdentityConnector.html#requestLogin"
class="link"><code>requestLogin</code></a> hasn't already been
called.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>serviceName</b></code> -
The name of the service to obtain a perspective for.
<br /><i>
(type=<code>string</code>)</i>
<dd><code><b>perspectiveName</b></code> -
If specified, the name of the perspective to obtain.
Otherwise, default to the name of the identity.
<br /><i>
(type=<code>string</code>)</i>
<dd><code><b>client</b></code> -
The client object to attach to the perspective.
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
A deferred which will receive a callback with the
perspective.
<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>
<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:23 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>