twisted.news.database.INewsStorage.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.news.database.INewsStorage</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.news.html">Package news</a> ::
<a href="twisted.news.database.html">Module database</a> ::
Class INewsStorage
</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.news.database.INewsStorage.html" target="_top">no frames</a>]</font></td></tr>
</table></td>
</tr></table>
<!-- =========== START OF CLASS DESCRIPTION =========== -->
<h2 class="class">Class INewsStorage</h2>
<pre class="base-tree">
<a href="twisted.python.components.Interface.html"><code>Interface</code></a> --+
|
<b>INewsStorage</b>
</pre><br />
<hr/>
An interface for storing and requesting news articles
<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.news.database.INewsStorage.html#articleExistsRequest" class="summary-sig-name"><code>articleExistsRequest</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>id</span>)</span></code>
<br />
Returns a deferred whose callback will be passed with a true value if
a message with the specified Message-ID exists in the database and with a
false value otherwise.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.news.database.INewsStorage.html#articleRequest" class="summary-sig-name"><code>articleRequest</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>group</span>,
<span class=summary-sig-arg>index</span>,
<span class=summary-sig-arg>id</span>)</span></code>
<br />
Returns a deferred whose callback will be passed a file-like object
containing the full article text (headers and body) for the article of
the specified index in the specified group, and whose errback will be
invoked if the article or group does not exist.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.news.database.INewsStorage.html#bodyRequest" class="summary-sig-name"><code>bodyRequest</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>group</span>,
<span class=summary-sig-arg>index</span>)</span></code>
<br />
Returns a deferred whose callback will be passed the body for the
article of the specified index in the specified group, and whose errback
will be invoked if the article or group does not exist.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.news.database.INewsStorage.html#groupRequest" class="summary-sig-name"><code>groupRequest</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>group</span>)</span></code>
<br />
Returns a deferred whose callback will be passed a five-tuple of
(group name, article count, highest index, lowest index, group flags)</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.news.database.INewsStorage.html#headRequest" class="summary-sig-name"><code>headRequest</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>group</span>,
<span class=summary-sig-arg>index</span>)</span></code>
<br />
Returns a deferred whose callback will be passed the header for the
article of the specified index in the specified group, and whose errback
will be invoked if the article or group does not exist.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.news.database.INewsStorage.html#listGroupRequest" class="summary-sig-name"><code>listGroupRequest</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>group</span>)</span></code>
<br />
Returns a deferred whose callback will be passed a two-tuple of (group
name, [article indices])</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.news.database.INewsStorage.html#listRequest" class="summary-sig-name"><code>listRequest</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Returns a deferred whose callback will be passed a list of 4-tuples
containing (name, max index, min index, flags) for each news group</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.news.database.INewsStorage.html#overviewRequest" class="summary-sig-name"><code>overviewRequest</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Returns a deferred whose callback will be passed the a list of headers
describing this server's overview format.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.news.database.INewsStorage.html#postRequest" class="summary-sig-name"><code>postRequest</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>message</span>)</span></code>
<br />
Returns a deferred whose callback will be invoked if 'message' is
successfully posted to one or more specified groups and whose errback
will be invoked otherwise.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.news.database.INewsStorage.html#subscriptionRequest" class="summary-sig-name"><code>subscriptionRequest</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Returns a deferred whose callback will be passed the list of
recommended subscription groups for new server users</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.news.database.INewsStorage.html#xhdrRequest" class="summary-sig-name"><code>xhdrRequest</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>group</span>,
<span class=summary-sig-arg>low</span>,
<span class=summary-sig-arg>high</span>,
<span class=summary-sig-arg>header</span>)</span></code>
<br />
Returns a deferred whose callback will be passed a list of XHDR data
for the given group over the given range.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.news.database.INewsStorage.html#xoverRequest" class="summary-sig-name"><code>xoverRequest</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>group</span>,
<span class=summary-sig-arg>low</span>,
<span class=summary-sig-arg>high</span>)</span></code>
<br />
Returns a deferred whose callback will be passed a list of xover
headers for the given group over the given range.</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="articleExistsRequest"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">articleExistsRequest</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>id</span>)</span>
</h3>
Returns a deferred whose callback will be passed with a true value
if a message with the specified Message-ID exists in the database and
with a false value otherwise.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="articleRequest"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">articleRequest</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>group</span>,
<span class=sig-arg>index</span>,
<span class=sig-arg>id</span>=<span class=sig-default>None</span>)</span>
</h3>
Returns a deferred whose callback will be passed a file-like object
containing the full article text (headers and body) for the article of
the specified index in the specified group, and whose errback will be
invoked if the article or group does not exist. If id is not None,
index is ignored and the article with the given Message-ID will be
returned instead, along with its index in the specified group.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="bodyRequest"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">bodyRequest</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>group</span>,
<span class=sig-arg>index</span>)</span>
</h3>
Returns a deferred whose callback will be passed the body for the
article of the specified index in the specified group, and whose
errback will be invoked if the article or group does not exist.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="groupRequest"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">groupRequest</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>group</span>)</span>
</h3>
Returns a deferred whose callback will be passed a five-tuple of
(group name, article count, highest index, lowest index, group
flags)
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="headRequest"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">headRequest</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>group</span>,
<span class=sig-arg>index</span>)</span>
</h3>
Returns a deferred whose callback will be passed the header for the
article of the specified index in the specified group, and whose
errback will be invoked if the article or group does not exist.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="listGroupRequest"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">listGroupRequest</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>group</span>)</span>
</h3>
Returns a deferred whose callback will be passed a two-tuple of
(group name, [article indices])
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="listRequest"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">listRequest</span>(<span class=sig-arg>self</span>)</span>
</h3>
Returns a deferred whose callback will be passed a list of 4-tuples
containing (name, max index, min index, flags) for each news group
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="overviewRequest"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">overviewRequest</span>(<span class=sig-arg>self</span>)</span>
</h3>
Returns a deferred whose callback will be passed the a list of
headers describing this server's overview format.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="postRequest"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">postRequest</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>message</span>)</span>
</h3>
Returns a deferred whose callback will be invoked if 'message' is
successfully posted to one or more specified groups and whose errback
will be invoked otherwise.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="subscriptionRequest"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">subscriptionRequest</span>(<span class=sig-arg>self</span>)</span>
</h3>
Returns a deferred whose callback will be passed the list of
recommended subscription groups for new server users
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="xhdrRequest"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">xhdrRequest</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>group</span>,
<span class=sig-arg>low</span>,
<span class=sig-arg>high</span>,
<span class=sig-arg>header</span>)</span>
</h3>
Returns a deferred whose callback will be passed a list of XHDR data
for the given group over the given range. If low is None, the range
starts at the first article. If high is None, the range ends at the
last article.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="xoverRequest"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">xoverRequest</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>group</span>,
<span class=sig-arg>low</span>,
<span class=sig-arg>high</span>)</span>
</h3>
Returns a deferred whose callback will be passed a list of xover
headers for the given group over the given range. If low is None, the
range starts at the first article. If high is None, the range ends at
the last article.
<dl><dt></dt><dd>
</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:24 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>