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">
6
<title>twisted.manhole.explorer.ExplorerClass</title>
7
<link rel="stylesheet" href="epydoc.css" type="text/css"></link>
9
<body bgcolor="white" text="black" link="blue" vlink="#204080"
12
<!-- =========== START OF NAVBAR =========== -->
13
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
15
<th class="navbar"> <a class="navbar" href="twisted.html">Home</a> </th>
16
<th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>
17
<th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
18
<th class="navbar"> <a class="navbar" href="help.html">Help</a> </th>
19
<th class="navbar" align="right" width="100%">
20
<table border="0" cellpadding="0" cellspacing="0">
21
<tr><th class="navbar" align="center">
23
<a class="navbar" target="_top" href="http://twistedmatrix.com/">Twisted 1.3.0rc1</a>
24
</p></th></tr></table>
28
<table width="100%" cellpadding="0" cellspacing="0">
31
<font size="-1"><b class="breadcrumbs">
32
<a href="twisted.html">Package twisted</a> ::
33
<a href="twisted.manhole.html">Package manhole</a> ::
34
<a href="twisted.manhole.explorer.html">Module explorer</a> ::
35
Class ExplorerClass
38
<td><table cellpadding="0" cellspacing="0">
39
<tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="twisted.manhole.explorer.ExplorerClass.html" target="_top">no frames</a>]</font></td></tr>
43
<!-- =========== START OF CLASS DESCRIPTION =========== -->
44
<h2 class="class">Class ExplorerClass</h2>
46
<pre class="base-tree">
47
<a href="twisted.spread.jelly.Jellyable.html"><code>Jellyable</code></a> --+
49
<a href="twisted.spread.flavors.Serializable.html"><code>Serializable</code></a> --+
51
<a href="twisted.spread.flavors.Copyable.html"><code>Copyable</code></a> --+
53
<a href="twisted.spread.flavors.Cacheable.html"><code>Cacheable</code></a> --+
55
<a href="twisted.manhole.explorer.Explorer.html"><code>Explorer</code></a> --+
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"> </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>
74
<tr bgcolor="#e8f0f8" class="group">
75
<th colspan="2"> Inherited from Explorer</th></tr>
76
<tr><td align="right" valign="top" width="15%"><font size="-1"> </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>
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"> </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>
86
<tr bgcolor="#e8f0f8" class="group">
87
<th colspan="2"> Inherited from Cacheable</th></tr>
88
<tr><td align="right" valign="top" width="15%"><font size="-1"> </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>
93
Get state to cache on the client and client-cache reference to observe
95
<tr><td align="right" valign="top" width="15%"><font size="-1"> </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>
99
Return an appropriate tuple to serialize me.</td></tr>
100
<tr><td align="right" valign="top" width="15%"><font size="-1"> </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>
105
This method is called when a client has stopped observing me.</td></tr>
106
<tr bgcolor="#e8f0f8" class="group">
107
<th colspan="2"> Inherited from Copyable</th></tr>
108
<tr><td align="right" valign="top" width="15%"><font size="-1"> </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>
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"> </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>
115
Determine what type tag to send for me.</td></tr>
116
<tr><td align="right" valign="top" width="15%"><font size="-1"> </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>
120
Determine what type tag to send for me.</td></tr>
121
<tr bgcolor="#e8f0f8" class="group">
122
<th colspan="2"> Inherited from Serializable</th></tr>
123
<tr><td align="right" valign="top" width="15%"><font size="-1"> </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>
126
Return an ID which uniquely represents this object for this
128
<tr bgcolor="#e8f0f8" class="group">
129
<th colspan="2"> Inherited from Jellyable</th></tr>
130
<tr><td align="right" valign="top" width="15%"><font size="-1"> </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>
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"> </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"> </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"> </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"> </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>
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', 'data'] </code>
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', 'doc', 'bases', 'module'] </code>
162
<tr bgcolor="#e8f0f8" class="group">
163
<th colspan="2"> 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>
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 </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 </span></td></tr>
171
<tr bgcolor="#e8f0f8" class="group">
172
<th colspan="2"> 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="(<class twisted.spread.interfaces.IJellyable at 0x840e324>,)"><code>(<class twisted.spread.interfaces.IJell<span class="variable-ellipsis">...</span></code>
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>
184
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
187
a list of this class's base classes.
189
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
192
the class's docstring
194
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
195
<a name="module"></a>
197
<p>the module the class is defined in</p>
201
<b>methods</b> -- class methods
204
<b>data</b> -- other members of the class
208
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
211
the name the class was defined with
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>
221
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
222
<a name="attributeGroups"></a>
223
<h3>attributeGroups</h3>
228
<dt><b>Type:</b></dt>
233
<span title="['methods', 'data']"> <dt><b>Value:</b></dt>
235
<pre class="variable">
236
['methods', 'data'] </pre>
237
</td></tr></table></dd>
240
</dl></td></tr></table>
241
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
242
<a name="properties"></a>
248
<dt><b>Type:</b></dt>
253
<span title="['name', 'doc', 'bases', 'module']"> <dt><b>Value:</b></dt>
255
<pre class="variable">
256
['name', 'doc', 'bases', 'module'] </pre>
257
</td></tr></table></dd>
260
</dl></td></tr></table>
264
<!-- =========== START OF NAVBAR =========== -->
265
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
267
<th class="navbar"> <a class="navbar" href="twisted.html">Home</a> </th>
268
<th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>
269
<th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
270
<th class="navbar"> <a class="navbar" href="help.html">Help</a> </th>
271
<th class="navbar" align="right" width="100%">
272
<table border="0" cellpadding="0" cellspacing="0">
273
<tr><th class="navbar" align="center">
275
<a class="navbar" target="_top" href="http://twistedmatrix.com/">Twisted 1.3.0rc1</a>
276
</p></th></tr></table>
281
<table border="0" cellpadding="0" cellspacing="0" width="100%">
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>