twisted.manhole.service.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.manhole.service.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">&nbsp;&nbsp;&nbsp;<a class="navbar" href="twisted.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="trees.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="indices.html">Index</a>&nbsp;&nbsp;&nbsp;</th>
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</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&nbsp;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&nbsp;twisted</a> ::
        <a href="twisted.manhole.html">Package&nbsp;manhole</a> ::
        <a href="twisted.manhole.service.html">Module&nbsp;service</a> ::
        Class&nbsp;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>&nbsp;|&nbsp;<a href="twisted.manhole.service.Perspective.html" target="_top">no&nbsp;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> --+
         |
        <b>Perspective</b>
</pre><br />

<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">&nbsp;</font></td>
  <td><code><a name="__init__"></a><span class="summary-sig"><span class="summary-sig-name">__init__</span>(<span class=summary-sig-arg>self</span>,
          <span class=summary-sig-arg>service</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><a name="__getstate__"></a><span class="summary-sig"><span class="summary-sig-name">__getstate__</span>(<span class=summary-sig-arg>self</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><a name="_cbClientCapable"></a><span class="summary-sig"><span class="summary-sig-name">_cbClientCapable</span>(<span class=summary-sig-arg>self</span>,
          <span class=summary-sig-arg>capabilities</span>,
          <span class=summary-sig-arg>client</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><a name="_cbResult"></a><span class="summary-sig"><span class="summary-sig-name">_cbResult</span>(<span class=summary-sig-arg>self</span>,
          <span class=summary-sig-arg>val</span>,
          <span class=summary-sig-arg>dnum</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><a name="_ebClientCapable"></a><span class="summary-sig"><span class="summary-sig-name">_ebClientCapable</span>(<span class=summary-sig-arg>self</span>,
          <span class=summary-sig-arg>reason</span>,
          <span class=summary-sig-arg>client</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><span class="summary-sig"><a href="twisted.manhole.service.Perspective.html#attached" class="summary-sig-name"><code>attached</code></a>(<span class=summary-sig-arg>self</span>,
          <span class=summary-sig-arg>client</span>,
          <span class=summary-sig-arg>identity</span>)</span></code>
<br />
A client has attached -- welcome them and add them to the list.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><span class="summary-sig"><a href="twisted.manhole.service.Perspective.html#console" class="summary-sig-name"><code>console</code></a>(<span class=summary-sig-arg>self</span>,
          <span class=summary-sig-arg>message</span>)</span></code>
<br />
Pass a message to my clients' console.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><a name="detached"></a><span class="summary-sig"><span class="summary-sig-name">detached</span>(<span class=summary-sig-arg>self</span>,
          <span class=summary-sig-arg>client</span>,
          <span class=summary-sig-arg>identity</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><span class="summary-sig"><a href="twisted.manhole.service.Perspective.html#perspective_do" class="summary-sig-name"><code>perspective_do</code></a>(<span class=summary-sig-arg>self</span>,
          <span class=summary-sig-arg>expr</span>)</span></code>
<br />
Evaluate the given expression, with output to the console.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><span class="summary-sig"><a href="twisted.manhole.service.Perspective.html#perspective_explore" class="summary-sig-name"><code>perspective_explore</code></a>(<span class=summary-sig-arg>self</span>,
          <span class=summary-sig-arg>identifier</span>)</span></code>
<br />
Browse the object obtained by evaluating the identifier.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><span class="summary-sig"><a href="twisted.manhole.service.Perspective.html#perspective_watch" class="summary-sig-name"><code>perspective_watch</code></a>(<span class=summary-sig-arg>self</span>,
          <span class=summary-sig-arg>identifier</span>)</span></code>
<br />
Watch the object obtained by evaluating the identifier.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><span class="summary-sig"><a href="twisted.manhole.service.Perspective.html#receiveExplorer" class="summary-sig-name"><code>receiveExplorer</code></a>(<span class=summary-sig-arg>self</span>,
          <span class=summary-sig-arg>objectLink</span>)</span></code>
<br />
Pass an Explorer on to my clients.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
  <td><code><span class="summary-sig"><a href="twisted.manhole.service.Perspective.html#runInConsole" class="summary-sig-name"><code>runInConsole</code></a>(<span class=summary-sig-arg>self</span>,
          <span class=summary-sig-arg>command</span>,
          <span class="summary-sig-vararg">*args</span>,
          <span class="summary-sig-kwarg">**kw</span>)</span></code>
<br />
Convience method to &quot;runInConsole with my stuff&quot;.</td></tr>
<tr bgcolor="#e8f0f8" class="group">
  <th colspan="2">&nbsp;&nbsp;&nbsp;&nbsp;Inherited from Avatar</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</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><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td>
<td><b><a href="twisted.manhole.service.Perspective.html#lastDeferred"><code>lastDeferred</code></a></b> = <span title="0">0&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</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="attached"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
  <h3><span class="sig"><span class="sig-name">attached</span>(<span class=sig-arg>self</span>,
          <span class=sig-arg>client</span>,
          <span class=sig-arg>identity</span>)</span>
  </h3>
  A client has attached -- welcome them and add them to the list.
  <dl><dt></dt><dd>
  </dd></dl>
</td></tr></table>

<a name="console"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
  <h3><span class="sig"><span class="sig-name">console</span>(<span class=sig-arg>self</span>,
          <span class=sig-arg>message</span>)</span>
  </h3>
  Pass a message to my clients' console.
  <dl><dt></dt><dd>
  </dd></dl>
</td></tr></table>

<a name="perspective_do"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
  <h3><span class="sig"><span class="sig-name">perspective_do</span>(<span class=sig-arg>self</span>,
          <span class=sig-arg>expr</span>)</span>
  </h3>
  <p>Evaluate the given expression, with output to the console.</p>
  The result is stored in the local variable '_', and its repr() 
  string is sent to the console as a &quot;result&quot; message.
  <dl><dt></dt><dd>
  </dd></dl>
</td></tr></table>

<a name="perspective_explore"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
  <h3><span class="sig"><span class="sig-name">perspective_explore</span>(<span class=sig-arg>self</span>,
          <span class=sig-arg>identifier</span>)</span>
  </h3>
  <p>Browse the object obtained by evaluating the identifier.</p>
  The resulting ObjectLink is passed back through the client's 
  receiveBrowserObject method.
  <dl><dt></dt><dd>
  </dd></dl>
</td></tr></table>

<a name="perspective_watch"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
  <h3><span class="sig"><span class="sig-name">perspective_watch</span>(<span class=sig-arg>self</span>,
          <span class=sig-arg>identifier</span>)</span>
  </h3>
  <p>Watch the object obtained by evaluating the identifier.</p>
  Whenever I think this object might have changed, I will pass an 
  ObjectLink of it back to the client's receiveBrowserObject method.
  <dl><dt></dt><dd>
  </dd></dl>
</td></tr></table>

<a name="receiveExplorer"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
  <h3><span class="sig"><span class="sig-name">receiveExplorer</span>(<span class=sig-arg>self</span>,
          <span class=sig-arg>objectLink</span>)</span>
  </h3>
  Pass an Explorer on to my clients.
  <dl><dt></dt><dd>
  </dd></dl>
</td></tr></table>

<a name="runInConsole"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
  <h3><span class="sig"><span class="sig-name">runInConsole</span>(<span class=sig-arg>self</span>,
          <span class=sig-arg>command</span>,
          <span class="sig-vararg">*args</span>,
          <span class="sig-kwarg">**kw</span>)</span>
  </h3>
  Convience method to &quot;runInConsole with my stuff&quot;.
  <dl><dt></dt><dd>
  </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="lastDeferred"></a>
<h3>lastDeferred</h3>
<dl>
  <dt></dt>
  <dd>
    <dl>
      <dt><b>Type:</b></dt>
      <dd>
          <code>int</code>

      </dd>
<span title="0">      <dt><b>Value:</b></dt>
      <dd><table><tr><td>
<pre class="variable">
0&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</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">&nbsp;&nbsp;&nbsp;<a class="navbar" href="twisted.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="trees.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="indices.html">Index</a>&nbsp;&nbsp;&nbsp;</th>
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</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&nbsp;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:41 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>