twisted.spread.pb.Service.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.Service</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 Service
</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.Service.html" target="_top">no frames</a>]</font></td></tr>
</table></td>
</tr></table>
<!-- =========== START OF CLASS DESCRIPTION =========== -->
<h2 class="class">Class Service</h2>
<pre class="base-tree">
<a href="twisted.python.reflect.Accessor.html"><code>Accessor</code></a> --+
|
<a href="twisted.persisted.styles.Versioned.html"><code>Versioned</code></a> --+
|
<a href="twisted.internet.app.ApplicationService.html"><code>ApplicationService</code></a> --+
|
<a href="twisted.cred.service.Service.html"><code>Service</code></a> --+
|
<b>Service</b>
</pre><br />
<dl><dt><b>Known Subclasses:</b></dt>
<dd>
<a href="twisted.words.service.Service.html"><code>Service</code></a></dd></dl>
<hr/>
<p>A service for Perspective Broker.</p>
<p>This class is DEPRECATED, because it relies on old cred APIs.</p>
On this Service, the result of a perspective request must be a <a
href="twisted.spread.pb.Perspective.html"
class="link"><code>pb.Perspective</code></a> rather than a <a
href="twisted.cred.perspective.Perspective.html"
class="link"><code>twisted.cred.perspective.Perspective</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 bgcolor="#e8f0f8" class="group">
<th colspan="2"> Inherited from Service</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.service.Service.html#__init__" class="summary-sig-name"><code>__init__</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>serviceName</span>,
<span class=summary-sig-arg>serviceParent</span>,
<span class=summary-sig-arg>authorizer</span>,
<span class=summary-sig-arg>application</span>)</span></code>
<br />
Create me, attached to the given application.</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.service.Service.html#addPerspective" class="summary-sig-name"><code>addPerspective</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>perspective</span>)</span></code>
<br />
Add a perspective to this 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.service.Service.html#cachePerspective" class="summary-sig-name"><code>cachePerspective</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>perspective</span>)</span></code>
<br />
Cache a perspective loaded from an external data source.</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.service.Service.html#createPerspective" class="summary-sig-name"><code>createPerspective</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>name</span>)</span></code>
<br />
Create a perspective from self.perspectiveClass and add it to this
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.service.Service.html#getPerspectiveForIdentity" class="summary-sig-name"><code>getPerspectiveForIdentity</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>name</span>,
<span class=summary-sig-arg>identity</span>)</span></code>
<br />
A hook to use if the identity is required when getting the
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.service.Service.html#getPerspectiveNamed" class="summary-sig-name"><code>getPerspectiveNamed</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>name</span>)</span></code>
<br />
Return a perspective that represents a user for this 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.service.Service.html#getPerspectiveRequest" class="summary-sig-name"><code>getPerspectiveRequest</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>name</span>)</span></code>
<br />
Return a Deferred which is a request for a perspective on this
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.service.Service.html#getServiceName" class="summary-sig-name"><code>getServiceName</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
The name of this 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.service.Service.html#getServiceType" class="summary-sig-name"><code>getServiceType</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Get a string describing the type of this service.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> Deferred Perspective
</font></td>
<td><code><span class="summary-sig"><a href="twisted.cred.service.Service.html#loadPerspective" class="summary-sig-name"><code>loadPerspective</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>name</span>)</span></code>
<br />
Load a perspective from an external data-source.</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.service.Service.html#setServiceParent" class="summary-sig-name"><code>setServiceParent</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>parent</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.service.Service.html#uncachePerspective" class="summary-sig-name"><code>uncachePerspective</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>perspective</span>)</span></code>
<br />
Uncache a perspective loaded from an external data source.</td></tr>
<tr bgcolor="#e8f0f8" class="group">
<th colspan="2"> Inherited from ApplicationService</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.internet.app.ApplicationService.html#disownServiceParent" class="summary-sig-name"><code>disownServiceParent</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Have my parent disown 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.internet.app.ApplicationService.html#get_application" class="summary-sig-name"><code>get_application</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.internet.app.ApplicationService.html#set_application" class="summary-sig-name"><code>set_application</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>application</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.internet.app.ApplicationService.html#set_application" class="summary-sig-name"><code>setApplication</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>application</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.internet.app.ApplicationService.html#startService" class="summary-sig-name"><code>startService</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
This call is made as a service starts up.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.internet.app.ApplicationService.html#stopService" class="summary-sig-name"><code>stopService</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
This call is made before shutdown.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.internet.app.ApplicationService.html#upgradeToVersion1" class="summary-sig-name"><code>upgradeToVersion1</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
</td></tr>
<tr bgcolor="#e8f0f8" class="group">
<th colspan="2"> Inherited from Accessor</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.python.reflect.Accessor.html#__delattr__" class="summary-sig-name"><code>__delattr__</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>k</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.python.reflect.Accessor.html#__getattr__" class="summary-sig-name"><code>__getattr__</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>k</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.python.reflect.Accessor.html#__setattr__" class="summary-sig-name"><code>__setattr__</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>k</span>,
<span class=summary-sig-arg>v</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.python.reflect.Accessor.html#reallyDel" class="summary-sig-name"><code>reallyDel</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>k</span>)</span></code>
<br />
*actually* del self.k without incurring side-effects.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.python.reflect.Accessor.html#reallySet" class="summary-sig-name"><code>reallySet</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>k</span>,
<span class=summary-sig-arg>v</span>)</span></code>
<br />
*actually* set self.k to v without incurring side-effects.</td></tr>
<tr bgcolor="#e8f0f8" class="group">
<th colspan="2"> Inherited from Versioned</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.Versioned.html#__getstate__" class="summary-sig-name"><code>__getstate__</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>dict</span>)</span></code>
<br />
Get state, adding a version number to it on its way out.</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.Versioned.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>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.persisted.styles.Versioned.html#versionUpgrade" class="summary-sig-name"><code>versionUpgrade</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
(internal) Do a version upgrade.</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>class</code></font></td>
<td><a name="perspectiveClass"></a><b><code>perspectiveClass</code></b> = <a href="twisted.spread.pb.Perspective.html"><code>twisted.spread.pb.Perspective</code></a></td></tr>
<tr bgcolor="#e8f0f8" class="group">
<th colspan="2"> Inherited from Service</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>NoneType</code></font></td>
<td><b><a href="twisted.cred.service.Service.html#serviceName"><code>serviceName</code></a></b> = <span title="None">None </span></td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>NoneType</code></font></td>
<td><b><a href="twisted.cred.service.Service.html#serviceType"><code>serviceType</code></a></b> = <span title="None">None </span></td></tr>
<tr bgcolor="#e8f0f8" class="group">
<th colspan="2"> Inherited from ApplicationService</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td>
<td><b><a href="twisted.internet.app.ApplicationService.html#persistenceVersion"><code>persistenceVersion</code></a></b> = <span title="1">1 </span></td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>NoneType</code></font></td>
<td><b><a href="twisted.internet.app.ApplicationService.html#serviceParent"><code>serviceParent</code></a></b> = <span title="None">None </span></td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td>
<td><b><a href="twisted.internet.app.ApplicationService.html#serviceRunning"><code>serviceRunning</code></a></b> = <span title="0">0 </span></td></tr>
<tr bgcolor="#e8f0f8" class="group">
<th colspan="2"> Inherited from Versioned</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>tuple</code></font></td>
<td><b><a href="twisted.persisted.styles.Versioned.html#persistenceForgets"><code>persistenceForgets</code></a></b> = <span title="()"><code>() </code>
</span></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>