Class t.n.n.NNTPClient(basic.LineReceiver):

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

Known subclasses: twisted.news.nntp.UsenetClientProtocol

No class docstring

Split Table into Classes Show Methods in One Table

Line # Kind Name Docs
88 Method __init__ Undocumented
102 Method gotAllGroups Override for notification when fetchGroups() action is completed
106 Method getAllGroupsFailed Override for notification when fetchGroups() action fails
110 Method gotOverview Override for notification when fetchOverview() action is completed
114 Method getOverviewFailed Override for notification when fetchOverview() action fails
118 Method gotSubscriptions Override for notification when fetchSubscriptions() action is completed
122 Method getSubscriptionsFailed Override for notification when fetchSubscriptions() action fails
126 Method gotGroup Override for notification when fetchGroup() action is completed
130 Method getGroupFailed Override for notification when fetchGroup() action fails
134 Method gotArticle Override for notification when fetchArticle() action is completed
138 Method getArticleFailed Override for notification when fetchArticle() action fails
142 Method gotHead Override for notification when fetchHead() action is completed
146 Method getHeadFailed Override for notification when fetchHead() action fails
150 Method gotBody Override for notification when fetchBody() action is completed
154 Method getBodyFailed Override for notification when fetchBody() action fails
158 Method postedOk Override for notification when postArticle() action is successful
162 Method postFailed Override for notification when postArticle() action fails
166 Method gotXHeader Override for notification when getXHeader() action is successful
170 Method getXHeaderFailed Override for notification when getXHeader() action fails
174 Method gotNewNews Override for notification when getNewNews() action is successful
178 Method getNewNewsFailed Override for notification when getNewNews() action fails
182 Method gotNewGroups Override for notification when getNewGroups() action is successful
186 Method getNewGroupsFailed Override for notification when getNewGroups() action fails
190 Method setStreamSuccess Override for notification when setStream() action is successful
194 Method setStreamFailed Override for notification when setStream() action fails
198 Method fetchGroups Request a list of all news groups from the server. gotAllGroups()
207 Method fetchOverview Request the overview format from the server. gotOverview() is called
216 Method fetchSubscriptions Request a list of the groups it is recommended a new user subscribe to.
226 Method fetchGroup Get group information for the specified group from the server. gotGroup()
235 Method fetchHead Get the header for the specified article (or the currently selected
245 Method fetchBody Get the body for the specified article (or the currently selected
255 Method fetchArticle Get the complete article with the specified index (or the currently
265 Method postArticle Attempt to post an article with the specified text to the server. 'text'
277 Method fetchNewNews Get the Message-IDs for all new news posted to any of the given
301 Method fetchNewGroups Get the names of all new groups created/added to the server since
313 Method fetchXHeader Request a specific header from the server for an article or range
338 Method setStream Set the mode to STREAM, suspending the normal "lock-step" mode of
348 Method quit Undocumented
385 Method lineReceived Override this for when each line is received.
353 Method _newState Undocumented
361 Method _endState Undocumented
371 Method _newLine Undocumented
377 Method _setResponseCode Undocumented
381 Method _getResponseCode Undocumented
401 Method _statePassive Undocumented
405 Method _passiveError Undocumented
409 Method _headerInitial Undocumented
417 Method _stateList Undocumented
425 Method _stateOverview Undocumented
432 Method _stateSubscriptions Undocumented
439 Method _headerGroup Undocumented
444 Method _stateArticle Undocumented
453 Method _stateHead Undocumented
460 Method _stateBody Undocumented
469 Method _headerPost Undocumented
482 Method _headerPosted Undocumented
490 Method _stateXHDR Undocumented
497 Method _stateNewNews Undocumented
504 Method _stateNewGroups Undocumented
511 Method _headerMode Undocumented

Inherited from LineReceiver:

Line # Kind Name Docs
207 Method clearLineBuffer Clear buffered data.
211 Method dataReceived Protocol.dataReceived.
241 Method setLineMode Sets the line-mode of this receiver.
256 Method setRawMode Sets the raw mode of this receiver.
263 Method rawDataReceived Override this for when raw data is received.
273 Method sendLine Sends a line to the other end of the connection.
278 Method lineLengthExceeded Called when the maximum line length has been reached.

Inherited from Protocol (via LineReceiver):

Line # Kind Name Docs
384 Method connectionLost Called when the connection is shut down.

Inherited from BaseProtocol (via LineReceiver, Protocol):

Line # Kind Name Docs
341 Method makeConnection Make a connection to a transport and a server.
351 Method connectionMade Called when a connection is made.

Inherited from _PauseableMixin (via LineReceiver):

Line # Kind Name Docs
172 Method pauseProducing Undocumented
176 Method resumeProducing Undocumented
181 Method stopProducing Undocumented
Line # Kind Name Docs
88 Method __init__ Undocumented
207 Method clearLineBuffer Clear buffered data.
384 Method connectionLost Called when the connection is shut down.
351 Method connectionMade Called when a connection is made.
211 Method dataReceived Protocol.dataReceived.
255 Method fetchArticle Get the complete article with the specified index (or the currently
245 Method fetchBody Get the body for the specified article (or the currently selected
226 Method fetchGroup Get group information for the specified group from the server. gotGroup()
198 Method fetchGroups Request a list of all news groups from the server. gotAllGroups()
235 Method fetchHead Get the header for the specified article (or the currently selected
301 Method fetchNewGroups Get the names of all new groups created/added to the server since
277 Method fetchNewNews Get the Message-IDs for all new news posted to any of the given
207 Method fetchOverview Request the overview format from the server. gotOverview() is called
216 Method fetchSubscriptions Request a list of the groups it is recommended a new user subscribe to.
313 Method fetchXHeader Request a specific header from the server for an article or range
106 Method getAllGroupsFailed Override for notification when fetchGroups() action fails
138 Method getArticleFailed Override for notification when fetchArticle() action fails
154 Method getBodyFailed Override for notification when fetchBody() action fails
130 Method getGroupFailed Override for notification when fetchGroup() action fails
146 Method getHeadFailed Override for notification when fetchHead() action fails
186 Method getNewGroupsFailed Override for notification when getNewGroups() action fails
178 Method getNewNewsFailed Override for notification when getNewNews() action fails
114 Method getOverviewFailed Override for notification when fetchOverview() action fails
122 Method getSubscriptionsFailed Override for notification when fetchSubscriptions() action fails
170 Method getXHeaderFailed Override for notification when getXHeader() action fails
102 Method gotAllGroups Override for notification when fetchGroups() action is completed
134 Method gotArticle Override for notification when fetchArticle() action is completed
150 Method gotBody Override for notification when fetchBody() action is completed
126 Method gotGroup Override for notification when fetchGroup() action is completed
142 Method gotHead Override for notification when fetchHead() action is completed
182 Method gotNewGroups Override for notification when getNewGroups() action is successful
174 Method gotNewNews Override for notification when getNewNews() action is successful
110 Method gotOverview Override for notification when fetchOverview() action is completed
118 Method gotSubscriptions Override for notification when fetchSubscriptions() action is completed
166 Method gotXHeader Override for notification when getXHeader() action is successful
278 Method lineLengthExceeded Called when the maximum line length has been reached.
385 Method lineReceived Override this for when each line is received.
341 Method makeConnection Make a connection to a transport and a server.
172 Method pauseProducing Undocumented
265 Method postArticle Attempt to post an article with the specified text to the server. 'text'
158 Method postedOk Override for notification when postArticle() action is successful
162 Method postFailed Override for notification when postArticle() action fails
348 Method quit Undocumented
263 Method rawDataReceived Override this for when raw data is received.
176 Method resumeProducing Undocumented
273 Method sendLine Sends a line to the other end of the connection.
241 Method setLineMode Sets the line-mode of this receiver.
256 Method setRawMode Sets the raw mode of this receiver.
338 Method setStream Set the mode to STREAM, suspending the normal "lock-step" mode of
194 Method setStreamFailed Override for notification when setStream() action fails
190 Method setStreamSuccess Override for notification when setStream() action is successful
181 Method stopProducing Undocumented
361 Method _endState Undocumented
381 Method _getResponseCode Undocumented
439 Method _headerGroup Undocumented
409 Method _headerInitial Undocumented
511 Method _headerMode Undocumented
469 Method _headerPost Undocumented
482 Method _headerPosted Undocumented
371 Method _newLine Undocumented
353 Method _newState Undocumented
405 Method _passiveError Undocumented
377 Method _setResponseCode Undocumented
444 Method _stateArticle Undocumented
460 Method _stateBody Undocumented
453 Method _stateHead Undocumented
417 Method _stateList Undocumented
504 Method _stateNewGroups Undocumented
497 Method _stateNewNews Undocumented
425 Method _stateOverview Undocumented
401 Method _statePassive Undocumented
432 Method _stateSubscriptions Undocumented
490 Method _stateXHDR Undocumented
def __init__(self): (source)
overridden in twisted.news.nntp.UsenetClientProtocol
Undocumented
def gotAllGroups(self, groups): (source)
Override for notification when fetchGroups() action is completed
def getAllGroupsFailed(self, error): (source)
Override for notification when fetchGroups() action fails
def gotOverview(self, overview): (source)
Override for notification when fetchOverview() action is completed
def getOverviewFailed(self, error): (source)
Override for notification when fetchOverview() action fails
def gotSubscriptions(self, subscriptions): (source)
Override for notification when fetchSubscriptions() action is completed
def getSubscriptionsFailed(self, error): (source)
Override for notification when fetchSubscriptions() action fails
def gotGroup(self, group): (source)
Override for notification when fetchGroup() action is completed
def getGroupFailed(self, error): (source)
Override for notification when fetchGroup() action fails
def gotArticle(self, article): (source)
overridden in twisted.news.nntp.UsenetClientProtocol
Override for notification when fetchArticle() action is completed
def getArticleFailed(self, error): (source)
Override for notification when fetchArticle() action fails
def gotHead(self, head): (source)
Override for notification when fetchHead() action is completed
def getHeadFailed(self, error): (source)
Override for notification when fetchHead() action fails
def gotBody(self, info): (source)
Override for notification when fetchBody() action is completed
def getBodyFailed(self, body): (source)
Override for notification when fetchBody() action fails
def postedOk(self): (source)
Override for notification when postArticle() action is successful
def postFailed(self, error): (source)
Override for notification when postArticle() action fails
def gotXHeader(self, headers): (source)
Override for notification when getXHeader() action is successful
def getXHeaderFailed(self, error): (source)
Override for notification when getXHeader() action fails
def gotNewNews(self, news): (source)
overridden in twisted.news.nntp.UsenetClientProtocol
Override for notification when getNewNews() action is successful
def getNewNewsFailed(self, error): (source)
overridden in twisted.news.nntp.UsenetClientProtocol
Override for notification when getNewNews() action fails
def gotNewGroups(self, groups): (source)
Override for notification when getNewGroups() action is successful
def getNewGroupsFailed(self, error): (source)
Override for notification when getNewGroups() action fails
def setStreamSuccess(self): (source)
Override for notification when setStream() action is successful
def setStreamFailed(self, error): (source)
Override for notification when setStream() action fails
def fetchGroups(self): (source)
Request a list of all news groups from the server. gotAllGroups() is called on success, getGroupsFailed() on failure
def fetchOverview(self): (source)
Request the overview format from the server. gotOverview() is called on success, getOverviewFailed() on failure
def fetchSubscriptions(self): (source)
Request a list of the groups it is recommended a new user subscribe to. gotSubscriptions() is called on success, getSubscriptionsFailed() on failure
def fetchGroup(self, group): (source)
Get group information for the specified group from the server. gotGroup() is called on success, getGroupFailed() on failure.
def fetchHead(self, index=''): (source)
Get the header for the specified article (or the currently selected article if index is '') from the server. gotHead() is called on success, getHeadFailed() on failure
def fetchBody(self, index=''): (source)
Get the body for the specified article (or the currently selected article if index is '') from the server. gotBody() is called on success, getBodyFailed() on failure
def fetchArticle(self, index=''): (source)
Get the complete article with the specified index (or the currently selected article if index is '') or Message-ID from the server. gotArticle() is called on success, getArticleFailed() on failure.
def postArticle(self, text): (source)
Attempt to post an article with the specified text to the server. 'text' must consist of both head and body data, as specified by RFC 850. If the article is posted successfully, postedOk() is called, otherwise postFailed() is called.
def fetchNewNews(self, groups, date, distributions=''): (source)

Get the Message-IDs for all new news posted to any of the given groups since the specified date - in seconds since the epoch, GMT - optionally restricted to the given distributions. gotNewNews() is called on success, getNewNewsFailed() on failure.

One invocation of this function may result in multiple invocations of gotNewNews()/getNewNewsFailed().
def fetchNewGroups(self, date, distributions): (source)
Get the names of all new groups created/added to the server since the specified date - in seconds since the ecpoh, GMT - optionally restricted to the given distributions. gotNewGroups() is called on success, getNewGroupsFailed() on failure.
def fetchXHeader(self, header, low=None, high=None, id=None): (source)
Request a specific header from the server for an article or range of articles. If 'id' is not None, a header for only the article with that Message-ID will be requested. If both low and high are None, a header for the currently selected article will be selected; If both low and high are zero-length strings, headers for all articles in the currently selected group will be requested; Otherwise, high and low will be used as bounds - if one is None the first or last article index will be substituted, as appropriate.
def setStream(self): (source)
Set the mode to STREAM, suspending the normal "lock-step" mode of communications. setStreamSuccess() is called on success, setStreamFailed() on failure.
def quit(self): (source)
Undocumented
def _newState(self, method, error, responseHandler=None): (source)
Undocumented
def _endState(self): (source)
Undocumented
def _newLine(self, line, check=1): (source)
Undocumented
def _setResponseCode(self, code): (source)
Undocumented
def _getResponseCode(self): (source)
Undocumented
def lineReceived(self, line): (source)
overrides twisted.protocols.basic.LineReceiver.lineReceived
Override this for when each line is received.
def _statePassive(self, line): (source)
Undocumented
def _passiveError(self, error): (source)
Undocumented
def _headerInitial(self, (code, message)): (source)
Undocumented
def _stateList(self, line): (source)
Undocumented
def _stateOverview(self, line): (source)
Undocumented
def _stateSubscriptions(self, line): (source)
Undocumented
def _headerGroup(self, (code, line)): (source)
Undocumented
def _stateArticle(self, line): (source)
Undocumented
def _stateHead(self, line): (source)
Undocumented
def _stateBody(self, line): (source)
Undocumented
def _headerPost(self, (code, message)): (source)
Undocumented
def _headerPosted(self, (code, message)): (source)
Undocumented
def _stateXHDR(self, line): (source)
Undocumented
def _stateNewNews(self, line): (source)
Undocumented
def _stateNewGroups(self, line): (source)
Undocumented
def _headerMode(self, (code, message)): (source)
Undocumented
API Documentation for Twisted, generated by pydoctor at 2008-10-26 16:12:37.