twisted.internet.interfaces.IReactorSSL.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.interfaces.IReactorSSL</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> ::
<a href="twisted.internet.interfaces.html">Module interfaces</a> ::
Class IReactorSSL
</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.interfaces.IReactorSSL.html" target="_top">no frames</a>]</font></td></tr>
</table></td>
</tr></table>
<!-- =========== START OF CLASS DESCRIPTION =========== -->
<h2 class="class">Class IReactorSSL</h2>
<pre class="base-tree">
<a href="twisted.python.components.Interface.html"><code>Interface</code></a> --+
|
<b>IReactorSSL</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"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.internet.interfaces.IReactorSSL.html#connectSSL" class="summary-sig-name"><code>connectSSL</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>host</span>,
<span class=summary-sig-arg>port</span>,
<span class=summary-sig-arg>factory</span>,
<span class=summary-sig-arg>contextFactory</span>,
<span class=summary-sig-arg>timeout</span>,
<span class=summary-sig-arg>bindAddress</span>)</span></code>
<br />
Connect a client Protocol to a remote SSL socket.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.internet.interfaces.IReactorSSL.html#listenSSL" class="summary-sig-name"><code>listenSSL</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>port</span>,
<span class=summary-sig-arg>factory</span>,
<span class=summary-sig-arg>contextFactory</span>,
<span class=summary-sig-arg>backlog</span>,
<span class=summary-sig-arg>interface</span>)</span></code>
<br />
Connects a given protocol factory to the given numeric TCP/IP
port.</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="connectSSL"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">connectSSL</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>host</span>,
<span class=sig-arg>port</span>,
<span class=sig-arg>factory</span>,
<span class=sig-arg>contextFactory</span>,
<span class=sig-arg>timeout</span>=<span class=sig-default>30</span>,
<span class=sig-arg>bindAddress</span>=<span class=sig-default>None</span>)</span>
</h3>
Connect a client Protocol to a remote SSL socket.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>host</b></code> -
a host name
<dd><code><b>port</b></code> -
a port number
<dd><code><b>factory</b></code> -
a <a href="twisted.internet.protocol.ClientFactory.html"
class="link"><code>twisted.internet.protocol.ClientFactory</code></a>
instance
<dd><code><b>contextFactory</b></code> -
a <a href="twisted.internet.ssl.ClientContextFactory.html"
class="link"><code>twisted.internet.ssl.ClientContextFactory</code></a>
object.
<dd><code><b>timeout</b></code> -
number of seconds to wait before assuming the connection has
failed.
<dd><code><b>bindAddress</b></code> -
a (host, port) tuple of local address to bind to, or
<code>None</code>.
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
an <a href="twisted.internet.interfaces.IConnector.html"
class="link"><code>IConnector</code></a>.
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="listenSSL"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">listenSSL</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>port</span>,
<span class=sig-arg>factory</span>,
<span class=sig-arg>contextFactory</span>,
<span class=sig-arg>backlog</span>=<span class=sig-default>5</span>,
<span class=sig-arg>interface</span>=<span class=sig-default>''</span>)</span>
</h3>
Connects a given protocol factory to the given numeric TCP/IP port.
The connection is a SSL one, using contexts created by the context
factory.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>port</b></code> -
a port number on which to listen
<dd><code><b>factory</b></code> -
a <a href="twisted.internet.protocol.ServerFactory.html"
class="link"><code>twisted.internet.protocol.ServerFactory</code></a>
instance
<dd><code><b>contextFactory</b></code> -
a <a href="twisted.internet.ssl.ContextFactory.html"
class="link"><code>twisted.internet.ssl.ContextFactory</code></a>
instance
<dd><code><b>backlog</b></code> -
size of the listen queue
<dd><code><b>interface</b></code> -
the hostname to bind to, defaults to '' (all)
</dd>
</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:08:26 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>