class documentation

class DictLookup(DictClient): (source)

View In Hierarchy

Utility class for a single dict transaction. To be used with DictLookupFactory
Method define​Done override to catch successful DEFINE
Method define​Failed override to catch reasonable failure responses to DEFINE
Method dict​Connected override to be notified when the server is ready to accept commands
Method match​Done override to catch successful MATCH
Method match​Failed override to catch resonable failure responses to MATCH
Method protocol​Error override to catch unexpected dict protocol conditions

Inherited from DictClient:

Method __init__ Undocumented
Method connection​Made Called when a connection is made.
Method dict​Code_150_define n definitions retrieved
Method dict​Code_151_define Definition text follows
Method dict​Code_152_match n matches found, text follows
Method dict​Code_220_conn Greeting message
Method dict​Code_221_ready We are about to get kicked off, do nothing
Method dict​Code_250_define ok
Method dict​Code_250_match ok
Method dict​Code_420_conn Undocumented
Method dict​Code_421_conn Undocumented
Method dict​Code_530_conn Undocumented
Method dict​Code_550_define Invalid database
Method dict​Code_550_match Invalid database
Method dict​Code_551_match Invalid strategy
Method dict​Code_552_define No match
Method dict​Code_552_match No match
Method dict​Code_default Unknown message
Method dict​Code_text_define A line of definition text received
Method dict​Code_text_match One line of match text received
Method line​Received Override this for when each line is received.
Method send​Define Send a dict DEFINE command
Method send​Line Throw up if the line is longer than 1022 characters
Method send​Match Send a dict MATCH command
Constant MAX​_LENGTH 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​Line​Buffer Clear buffered data.
Method data​Received Protocol.dataReceived. Translates bytes into lines, and calls lineReceived (or rawDataReceived, depending on mode.)
Method line​Length​Exceeded Called when the maximum line length has been reached. Override if it needs to be dealt with in some special way.
Method raw​Data​Received Override this for when raw data is received.
Method set​Line​Mode Sets the line-mode of this receiver.
Method set​Raw​Mode 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​_mode Undocumented
Instance Variable _buffer Undocumented
Instance Variable _busy​Receiving Undocumented

Inherited from Protocol (via DictClient, LineReceiver):

Method connection​Lost Called when the connection is shut down.
Method log​Prefix 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​Connection Make a connection to a transport and a server.
Instance Variable connected Undocumented
Instance Variable transport Undocumented

Inherited from _PauseableMixin (via DictClient, LineReceiver):

Method pause​Producing Undocumented
Method resume​Producing Undocumented
Method stop​Producing Undocumented
Instance Variable paused Undocumented
def defineDone(self, result): (source)
override to catch successful DEFINE
def defineFailed(self, reason): (source)
override to catch reasonable failure responses to DEFINE
def dictConnected(self): (source)
override to be notified when the server is ready to accept commands
def matchDone(self, result): (source)
override to catch successful MATCH
def matchFailed(self, reason): (source)
override to catch resonable failure responses to MATCH
def protocolError(self, reason): (source)
override to catch unexpected dict protocol conditions