twisted.news.nntp.UsenetClientProtocol(NNTPClient) class documentationtwisted.news.nntp
View Source
(View In Hierarchy)
A client that connects to an NNTP server and asks for articles new since a certain time.
| Method | __init__ | No summary |
| Method | connectionMade | Called when a connection is made. |
| Method | articleExists | Undocumented |
| Method | gotNewNews | Override for notification when getNewNews() action is successful |
| Method | getNewNewsFailed | Override for notification when getNewNews() action fails |
| Method | gotArticle | Override for notification when fetchArticle() action is completed |
Inherited from NNTPClient:
| Method | gotAllGroups | Override for notification when fetchGroups() action is completed |
| Method | getAllGroupsFailed | Override for notification when fetchGroups() action fails |
| Method | gotOverview | Override for notification when fetchOverview() action is completed |
| Method | getOverviewFailed | Override for notification when fetchOverview() action fails |
| Method | gotSubscriptions | Override for notification when fetchSubscriptions() action is completed |
| Method | getSubscriptionsFailed | Override for notification when fetchSubscriptions() action fails |
| Method | gotGroup | Override for notification when fetchGroup() action is completed |
| Method | getGroupFailed | Override for notification when fetchGroup() action fails |
| Method | getArticleFailed | Override for notification when fetchArticle() action fails |
| Method | gotHead | Override for notification when fetchHead() action is completed |
| Method | getHeadFailed | Override for notification when fetchHead() action fails |
| Method | gotBody | Override for notification when fetchBody() action is completed |
| Method | getBodyFailed | Override for notification when fetchBody() action fails |
| Method | postedOk | Override for notification when postArticle() action is successful |
| Method | postFailed | Override for notification when postArticle() action fails |
| Method | gotXHeader | Override for notification when getXHeader() action is successful |
| Method | getXHeaderFailed | Override for notification when getXHeader() action fails |
| Method | gotNewGroups | Override for notification when getNewGroups() action is successful |
| Method | getNewGroupsFailed | Override for notification when getNewGroups() action fails |
| Method | setStreamSuccess | Override for notification when setStream() action is successful |
| Method | setStreamFailed | Override for notification when setStream() action fails |
| Method | fetchGroups | Request a list of all news groups from the server. gotAllGroups() is called on success, getGroupsFailed() on failure |
| Method | fetchOverview | Request the overview format from the server. gotOverview() is called on success, getOverviewFailed() on failure |
| Method | fetchSubscriptions | Request a list of the groups it is recommended a new user subscribe to. gotSubscriptions() is called on success, getSubscriptionsFailed() on failure |
| Method | fetchGroup | Get group information for the specified group from the server. gotGroup() is called on success, getGroupFailed() on failure. |
| Method | fetchHead | 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 |
| Method | fetchBody | 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 |
| Method | fetchArticle | 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. |
| Method | postArticle | No summary |
| Method | fetchNewNews | No summary |
| Method | fetchNewGroups | No summary |
| Method | fetchXHeader | No summary |
| Method | setStream | Set the mode to STREAM, suspending the normal "lock-step" mode of communications. setStreamSuccess() is called on success, setStreamFailed() on failure. |
| Method | quit | Undocumented |
| Method | lineReceived | Override this for when each line is received. |
| Method | _newState | Undocumented |
| Method | _endState | Undocumented |
| Method | _newLine | Undocumented |
| Method | _setResponseCode | Undocumented |
| Method | _getResponseCode | Undocumented |
| Method | _statePassive | Undocumented |
| Method | _passiveError | Undocumented |
| Method | _headerInitial | Undocumented |
| Method | _stateList | Undocumented |
| Method | _stateOverview | Undocumented |
| Method | _stateSubscriptions | Undocumented |
| Method | _headerGroup | Undocumented |
| Method | _stateArticle | Undocumented |
| Method | _stateHead | Undocumented |
| Method | _stateBody | Undocumented |
| Method | _headerPost | Undocumented |
| Method | _headerPosted | Undocumented |
| Method | _stateXHDR | Undocumented |
| Method | _stateNewNews | Undocumented |
| Method | _stateNewGroups | Undocumented |
| Method | _headerMode | Undocumented |
Inherited from LineReceiver (via NNTPClient):
| Class Variable | delimiter | The line-ending delimiter to use. By default this is b'\r\n'. |
| Class Variable | MAX_LENGTH | The maximum length of a line to allow (If a sent line is longer than this, the connection is dropped). Default is 16384. |
| Method | clearLineBuffer | Clear buffered data. |
| Method | dataReceived | Protocol.dataReceived. Translates bytes into lines, and calls lineReceived (or rawDataReceived, depending on mode.) |
| Method | setLineMode | Sets the line-mode of this receiver. |
| Method | setRawMode | Sets the raw mode of this receiver. Further data received will be sent to rawDataReceived rather than lineReceived. |
| Method | rawDataReceived | Override this for when raw data is received. |
| Method | sendLine | Sends a line to the other end of the connection. |
| Method | lineLengthExceeded | Called when the maximum line length has been reached. Override if it needs to be dealt with in some special way. |
Inherited from Protocol (via NNTPClient, LineReceiver):
| Method | logPrefix | Return a prefix matching the class name, to identify log messages related to this protocol instance. |
| Method | connectionLost | Called when the connection is shut down. |
Inherited from BaseProtocol (via NNTPClient, LineReceiver, Protocol):
| Method | makeConnection | Make a connection to a transport and a server. |
Inherited from _PauseableMixin (via NNTPClient, LineReceiver):
| Method | pauseProducing | Undocumented |
| Method | resumeProducing | Undocumented |
| Method | stopProducing | Undocumented |
Fetch all new articles from the given groups since the given date and dump them into the given storage. groups is a list of group names. date is an integer or floating point representing seconds since the epoch (GMT). storage is any object that implements the NewsStorage interface.
Called when a connection is made.
This may be considered the initializer of the protocol, because it is called when the connection is completed. For clients, this is called once the connection to the server has been established; for servers, this is called after an accept() call stops blocking and a socket has been received. If you need to send any greeting or initial message, do it here.
Override for notification when getNewNews() action is successful
Override for notification when getNewNews() action fails
Override for notification when fetchArticle() action is completed