twisted.internet.cfreactor.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.internet.cfreactor</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"> <a class="navbar" href="twisted.html">Home</a> </th>
<th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>
<th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
<th class="navbar"> <a class="navbar" href="help.html">Help</a> </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 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 twisted</a> ::
<a href="twisted.internet.html">Package internet</a> ::
Module cfreactor
</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> | <a href="twisted.internet.cfreactor.html" target="_top">no frames</a>]</font></td></tr>
</table></td>
</tr></table>
<!-- =========== START OF MODULE DESCRIPTION =========== -->
<h2 class="module">Module twisted.internet.cfreactor</h2>
<p>This module provides support for Twisted to interact with
CoreFoundation CFRunLoops. This includes Cocoa's NSRunLoop.</p>
In order to use this support, simply do the following:
<pre class="literalblock">
| from twisted.internet import cfreactor
| cfreactor.install()
</pre>
<p>Then use the twisted.internet APIs as usual. The other methods here
are not intended to be called directly under normal use. However, install
can take a runLoop kwarg, and run will take a withRunLoop arg if you need
to explicitly pass a CFRunLoop for some reason. Otherwise it will make a
pretty good guess as to which runLoop you want (the current NSRunLoop if
PyObjC is imported, otherwise the current CFRunLoop. Either way, if one
doesn't exist, it will be created).</p>
<p>API Stability: stable</p>
Maintainer: <a href="mailto:bob@redivi.com">Bob Ippolito</a>
<hr/>
<!-- =========== START OF CLASSES =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Classes</th></tr>
<tr><td width="15%">
<b><a href="twisted.internet.cfreactor.CFReactor.html"><code>CFReactor</code></a></b></td>
<td> </td></tr>
<tr><td width="15%">
<b><a href="twisted.internet.cfreactor.SelectableSocketWrapper.html"><code>SelectableSocketWrapper</code></a></b></td>
<td> </td></tr>
</table><br />
<!-- =========== START OF FUNCTION SUMMARY =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Function Summary</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.internet.cfreactor.html#install" class="summary-sig-name"><code>install</code></a>(<span class=summary-sig-arg>runLoop</span>)</span></code>
<br />
Configure the twisted mainloop to be run inside CFRunLoop.</td></tr>
</table><br />
<!-- =========== START OF VARIABLE SUMMARY =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Variable Summary</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>dict</code></font></td>
<td><b><a href="twisted.internet.cfreactor.html#_faildict"><code>_faildict</code></a></b> = <span title="{<class twisted.internet.error.ConnectionLost at 0x8263364>: <twisted.python.failure.Failure twisted.internet.error.ConnectionLost>, <class twisted.internet.error.ConnectionDone at 0x826734c>: <twisted.python.failure.Failure twisted.internet.error.ConnectionDone>}"><code>{<class twisted.internet.error.ConnectionLos<span class="variable-ellipsis">...</span></code>
</span></td></tr>
</table><br />
<!-- =========== START OF FUNCTION DETAILS =========== -->
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="details">
<th colspan="2">Function Details</th></tr>
</table>
<a name="install"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">install</span>(<span class=sig-arg>runLoop</span>=<span class=sig-default>None</span>)</span>
</h3>
Configure the twisted mainloop to be run inside CFRunLoop.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<br />
<!-- =========== START OF VARIABLE DETAILS =========== -->
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="details">
<th colspan="2">Variable Details</th></tr>
</table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="_faildict"></a>
<h3>_faildict</h3>
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>dict</code>
</dd>
<span title="{<class twisted.internet.error.ConnectionLost at 0x8263364>: <twisted.python.failure.Failure twisted.internet.error.ConnectionLost>, <class twisted.internet.error.ConnectionDone at 0x826734c>: <twisted.python.failure.Failure twisted.internet.error.ConnectionDone>}"> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
{<class twisted.internet.error.ConnectionLost at 0x8263364>: <twisted.<span class="variable-linewrap">\</span>
python.failure.Failure twisted.internet.error.ConnectionLost>,
<class twisted.internet.error.ConnectionDone at 0x826734c>: <twisted.<span class="variable-linewrap">\</span>
python.failure.Failure twisted.internet.error.ConnectionDone>} </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"> <a class="navbar" href="twisted.html">Home</a> </th>
<th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>
<th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
<th class="navbar"> <a class="navbar" href="help.html">Help</a> </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 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:07:57 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>