twisted.mail.relaymanager.SmartHostSMTPRelayingManager.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.mail.relaymanager.SmartHostSMTPRelayingManager</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.mail.html">Package mail</a> ::
<a href="twisted.mail.relaymanager.html">Module relaymanager</a> ::
Class SmartHostSMTPRelayingManager
</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.mail.relaymanager.SmartHostSMTPRelayingManager.html" target="_top">no frames</a>]</font></td></tr>
</table></td>
</tr></table>
<!-- =========== START OF CLASS DESCRIPTION =========== -->
<h2 class="class">Class SmartHostSMTPRelayingManager</h2>
<dl><dt><b>Known Subclasses:</b></dt>
<dd>
<a href="twisted.mail.relaymanager.SmartHostESMTPRelayingManager.html"><code>SmartHostESMTPRelayingManager</code></a></dd></dl>
<hr/>
<p>Manage SMTP Relayers</p>
<p>Manage SMTP relayers, keeping track of the existing connections, each
connection's responsibility in term of messages. Create more relayers if
the need arises.</p>
Someone should press .checkState periodically
<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.mail.relaymanager.SmartHostSMTPRelayingManager.html#__init__" class="summary-sig-name"><code>__init__</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>queue</span>,
<span class=summary-sig-arg>maxConnections</span>,
<span class=summary-sig-arg>maxMessagesPerConnection</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.mail.relaymanager.SmartHostSMTPRelayingManager.html#__getstate__" class="summary-sig-name"><code>__getstate__</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
(internal) delete volatile state</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.mail.relaymanager.SmartHostSMTPRelayingManager.html#__setstate__" class="summary-sig-name"><code>__setstate__</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>state</span>)</span></code>
<br />
(internal) restore volatile state</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="_cbExchange"></a><span class="summary-sig"><span class="summary-sig-name">_cbExchange</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>address</span>,
<span class=summary-sig-arg>port</span>,
<span class=summary-sig-arg>factory</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="_checkStateMX"></a><span class="summary-sig"><span class="summary-sig-name">_checkStateMX</span>(<span class=summary-sig-arg>self</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="_ebExchange"></a><span class="summary-sig"><span class="summary-sig-name">_ebExchange</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>failure</span>,
<span class=summary-sig-arg>factory</span>,
<span class=summary-sig-arg>domain</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="_finish"></a><span class="summary-sig"><span class="summary-sig-name">_finish</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>relay</span>,
<span class=summary-sig-arg>message</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.mail.relaymanager.SmartHostSMTPRelayingManager.html#checkState" class="summary-sig-name"><code>checkState</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
call me periodically to check I am still up to date</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.mail.relaymanager.SmartHostSMTPRelayingManager.html#notifyDone" class="summary-sig-name"><code>notifyDone</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>relay</span>)</span></code>
<br />
A relaying SMTP client is disconnected.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.mail.relaymanager.SmartHostSMTPRelayingManager.html#notifyFailure" class="summary-sig-name"><code>notifyFailure</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>relay</span>,
<span class=summary-sig-arg>message</span>)</span></code>
<br />
Relaying the message has failed.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.mail.relaymanager.SmartHostSMTPRelayingManager.html#notifyNoConnection" class="summary-sig-name"><code>notifyNoConnection</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>relay</span>)</span></code>
<br />
Relaying SMTP client couldn't connect.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.mail.relaymanager.SmartHostSMTPRelayingManager.html#notifySuccess" class="summary-sig-name"><code>notifySuccess</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>relay</span>,
<span class=summary-sig-arg>message</span>)</span></code>
<br />
a relay sent a message successfully</td></tr>
</table><br />
<!-- =========== START OF INSTANCE VARIABLE SUMMARY =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Instance Variable Summary</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>class</code></font></td>
<td><a name="factory"></a><b><code>factory</code></b> = <a href="twisted.mail.relaymanager.SMTPManagedRelayerFactory.html"><code>twisted.mail.relaymanager.SMTPManagedRelayerFactory</code></a></td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><b><a href="twisted.mail.relaymanager.SmartHostSMTPRelayingManager.html#fArgs"><code>fArgs</code></a></b>: Additional positional arguments used to instantiate
<code>factory</code>.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><b><a href="twisted.mail.relaymanager.SmartHostSMTPRelayingManager.html#fKwArgs"><code>fKwArgs</code></a></b>: Additional keyword arguments used to instantiate
<code>factory</code>.</td></tr>
</table><br />
<!-- =========== START OF CLASS VARIABLE SUMMARY =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Class Variable Summary</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>NoneType</code></font></td>
<td><b><a href="twisted.mail.relaymanager.SmartHostSMTPRelayingManager.html#mxcalc"><code>mxcalc</code></a></b> = <span title="None">None </span></td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>int</code></font></td>
<td><b><a href="twisted.mail.relaymanager.SmartHostSMTPRelayingManager.html#PORT"><code>PORT</code></a></b> = <span title="25">25 </span></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="__init__"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">__init__</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>queue</span>,
<span class=sig-arg>maxConnections</span>=<span class=sig-default>2</span>,
<span class=sig-arg>maxMessagesPerConnection</span>=<span class=sig-default>10</span>)</span>
<br /><i>(Constructor)</i>
</h3>
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>queue</b></code> -
The object used to queue messages on their way to
delivery.
<br /><i>
(type=Any implementor of <code>IQueue</code>)</i>
<dd><code><b>maxConnections</b></code> -
The maximum number of SMTP connections to allow to be opened
at any given time.
<br /><i>
(type=<code>int</code>)</i>
<dd><code><b>maxMessagesPerConnection</b></code> -
<p>The maximum number of messages a relayer will be given
responsibility for.</p>
Default values are meant for a small box with 1-5 users.
<br /><i>
(type=<code>int</code>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="__getstate__"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">__getstate__</span>(<span class=sig-arg>self</span>)</span>
</h3>
(internal) delete volatile state
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="__setstate__"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">__setstate__</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>state</span>)</span>
</h3>
(internal) restore volatile state
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="checkState"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">checkState</span>(<span class=sig-arg>self</span>)</span>
</h3>
<p>call me periodically to check I am still up to date</p>
synchronize with the state of the world, and maybe launch a new
relay
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="notifyDone"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">notifyDone</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>relay</span>)</span>
</h3>
<p>A relaying SMTP client is disconnected.</p>
unmark all pending messages under this relay's resposibility as
being relayed, and remove the relay.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="notifyFailure"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">notifyFailure</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>relay</span>,
<span class=sig-arg>message</span>)</span>
</h3>
Relaying the message has failed.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="notifyNoConnection"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">notifyNoConnection</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>relay</span>)</span>
</h3>
<p>Relaying SMTP client couldn't connect.</p>
Useful because it tells us our upstream server is unavailable.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="notifySuccess"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">notifySuccess</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>relay</span>,
<span class=sig-arg>message</span>)</span>
</h3>
<p>a relay sent a message successfully</p>
Mark it as sent in our lists
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<br />
<!-- =========== START OF INSTANCE VARIABLE DETAILS =========== -->
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="details">
<th colspan="2">Instance Variable Details</th></tr>
</table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="fArgs"></a>
<h3>fArgs</h3>
Additional positional arguments used to instantiate
<code>factory</code>.
</td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="fKwArgs"></a>
<h3>fKwArgs</h3>
Additional keyword arguments used to instantiate
<code>factory</code>.
</td></tr></table>
<br />
<!-- =========== START OF CLASS VARIABLE DETAILS =========== -->
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="details">
<th colspan="2">Class Variable Details</th></tr>
</table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="mxcalc"></a>
<h3>mxcalc</h3>
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>NoneType</code>
</dd>
<span title="None"> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
None </pre>
</td></tr></table></dd>
</span> </dl>
</dd>
</dl></td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="PORT"></a>
<h3>PORT</h3>
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>int</code>
</dd>
<span title="25"> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
25 </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:08:33 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>