t.n.d.INewsStorage(Interface) : interface documentation

Part of twisted.news.database View Source View In Hierarchy

Known implementations: twisted.news.database.NewsShelf, twisted.news.database.NewsStorageAugmentation, twisted.news.database.PickleStorage

An interface for storing and requesting news articles
Method listRequest Returns a deferred whose callback will be passed a list of 4-tuples containing (name, max index, min index, flags) for each news group
Method subscriptionRequest Returns a deferred whose callback will be passed the list of recommended subscription groups for new server users
Method postRequest 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.
Method overviewRequest Returns a deferred whose callback will be passed the a list of headers describing this server's overview format.
Method xoverRequest No summary
Method xhdrRequest No summary
Method listGroupRequest Returns a deferred whose callback will be passed a two-tuple of (group name, [article indices])
Method groupRequest Returns a deferred whose callback will be passed a five-tuple of (group name, article count, highest index, lowest index, group flags)
Method articleExistsRequest 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.
Method articleRequest No summary
Method headRequest No summary
Method bodyRequest No summary
def listRequest(): (source)
Returns a deferred whose callback will be passed a list of 4-tuples containing (name, max index, min index, flags) for each news group
def subscriptionRequest(): (source)
Returns a deferred whose callback will be passed the list of recommended subscription groups for new server users
def postRequest(message): (source)
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.
def overviewRequest(): (source)
Returns a deferred whose callback will be passed the a list of headers describing this server's overview format.
def xoverRequest(group, low, high): (source)
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.
def xhdrRequest(group, low, high, header): (source)
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.
def listGroupRequest(group): (source)
Returns a deferred whose callback will be passed a two-tuple of (group name, [article indices])
def groupRequest(group): (source)
Returns a deferred whose callback will be passed a five-tuple of (group name, article count, highest index, lowest index, group flags)
def articleExistsRequest(id): (source)
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.
def articleRequest(group, index, id=None): (source)
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.
def headRequest(group, index): (source)
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.
def bodyRequest(group, index): (source)
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.
API Documentation for Twisted, generated by pydoctor at 2012-06-04 17:20:01.