~certify-web-dev/twisted/certify-trunk

« back to all changes in this revision

Viewing changes to doc/api/twisted.manhole.explorer.ExplorerClass.html

  • Committer: Bazaar Package Importer
  • Author(s): Matthias Klose
  • Date: 2004-06-21 22:01:11 UTC
  • mto: (2.2.3 sid)
  • mto: This revision was merged to the branch mainline in revision 3.
  • Revision ID: james.westby@ubuntu.com-20040621220111-vkf909euqnyrp3nr
Tags: upstream-1.3.0
ImportĀ upstreamĀ versionĀ 1.3.0

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
<?xml version="1.0" encoding="iso-8859-1"?>
 
2
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
 
3
          "DTD/xhtml1-transitional.dtd">
 
4
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
 
5
<head>
 
6
  <title>twisted.manhole.explorer.ExplorerClass</title>
 
7
  <link rel="stylesheet" href="epydoc.css" type="text/css"></link>
 
8
</head>
 
9
<body bgcolor="white" text="black" link="blue" vlink="#204080"
 
10
      alink="#204080">
 
11
 
 
12
<!-- =========== START OF NAVBAR =========== -->
 
13
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
 
14
  <tr valign="center">
 
15
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="twisted.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
 
16
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="trees.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
 
17
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="indices.html">Index</a>&nbsp;&nbsp;&nbsp;</th>
 
18
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
 
19
    <th class="navbar" align="right" width="100%">
 
20
      <table border="0" cellpadding="0" cellspacing="0">
 
21
      <tr><th class="navbar" align="center">
 
22
        <p class="nomargin">
 
23
          <a class="navbar" target="_top" href="http://twistedmatrix.com/">Twisted&nbsp;1.3.0rc1</a>
 
24
      </p></th></tr></table>
 
25
    </th>
 
26
  </tr>
 
27
</table>
 
28
<table width="100%" cellpadding="0" cellspacing="0">
 
29
  <tr valign="top">
 
30
    <td width="100%">
 
31
      <font size="-1"><b class="breadcrumbs">
 
32
        <a href="twisted.html">Package&nbsp;twisted</a> ::
 
33
        <a href="twisted.manhole.html">Package&nbsp;manhole</a> ::
 
34
        <a href="twisted.manhole.explorer.html">Module&nbsp;explorer</a> ::
 
35
        Class&nbsp;ExplorerClass
 
36
      </b></font></br>
 
37
    </td>
 
38
    <td><table cellpadding="0" cellspacing="0">
 
39
      <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a>&nbsp;|&nbsp;<a href="twisted.manhole.explorer.ExplorerClass.html" target="_top">no&nbsp;frames</a>]</font></td></tr>
 
40
    </table></td>
 
41
</tr></table>
 
42
 
 
43
<!-- =========== START OF CLASS DESCRIPTION =========== -->
 
44
<h2 class="class">Class ExplorerClass</h2>
 
45
 
 
46
<pre class="base-tree">
 
47
<a href="twisted.spread.jelly.Jellyable.html"><code>Jellyable</code></a> --+                
 
48
            |                
 
49
 <a href="twisted.spread.flavors.Serializable.html"><code>Serializable</code></a> --+            
 
50
                |            
 
51
         <a href="twisted.spread.flavors.Copyable.html"><code>Copyable</code></a> --+        
 
52
                    |        
 
53
            <a href="twisted.spread.flavors.Cacheable.html"><code>Cacheable</code></a> --+    
 
54
                        |    
 
55
                 <a href="twisted.manhole.explorer.Explorer.html"><code>Explorer</code></a> --+
 
56
                            |
 
57
                           <b>ExplorerClass</b>
 
58
</pre><br />
 
59
 
 
60
<hr/>
 
61
 
 
62
<hr/>
 
63
 
 
64
 
 
65
<!-- =========== START OF METHOD SUMMARY =========== -->
 
66
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
 
67
<tr bgcolor="#70b0f0" class="summary">
 
68
  <th colspan="2">Method Summary</th></tr>
 
69
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
70
  <td><code><a name="__init__"></a><span class="summary-sig"><span class="summary-sig-name">__init__</span>(<span class=summary-sig-arg>self</span>,
 
71
          <span class=summary-sig-arg>theClass</span>,
 
72
          <span class=summary-sig-arg>identifier</span>)</span></code>
 
73
</td></tr>
 
74
<tr bgcolor="#e8f0f8" class="group">
 
75
  <th colspan="2">&nbsp;&nbsp;&nbsp;&nbsp;Inherited from Explorer</th></tr>
 
76
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
77
  <td><code><span class="summary-sig"><a href="twisted.manhole.explorer.Explorer.html#getStateToCopyFor" class="summary-sig-name"><code>getStateToCopyFor</code></a>(<span class=summary-sig-arg>self</span>,
 
78
          <span class=summary-sig-arg>perspective</span>)</span></code>
 
79
<br />
 
80
Gather state to send when I am serialized for a particular 
 
81
perspective.</td></tr>
 
82
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
83
  <td><code><span class="summary-sig"><a href="twisted.manhole.explorer.Explorer.html#view_get_refcount" class="summary-sig-name"><code>view_get_refcount</code></a>(<span class=summary-sig-arg>self</span>,
 
84
          <span class=summary-sig-arg>perspective</span>)</span></code>
 
85
</td></tr>
 
86
<tr bgcolor="#e8f0f8" class="group">
 
87
  <th colspan="2">&nbsp;&nbsp;&nbsp;&nbsp;Inherited from Cacheable</th></tr>
 
88
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
89
  <td><code><span class="summary-sig"><a href="twisted.spread.flavors.Cacheable.html#getStateToCacheAndObserveFor" class="summary-sig-name"><code>getStateToCacheAndObserveFor</code></a>(<span class=summary-sig-arg>self</span>,
 
90
          <span class=summary-sig-arg>perspective</span>,
 
91
          <span class=summary-sig-arg>observer</span>)</span></code>
 
92
<br />
 
93
Get state to cache on the client and client-cache reference to observe 
 
94
locally.</td></tr>
 
95
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
96
  <td><code><span class="summary-sig"><a href="twisted.spread.flavors.Cacheable.html#jellyFor" class="summary-sig-name"><code>jellyFor</code></a>(<span class=summary-sig-arg>self</span>,
 
97
          <span class=summary-sig-arg>jellier</span>)</span></code>
 
98
<br />
 
99
Return an appropriate tuple to serialize me.</td></tr>
 
100
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
101
  <td><code><span class="summary-sig"><a href="twisted.spread.flavors.Cacheable.html#stoppedObserving" class="summary-sig-name"><code>stoppedObserving</code></a>(<span class=summary-sig-arg>self</span>,
 
102
          <span class=summary-sig-arg>perspective</span>,
 
103
          <span class=summary-sig-arg>observer</span>)</span></code>
 
104
<br />
 
105
This method is called when a client has stopped observing me.</td></tr>
 
106
<tr bgcolor="#e8f0f8" class="group">
 
107
  <th colspan="2">&nbsp;&nbsp;&nbsp;&nbsp;Inherited from Copyable</th></tr>
 
108
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
109
  <td><code><span class="summary-sig"><a href="twisted.spread.flavors.Copyable.html#getStateToCopy" class="summary-sig-name"><code>getStateToCopy</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
 
110
<br />
 
111
Gather state to send when I am serialized for a peer.</td></tr>
 
112
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
113
  <td><code><span class="summary-sig"><a href="twisted.spread.flavors.Copyable.html#getTypeToCopy" class="summary-sig-name"><code>getTypeToCopy</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
 
114
<br />
 
115
Determine what type tag to send for me.</td></tr>
 
116
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
117
  <td><code><span class="summary-sig"><a href="twisted.spread.flavors.Copyable.html#getTypeToCopyFor" class="summary-sig-name"><code>getTypeToCopyFor</code></a>(<span class=summary-sig-arg>self</span>,
 
118
          <span class=summary-sig-arg>perspective</span>)</span></code>
 
119
<br />
 
120
Determine what type tag to send for me.</td></tr>
 
121
<tr bgcolor="#e8f0f8" class="group">
 
122
  <th colspan="2">&nbsp;&nbsp;&nbsp;&nbsp;Inherited from Serializable</th></tr>
 
123
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
124
  <td><code><span class="summary-sig"><a href="twisted.spread.flavors.Serializable.html#processUniqueID" class="summary-sig-name"><code>processUniqueID</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
 
125
<br />
 
126
Return an ID which uniquely represents this object for this 
 
127
process.</td></tr>
 
128
<tr bgcolor="#e8f0f8" class="group">
 
129
  <th colspan="2">&nbsp;&nbsp;&nbsp;&nbsp;Inherited from Jellyable</th></tr>
 
130
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
131
  <td><code><span class="summary-sig"><a href="twisted.spread.jelly.Jellyable.html#getStateFor" class="summary-sig-name"><code>getStateFor</code></a>(<span class=summary-sig-arg>self</span>,
 
132
          <span class=summary-sig-arg>jellier</span>)</span></code>
 
133
</td></tr>
 
134
</table><br />
 
135
 
 
136
 
 
137
<!-- =========== START OF INSTANCE VARIABLE SUMMARY =========== -->
 
138
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
 
139
<tr bgcolor="#70b0f0" class="summary">
 
140
  <th colspan="2">Instance Variable Summary</th></tr>
 
141
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
142
<td><b><a href="twisted.manhole.explorer.ExplorerClass.html#bases"><code>bases</code></a></b>: a list of this class's base classes.</td></tr>
 
143
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
144
<td><b><a href="twisted.manhole.explorer.ExplorerClass.html#doc"><code>doc</code></a></b>: the class's docstring</td></tr>
 
145
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
146
<td><b><a href="twisted.manhole.explorer.ExplorerClass.html#module"><code>module</code></a></b>: the module the class is defined in</td></tr>
 
147
<tr><td align="right" valign="top" width="15%"><font size="-1">&nbsp;</font></td>
 
148
<td><b><a href="twisted.manhole.explorer.ExplorerClass.html#name"><code>name</code></a></b>: the name the class was defined with</td></tr>
 
149
</table><br />
 
150
 
 
151
 
 
152
<!-- =========== START OF CLASS VARIABLE SUMMARY =========== -->
 
153
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
 
154
<tr bgcolor="#70b0f0" class="summary">
 
155
  <th colspan="2">Class Variable Summary</th></tr>
 
156
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>list</code></font></td>
 
157
<td><b><a href="twisted.manhole.explorer.ExplorerClass.html#attributeGroups"><code>attributeGroups</code></a></b> = <span title="['methods', 'data']"><code>['methods',&nbsp;'data']                    </code>
 
158
</span></td></tr>
 
159
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>list</code></font></td>
 
160
<td><b><a href="twisted.manhole.explorer.ExplorerClass.html#properties"><code>properties</code></a></b> = <span title="['name', 'doc', 'bases', 'module']"><code>['name',&nbsp;'doc',&nbsp;'bases',&nbsp;'module']          </code>
 
161
</span></td></tr>
 
162
<tr bgcolor="#e8f0f8" class="group">
 
163
  <th colspan="2">&nbsp;&nbsp;&nbsp;&nbsp;Inherited from Explorer</th></tr>
 
164
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>list</code></font></td>
 
165
<td><b><a href="twisted.manhole.explorer.Explorer.html#accessors"><code>accessors</code></a></b> = <span title="['get_refcount']"><code>['get_refcount']                             </code>
 
166
</span></td></tr>
 
167
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>NoneType</code></font></td>
 
168
<td><b><a href="twisted.manhole.explorer.Explorer.html#id"><code>id</code></a></b> = <span title="None">None&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>
 
169
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>NoneType</code></font></td>
 
170
<td><b><a href="twisted.manhole.explorer.Explorer.html#identifier"><code>identifier</code></a></b> = <span title="None">None&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>
 
171
<tr bgcolor="#e8f0f8" class="group">
 
172
  <th colspan="2">&nbsp;&nbsp;&nbsp;&nbsp;Inherited from Jellyable</th></tr>
 
173
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>tuple</code></font></td>
 
174
<td><b><a href="twisted.spread.jelly.Jellyable.html#__implements__"><code>__implements__</code></a></b> = <span title="(&lt;class twisted.spread.interfaces.IJellyable at 0x840e324&gt;,)"><code>(&lt;class&nbsp;twisted.spread.interfaces.IJell<span class="variable-ellipsis">...</span></code>
 
175
</span></td></tr>
 
176
</table><br />
 
177
 
 
178
 
 
179
<!-- =========== START OF INSTANCE VARIABLE DETAILS =========== -->
 
180
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
 
181
<tr bgcolor="#70b0f0" class="details">
 
182
  <th colspan="2">Instance Variable Details</th></tr>
 
183
</table>
 
184
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
 
185
<a name="bases"></a>
 
186
<h3>bases</h3>
 
187
a list of this class's base classes.
 
188
</td></tr></table>
 
189
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
 
190
<a name="doc"></a>
 
191
<h3>doc</h3>
 
192
the class's docstring
 
193
</td></tr></table>
 
194
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
 
195
<a name="module"></a>
 
196
<h3>module</h3>
 
197
<p>the module the class is defined in</p>
 
198
Attribute groups:
 
199
<ul>
 
200
  <li>
 
201
    <b>methods</b> -- class methods
 
202
  </li>
 
203
  <li>
 
204
    <b>data</b> -- other members of the class
 
205
  </li>
 
206
</ul>
 
207
</td></tr></table>
 
208
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
 
209
<a name="name"></a>
 
210
<h3>name</h3>
 
211
the name the class was defined with
 
212
</td></tr></table>
 
213
<br />
 
214
 
 
215
 
 
216
<!-- =========== START OF CLASS VARIABLE DETAILS =========== -->
 
217
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
 
218
<tr bgcolor="#70b0f0" class="details">
 
219
  <th colspan="2">Class Variable Details</th></tr>
 
220
</table>
 
221
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
 
222
<a name="attributeGroups"></a>
 
223
<h3>attributeGroups</h3>
 
224
<dl>
 
225
  <dt></dt>
 
226
  <dd>
 
227
    <dl>
 
228
      <dt><b>Type:</b></dt>
 
229
      <dd>
 
230
          <code>list</code>
 
231
 
 
232
      </dd>
 
233
<span title="['methods', 'data']">      <dt><b>Value:</b></dt>
 
234
      <dd><table><tr><td>
 
235
<pre class="variable">
 
236
['methods', 'data']                                                    </pre>
 
237
        </td></tr></table></dd>
 
238
</span>    </dl>
 
239
  </dd>
 
240
</dl></td></tr></table>
 
241
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
 
242
<a name="properties"></a>
 
243
<h3>properties</h3>
 
244
<dl>
 
245
  <dt></dt>
 
246
  <dd>
 
247
    <dl>
 
248
      <dt><b>Type:</b></dt>
 
249
      <dd>
 
250
          <code>list</code>
 
251
 
 
252
      </dd>
 
253
<span title="['name', 'doc', 'bases', 'module']">      <dt><b>Value:</b></dt>
 
254
      <dd><table><tr><td>
 
255
<pre class="variable">
 
256
['name', 'doc', 'bases', 'module']                                     </pre>
 
257
        </td></tr></table></dd>
 
258
</span>    </dl>
 
259
  </dd>
 
260
</dl></td></tr></table>
 
261
<br />
 
262
 
 
263
 
 
264
<!-- =========== START OF NAVBAR =========== -->
 
265
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
 
266
  <tr valign="center">
 
267
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="twisted.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
 
268
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="trees.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
 
269
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="indices.html">Index</a>&nbsp;&nbsp;&nbsp;</th>
 
270
    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
 
271
    <th class="navbar" align="right" width="100%">
 
272
      <table border="0" cellpadding="0" cellspacing="0">
 
273
      <tr><th class="navbar" align="center">
 
274
        <p class="nomargin">
 
275
          <a class="navbar" target="_top" href="http://twistedmatrix.com/">Twisted&nbsp;1.3.0rc1</a>
 
276
      </p></th></tr></table>
 
277
    </th>
 
278
  </tr>
 
279
</table>
 
280
 
 
281
<table border="0" cellpadding="0" cellspacing="0" width="100%">
 
282
  <tr>
 
283
    <td align="left"><font size="-2">Generated by Epydoc 2.0 on Sat May 15 20:07:50 2004</font></td>
 
284
    <td align="right"><a href="http://epydoc.sourceforge.net"
 
285
                      ><font size="-2">http://epydoc.sf.net</font></a></td>
 
286
  </tr>
 
287
</table>
 
288
</body>
 
289
</html>