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

<tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="twisted.spread.pb.RemoteReference.html" target="_top">no frames</a>]</font></td></tr>

</table></td>

</tr></table>

<h2 class="class">Class RemoteReference</h2>

<a href="twisted.persisted.styles.Ephemeral.html"><code>Ephemeral</code></a> --+

<a href="twisted.spread.jelly.Jellyable.html"><code>Jellyable</code></a> --+ |

| |

<a href="twisted.spread.flavors.Serializable.html"><code>Serializable</code></a> --+

<b>RemoteReference</b>

</pre><br />

<hr/>

<p>This is a translucent reference to a remote object.</p>

<p>I may be a reference to a <a

href="twisted.spread.flavors.ViewPoint.html"

class="link"><code>flavors.ViewPoint</code></a>, a <a

href="twisted.spread.flavors.Referenceable.html"

class="link"><code>flavors.Referenceable</code></a>, or an <a

href="twisted.spread.pb.IPerspective.html"

class="link"><code>IPerspective</code></a> implementor (e.g., pb.Avatar).

From the client's perspective, it is not possible to tell which except by

convention.</p>

<p>I am a "translucent" reference because although no

additional bookkeeping overhead is given to the application programmer

for manipulating a reference, return values are asynchronous.</p>

See also <a href="twisted.internet.defer.html"

class="link"><code>twisted.internet.defer</code></a>.

<hr/>

<th colspan="2">Method Summary</th></tr>

<td><code><span class="summary-sig"><a href="twisted.spread.pb.RemoteReference.html#__init__" class="summary-sig-name"><code>__init__</code></a>(<span class=summary-sig-arg>self</span>,

<span class=summary-sig-arg>perspective</span>,

<span class=summary-sig-arg>broker</span>,

<span class=summary-sig-arg>luid</span>,

<span class=summary-sig-arg>doRefCount</span>)</span></code>

<br />

(internal) Initialize me with a broker and a locally-unique ID.</td></tr>

<td><code><span class="summary-sig"><a href="twisted.spread.pb.RemoteReference.html#__cmp__" class="summary-sig-name"><code>__cmp__</code></a>(<span class=summary-sig-arg>self</span>,

<span class=summary-sig-arg>other</span>)</span></code>

<br />

Compare me [to another <a

href="twisted.spread.pb.RemoteReference.html"

class="link"><code>RemoteReference</code></a>].</td></tr>

<br />

Do distributed reference counting on finalization.</td></tr>

100

101

<br />

102

Hash me.</td></tr>

103

104

<td><code><span class="summary-sig"><a href="twisted.spread.pb.RemoteReference.html#_disconnected" class="summary-sig-name"><code>_disconnected</code></a>(<span class=summary-sig-arg>self</span>)</span></code>

105

<br />

106

Called if we are disconnected and have callbacks registered.</td></tr>

107

<tr><td align="right" valign="top" width="15%"><font size="-1"> <a href="twisted.internet.defer.Deferred.html"

108

class="link"><code>twisted.internet.defer.Deferred</code></a>

109

</font></td>

110

<td><code><span class="summary-sig"><a href="twisted.spread.pb.RemoteReference.html#callRemote" class="summary-sig-name"><code>callRemote</code></a>(<span class=summary-sig-arg>self</span>,

111

<span class=summary-sig-arg>_name</span>,

112

<span class="summary-sig-vararg">*args</span>,

113

114

<br />

115

Asynchronously invoke a remote method.</td></tr>

116

117

<td><code><span class="summary-sig"><a href="twisted.spread.pb.RemoteReference.html#dontNotifyOnDisconnect" class="summary-sig-name"><code>dontNotifyOnDisconnect</code></a>(<span class=summary-sig-arg>self</span>,

118

<span class=summary-sig-arg>callback</span>)</span></code>

119

<br />

120

Remove a callback that was registered with notifyOnDisconnect.</td></tr>

121

122

<td><code><span class="summary-sig"><a href="twisted.spread.pb.RemoteReference.html#jellyFor" class="summary-sig-name"><code>jellyFor</code></a>(<span class=summary-sig-arg>self</span>,

123

<span class=summary-sig-arg>jellier</span>)</span></code>

124

<br />

125

If I am being sent back to where I came from, serialize as a local

126

backreference.</td></tr>

127

128

<td><code><span class="summary-sig"><a href="twisted.spread.pb.RemoteReference.html#notifyOnDisconnect" class="summary-sig-name"><code>notifyOnDisconnect</code></a>(<span class=summary-sig-arg>self</span>,

129

<span class=summary-sig-arg>callback</span>)</span></code>

130

<br />

131

132

133

<td><code><span class="summary-sig"><a href="twisted.spread.pb.RemoteReference.html#remoteMethod" class="summary-sig-name"><code>remoteMethod</code></a>(<span class=summary-sig-arg>self</span>,

134

135

<br />

136

Get a <a href="twisted.spread.pb.RemoteMethod.html"

137

class="link"><code>RemoteMethod</code></a> for this key.</td></tr>

138

139

<td><code><a name="unjellyFor"></a><span class="summary-sig"><span class="summary-sig-name">unjellyFor</span>(<span class=summary-sig-arg>self</span>,

140

<span class=summary-sig-arg>unjellier</span>,

141

<span class=summary-sig-arg>unjellyList</span>)</span></code>

142

</td></tr>

143

144

<th colspan="2">    Inherited from Serializable</th></tr>

145

146

<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>

147

<br />

148

Return an ID which uniquely represents this object for this

149

process.</td></tr>

150

151

<th colspan="2">    Inherited from Jellyable</th></tr>

152

153

<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>,

154

<span class=summary-sig-arg>jellier</span>)</span></code>

155

</td></tr>

156

157

<th colspan="2">    Inherited from Ephemeral</th></tr>

158

159

<td><code><span class="summary-sig"><a href="twisted.persisted.styles.Ephemeral.html#__getstate__" class="summary-sig-name"><code>__getstate__</code></a>(<span class=summary-sig-arg>self</span>)</span></code>

160

</td></tr>

161

162

<td><code><span class="summary-sig"><a href="twisted.persisted.styles.Ephemeral.html#__setstate__" class="summary-sig-name"><code>__setstate__</code></a>(<span class=summary-sig-arg>self</span>,

163

<span class=summary-sig-arg>state</span>)</span></code>

164

</td></tr>

165

</table><br />

166

167

168

169

170

171

<th colspan="2">Instance Variable Summary</th></tr>

172

<tr><td align="right" valign="top" width="15%"><font size="-1"><a href="twisted.spread.pb.Broker.html"

173

class="link"><code>Broker</code></a></font></td>

174

<td><b><a href="twisted.spread.pb.RemoteReference.html#broker"><code>broker</code></a></b>: The broker I am obtained through.</td></tr>

175

</table><br />

176

177

178

179

180

181

<th colspan="2">Class Variable Summary</th></tr>

182

<tr><td align="right" valign="top" width="15%"><font size="-1"><code>tuple</code></font></td>

183

<td><b><a href="twisted.spread.pb.RemoteReference.html#__implements__"><code>__implements__</code></a></b> = <span title="(<class twisted.spread.interfaces.IUnjellyable at 0x84a65dc>,)"><code>(<class twisted.spread.interfaces.IUnje<span class="variable-ellipsis">...</span></code>

184

</span></td></tr>

185

</table><br />

186

187

188

189

190

191

<th colspan="2">Method Details</th></tr>

192

</table>

193

194

195

196

<h3><span class="sig"><span class="sig-name">__init__</span>(<span class=sig-arg>self</span>,

197

<span class=sig-arg>perspective</span>,

198

<span class=sig-arg>broker</span>,

199

<span class=sig-arg>luid</span>,

200

<span class=sig-arg>doRefCount</span>)</span>

201

<br /><i>(Constructor)</i>

202

</h3>

203

<p>(internal) Initialize me with a broker and a locally-unique ID.</p>

204

The ID is unique only to the particular Perspective Broker

205

instance.

206

207

</dd></dl>

208

</td></tr></table>

209

210

211

212

<h3><span class="sig"><span class="sig-name">__cmp__</span>(<span class=sig-arg>self</span>,

213

<span class=sig-arg>other</span>)</span>

214

<br /><i>(Comparison operator)</i>

215

</h3>

216

Compare me [to another <a

217

href="twisted.spread.pb.RemoteReference.html"

218

class="link"><code>RemoteReference</code></a>].

219

220

</dd></dl>

221

</td></tr></table>

222

223

224

225

226

<br /><i>(Destructor)</i>

227

</h3>

228

Do distributed reference counting on finalization.

229

230

</dd></dl>

231

</td></tr></table>

232

233

234

235

236

<br /><i>(Hashing function)</i>

237

</h3>

238

Hash me.

239

240

</dd></dl>

241

</td></tr></table>

242

243

244

245

<h3><span class="sig"><span class="sig-name">_disconnected</span>(<span class=sig-arg>self</span>)</span>

246

</h3>

247

Called if we are disconnected and have callbacks registered.

248

249

</dd></dl>

250

</td></tr></table>

251

252

253

254

<h3><span class="sig"><span class="sig-name">callRemote</span>(<span class=sig-arg>self</span>,

255

<span class=sig-arg>_name</span>,

256

<span class="sig-vararg">*args</span>,

257

258

</h3>

259

Asynchronously invoke a remote method.

260

261

<dl><dt><b>Parameters:</b></dt>

262

<dd><code><b>_name</b></code> -

263

the name of the remote method to invoke

264

265

(type=<code>string</code>)</i>

266

<dd><code><b>args</b></code> -

267

arguments to serialize for the remote function

268

<dd><code><b>kw</b></code> -

269

keyword arguments to serialize for the remote function.

270

</dd>

271

</dl>

272

<dl><dt><b>Returns:</b></dt>

273

<dd>

274

a Deferred which will be fired when the result of this remote

275

call is received.

276

277

(type=<a href="twisted.internet.defer.Deferred.html"

278

class="link"><code>twisted.internet.defer.Deferred</code></a>)</i>

279

</dd>

280

</dl>

281

</dd></dl>

282

</td></tr></table>

283

284

285

286

<h3><span class="sig"><span class="sig-name">dontNotifyOnDisconnect</span>(<span class=sig-arg>self</span>,

287

<span class=sig-arg>callback</span>)</span>

288

</h3>

289

Remove a callback that was registered with notifyOnDisconnect.

290

291

</dd></dl>

292

</td></tr></table>

293

294

295

296

<h3><span class="sig"><span class="sig-name">jellyFor</span>(<span class=sig-arg>self</span>,

297

<span class=sig-arg>jellier</span>)</span>

298

</h3>

299

If I am being sent back to where I came from, serialize as a local

300

backreference.

301

302

<dl><dt><b>Overrides:</b></dt>

303

<dd><a href="twisted.spread.jelly.Jellyable.html#jellyFor"><code>twisted.spread.jelly.Jellyable.jellyFor</code></a></dd>

304

</dl>

305

</dd></dl>

306

</td></tr></table>

307

308

309

310

<h3><span class="sig"><span class="sig-name">notifyOnDisconnect</span>(<span class=sig-arg>self</span>,

311

<span class=sig-arg>callback</span>)</span>

312

</h3>

313

<p>Register a callback to be called if our broker gets

314

disconnected.</p>

315

This callback will be called with one argument, this instance.

316

317

</dd></dl>

318

</td></tr></table>

319

320

321

322

<h3><span class="sig"><span class="sig-name">remoteMethod</span>(<span class=sig-arg>self</span>,

323

324

</h3>

325

Get a <a href="twisted.spread.pb.RemoteMethod.html"

326

class="link"><code>RemoteMethod</code></a> for this key.

327

328

</dd></dl>

329

</td></tr></table>

330

<br />

331

332

333

334

335

336

<th colspan="2">Instance Variable Details</th></tr>

337

</table>

338

339

340

<h3>broker</h3>

341

The broker I am obtained through.

342

<dl>

343

344

<dd>

345

<dl>

346

347

<dd>

348

<a href="twisted.spread.pb.Broker.html"

349

class="link"><code>Broker</code></a>

350

351

</dd>

352

</dl>

353

</dd>

354

</dl></td></tr></table>

355

<br />

356

357

358

359

360

361

<th colspan="2">Class Variable Details</th></tr>

362

</table>

363

364

365

<h3>__implements__</h3>

366

<dl>

367

368

<dd>

369

<dl>

370

371

<dd>

372

<code>tuple</code>

373

374

</dd>

375

<span title="(<class twisted.spread.interfaces.IUnjellyable at 0x84a65dc>,)"> <dt><b>Value:</b></dt>

376

377

378

(<class twisted.spread.interfaces.IUnjellyable at 0x84a65dc>,) </pre>

379

</td></tr></table></dd>

380

</span> </dl>

381

</dd>

382

</dl></td></tr></table>

383

<br />

384

385

386

387

388

389

390

<th class="navbar">   <a class="navbar" href="trees.html">Trees</a>   </th>

391

<th class="navbar">   <a class="navbar" href="indices.html">Index</a>   </th>

392

393

394

395

396

397

<a class="navbar" target="_top" href="http://twistedmatrix.com/">Twisted 1.3.0rc1</a>

398

</p></th></tr></table>

399

</th>

400

</tr>

401

</table>

402

403

404

<tr>

405

<td align="left"><font size="-2">Generated by Epydoc 2.0 on Sat May 15 20:07:45 2004</font></td>

406

<td align="right"><a href="http://epydoc.sourceforge.net"

407

><font size="-2">http://epydoc.sf.net</font></a></td>

408

</tr>

409

</table>

410

</body>

411

</html>

Older »