twisted.protocols.dict.DictClient(basic.LineReceiver)
class documentationtwisted.protocols.dict
View Source
(View In Hierarchy)
Known subclasses: twisted.protocols.dict.DictLookup
dict (RFC2229) client
Method | __init__ | Undocumented |
Method | connectionMade | Called when a connection is made. |
Method | sendLine | Throw up if the line is longer than 1022 characters |
Method | lineReceived | Override this for when each line is received. |
Method | dictCode_default | Unknown message |
Method | dictCode_221_ready | We are about to get kicked off, do nothing |
Method | dictCode_220_conn | Greeting message |
Method | dictCode_530_conn | Undocumented |
Method | dictCode_420_conn | Undocumented |
Method | dictCode_421_conn | Undocumented |
Method | sendDefine | Send a dict DEFINE command |
Method | sendMatch | Send a dict MATCH command |
Method | dictCode_550_define | Invalid database |
Method | dictCode_550_match | Invalid database |
Method | dictCode_551_match | Invalid strategy |
Method | dictCode_552_define | No match |
Method | dictCode_552_match | No match |
Method | dictCode_150_define | n definitions retrieved |
Method | dictCode_151_define | Definition text follows |
Method | dictCode_152_match | n matches found, text follows |
Method | dictCode_text_define | A line of definition text received |
Method | dictCode_text_match | One line of match text received |
Method | dictCode_250_define | ok |
Method | dictCode_250_match | ok |
Method | protocolError | override to catch unexpected dict protocol conditions |
Method | dictConnected | override to be notified when the server is ready to accept commands |
Method | defineFailed | override to catch reasonable failure responses to DEFINE |
Method | defineDone | override to catch successful DEFINE |
Method | matchFailed | override to catch resonable failure responses to MATCH |
Method | matchDone | override to catch successful MATCH |
Inherited from LineReceiver:
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 | 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 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 LineReceiver, Protocol):
Method | makeConnection | Make a connection to a transport and a server. |
Inherited from _PauseableMixin (via LineReceiver):
Method | pauseProducing | Undocumented |
Method | resumeProducing | Undocumented |
Method | stopProducing | Undocumented |
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 this for when each line is received.
Parameters | line | The line which was received with the delimiter removed. (type: bytes ) |
override to catch unexpected dict protocol conditions
override to be notified when the server is ready to accept commands
override to catch reasonable failure responses to DEFINE
override to catch successful DEFINE
override to catch resonable failure responses to MATCH
override to catch successful MATCH