<?xml version="1.0" encoding="ascii"?>
<!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>flumotion.twisted.pb.Avatar</title>
<link rel="stylesheet" href="epydoc.css" type="text/css" />
<script type="text/javascript" src="epydoc.js"></script>
</head>
<body bgcolor="white" text="black" link="blue" vlink="#204080"
alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<th class="navbar" width="100%"></th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<span class="breadcrumbs">
Package flumotion ::
<a href="flumotion.twisted-module.html">Package twisted</a> ::
<a href="flumotion.twisted.pb-module.html">Module pb</a> ::
Class Avatar
</span>
</td>
<td>
<table cellpadding="0" cellspacing="0">
<!-- hide/show private -->
<tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
onclick="toggle_private();">hide private</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class Avatar</h1><p class="nomargin-top"><span class="codelink"><a href="flumotion.twisted.pb-pysrc.html#Avatar">source code</a></span></p>
<pre class="base-tree">
twisted.spread.pb.Avatar --+
|
<a href="flumotion.extern.log.log.Loggable-class.html">extern.log.log.Loggable</a> --+
|
<strong class="uidshort">Avatar</strong>
</pre>
<dl><dt>Known Subclasses:</dt>
<dd>
<ul class="subclass-list">
<li><a href="flumotion.twisted.pb.PingableAvatar-class.html">PingableAvatar</a></li><li>, <a href="flumotion.worker.base.BaseJobAvatar-class.html">worker.base.BaseJobAvatar</a></li><li>, <a href="flumotion.worker.feedserver.FeedAvatar-class.html">worker.feedserver.FeedAvatar</a></li> </ul>
</dd></dl>
<hr />
<!-- ==================== INSTANCE METHODS ==================== -->
<a name="section-InstanceMethods"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Instance Methods</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-InstanceMethods"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="__init__"></a><span class="summary-sig-name">__init__</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">avatarId</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="flumotion.twisted.pb-pysrc.html#Avatar.__init__">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="flumotion.twisted.pb.Avatar-class.html#perspectiveMessageReceived" class="summary-sig-name">perspectiveMessageReceived</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">kwargs</span>)</span><br />
This method is called when a network message is received.</td>
<td align="right" valign="top">
<span class="codelink"><a href="flumotion.twisted.pb-pysrc.html#Avatar.perspectiveMessageReceived">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="perspectiveMessageReceivedUnserialised"></a><span class="summary-sig-name">perspectiveMessageReceivedUnserialised</span>(<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">kwargs</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="flumotion.twisted.pb-pysrc.html#Avatar.perspectiveMessageReceivedUnserialised">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="flumotion.twisted.pb.Avatar-class.html#setMind" class="summary-sig-name">setMind</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">mind</span>)</span><br />
Tell the avatar that the given mind has been attached.</td>
<td align="right" valign="top">
<span class="codelink"><a href="flumotion.twisted.pb-pysrc.html#Avatar.setMind">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="flumotion.twisted.pb.Avatar-class.html#mindCallRemoteLogging" class="summary-sig-name">mindCallRemoteLogging</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">level</span>,
<span class="summary-sig-arg">stackDepth</span>,
<span class="summary-sig-arg">name</span>,
<span class="summary-sig-arg">*args</span>,
<span class="summary-sig-arg">**kwargs</span>)</span><br />
Call the given remote method, and log calling and returning nicely.</td>
<td align="right" valign="top">
<span class="codelink"><a href="flumotion.twisted.pb-pysrc.html#Avatar.mindCallRemoteLogging">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="flumotion.twisted.pb.Avatar-class.html#mindCallRemote" class="summary-sig-name">mindCallRemote</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">name</span>,
<span class="summary-sig-arg">*args</span>,
<span class="summary-sig-arg">**kwargs</span>)</span><br />
Call the given remote method, and log calling and returning nicely.</td>
<td align="right" valign="top">
<span class="codelink"><a href="flumotion.twisted.pb-pysrc.html#Avatar.mindCallRemote">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="flumotion.twisted.pb.Avatar-class.html#disconnect" class="summary-sig-name">disconnect</a>(<span class="summary-sig-arg">self</span>)</span><br />
Disconnect the remote PB client.</td>
<td align="right" valign="top">
<span class="codelink"><a href="flumotion.twisted.pb-pysrc.html#Avatar.disconnect">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code>twisted.spread.pb.Avatar</code></b>:
<code>__providedBy__</code>
</p>
<p class="indent-wrapped-lines"><b>Inherited from <code><a href="flumotion.extern.log.log.Loggable-class.html">extern.log.log.Loggable</a></code></b>:
<code><a href="flumotion.extern.log.log.Loggable-class.html#debug">debug</a></code>,
<code><a href="flumotion.extern.log.log.Loggable-class.html#doLog">doLog</a></code>,
<code><a href="flumotion.extern.log.log.Loggable-class.html#error">error</a></code>,
<code><a href="flumotion.extern.log.log.Loggable-class.html#info">info</a></code>,
<code><a href="flumotion.extern.log.log.Loggable-class.html#log">log</a></code>,
<code><a href="flumotion.extern.log.log.Loggable-class.html#logFunction">logFunction</a></code>,
<code><a href="flumotion.extern.log.log.Loggable-class.html#logObjectName">logObjectName</a></code>,
<code><a href="flumotion.extern.log.log.Loggable-class.html#warning">warning</a></code>,
<code><a href="flumotion.extern.log.log.Loggable-class.html#warningFailure">warningFailure</a></code>,
<code><a href="flumotion.extern.log.log.Loggable-class.html#writeMarker">writeMarker</a></code>
</p>
</td>
</tr>
</table>
<!-- ==================== CLASS VARIABLES ==================== -->
<a name="section-ClassVariables"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Class Variables</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-ClassVariables"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a name="logCategory"></a><span class="summary-name">logCategory</span> = <code title="'avatar'"><code class="variable-quote">'</code><code class="variable-string">avatar</code><code class="variable-quote">'</code></code><br />
Implementors can provide a category to log their messages under.
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">str</span>
</td><td class="summary">
<a name="remoteLogName"></a><span class="summary-name">remoteLogName</span> = <code title="'remote'"><code class="variable-quote">'</code><code class="variable-string">remote</code><code class="variable-quote">'</code></code><br />
name to use to log the other side of the connection
</td>
</tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code>twisted.spread.pb.Avatar</code></b>:
<code>__implemented__</code>,
<code>__provides__</code>
</p>
</td>
</tr>
</table>
<!-- ==================== METHOD DETAILS ==================== -->
<a name="section-MethodDetails"></a>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Method Details</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-MethodDetails"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
</table>
<a name="perspectiveMessageReceived"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">perspectiveMessageReceived</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">broker</span>,
<span class="sig-arg">message</span>,
<span class="sig-arg">args</span>,
<span class="sig-arg">kwargs</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="flumotion.twisted.pb-pysrc.html#Avatar.perspectiveMessageReceived">source code</a></span>
</td>
</tr></table>
<p>This method is called when a network message is received.</p>
<p>This will call:</p>
<pre class="literalblock">
self.perspective_%(message)s(*broker.unserialize(args),
**broker.unserialize(kw))
</pre>
<p>to handle the method; subclasses of Avatar are expected to implement
methods using this naming convention.</p>
<dl class="fields">
<dt>Overrides:
twisted.spread.pb.Avatar.perspectiveMessageReceived
<dd><em class="note">(inherited documentation)</em></dd>
</dt>
</dl>
</td></tr></table>
</div>
<a name="setMind"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">setMind</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">mind</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="flumotion.twisted.pb-pysrc.html#Avatar.setMind">source code</a></span>
</td>
</tr></table>
<p>Tell the avatar that the given mind has been attached. This gives the
avatar a way to call remotely to the client that requested this
avatar.</p>
<p>It is best to call setMind() from within the avatar's __init__ method.
Some old code still does this via a callLater, however.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>mind</code></strong> (<code class="link">twisted.spread.pb.RemoteReference</code>)</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="mindCallRemoteLogging"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">mindCallRemoteLogging</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">level</span>,
<span class="sig-arg">stackDepth</span>,
<span class="sig-arg">name</span>,
<span class="sig-arg">*args</span>,
<span class="sig-arg">**kwargs</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="flumotion.twisted.pb-pysrc.html#Avatar.mindCallRemoteLogging">source code</a></span>
</td>
</tr></table>
<p>Call the given remote method, and log calling and returning
nicely.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>level</code></strong> (int) - the level we should log at (log.DEBUG, log.INFO, etc)</li>
<li><strong class="pname"><code>stackDepth</code></strong> (non-positive int) - the number of stack frames to go back to get file and line
information, negative or zero.</li>
<li><strong class="pname"><code>name</code></strong> (str) - name of the remote method</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="mindCallRemote"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">mindCallRemote</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">name</span>,
<span class="sig-arg">*args</span>,
<span class="sig-arg">**kwargs</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="flumotion.twisted.pb-pysrc.html#Avatar.mindCallRemote">source code</a></span>
</td>
</tr></table>
<p>Call the given remote method, and log calling and returning
nicely.</p>
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>name</code></strong> (str) - name of the remote method</li>
</ul></dd>
</dl>
</td></tr></table>
</div>
<a name="disconnect"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">disconnect</span>(<span class="sig-arg">self</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="flumotion.twisted.pb-pysrc.html#Avatar.disconnect">source code</a></span>
</td>
</tr></table>
<p>Disconnect the remote PB client. If we are already disconnected, do
nothing.</p>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<th class="navbar" width="100%"></th>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
Generated by Epydoc 3.0.1 on Sun Sep 13 13:14:16 2009
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
>http://epydoc.sourceforge.net</a>
</td>
</tr>
</table>
<script type="text/javascript">
<!--
// Private objects are initially displayed (because if
// javascript is turned off then we want them to be
// visible); but by default, we want to hide them. So hide
// them unless we have a cookie that says to show them.
checkCookie();
// -->
</script>
</body>
</html>
distrib
>
Mandriva
>
2010.1
>
x86_64
>
media
>
contrib-release
>
by-pkgid
>
2eca861f24be6048290ed27335ec22aa
>
files
>
1297
