class documentation
class DictLookup(DictClient): (source)
Utility class for a single dict transaction. To be used with DictLookupFactory
Method | define |
override to catch successful DEFINE |
Method | define |
override to catch reasonable failure responses to DEFINE |
Method | dict |
override to be notified when the server is ready to accept commands |
Method | match |
override to catch successful MATCH |
Method | match |
override to catch reasonable failure responses to MATCH |
Method | protocol |
override to catch unexpected dict protocol conditions |
Inherited from DictClient
:
Method | __init__ |
Undocumented |
Method | connection |
Called when a connection is made. |
Method | dict |
n definitions retrieved |
Method | dict |
Definition text follows |
Method | dict |
n matches found, text follows |
Method | dict |
Greeting message |
Method | dict |
We are about to get kicked off, do nothing |
Method | dict |
ok |
Method | dict |
ok |
Method | dict |
Undocumented |
Method | dict |
Undocumented |
Method | dict |
Undocumented |
Method | dict |
Invalid database |
Method | dict |
Invalid database |
Method | dict |
Invalid strategy |
Method | dict |
No match |
Method | dict |
No match |
Method | dict |
Unknown message |
Method | dict |
A line of definition text received |
Method | dict |
One line of match text received |
Method | line |
Override this for when each line is received. |
Method | send |
Send a dict DEFINE command |
Method | send |
Throw up if the line is longer than 1022 characters |
Method | send |
Send a dict MATCH command |
Constant | MAX |
Undocumented |
Class Variable | factory |
Undocumented |
Instance Variable | data |
Undocumented |
Instance Variable | mode |
Undocumented |
Instance Variable | result |
Undocumented |
Instance Variable | state |
Undocumented |
Inherited from LineReceiver
(via DictClient
):
Method | clear |
Clear buffered data. |
Method | data |
Protocol.dataReceived. Translates bytes into lines, and calls lineReceived (or rawDataReceived, depending on mode.) |
Method | line |
Called when the maximum line length has been reached. Override if it needs to be dealt with in some special way. |
Method | raw |
Override this for when raw data is received. |
Method | set |
Sets the line-mode of this receiver. |
Method | set |
Sets the raw mode of this receiver. Further data received will be sent to rawDataReceived rather than lineReceived. |
Class Variable | delimiter |
The line-ending delimiter to use. By default this is b'\r\n'. |
Instance Variable | line |
Undocumented |
Instance Variable | _buffer |
Undocumented |
Instance Variable | _busy |
Undocumented |
Inherited from Protocol
(via DictClient
, LineReceiver
):
Method | connection |
Called when the connection is shut down. |
Method | log |
Return a prefix matching the class name, to identify log messages related to this protocol instance. |
Inherited from BaseProtocol
(via DictClient
, LineReceiver
, Protocol
):
Method | make |
Make a connection to a transport and a server. |
Instance Variable | connected |
Undocumented |
Instance Variable | transport |
Undocumented |
Inherited from _PauseableMixin
(via DictClient
, LineReceiver
, Protocol
, BaseProtocol
):
Method | pause |
Undocumented |
Method | resume |
Undocumented |
Method | stop |
Undocumented |
Instance Variable | paused |
Undocumented |