twisted.protocols.dict.DictClient

class documentation

class DictClient(basic.LineReceiver): (source)

Known subclasses: twisted.protocols.dict.DictLookup

View In Hierarchy

dict (RFC2229) client
Method __init__ Undocumented
Method connection​Made Called when a connection is made.
Method define​Done override to catch successful DEFINE
Method define​Failed override to catch reasonable failure responses to DEFINE
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 dict​Connected override to be notified when the server is ready to accept commands
Method line​Received Override this for when each line is received.
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
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:

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 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 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 LineReceiver):

Method pause​Producing Undocumented
Method resume​Producing Undocumented
Method stop​Producing Undocumented
Instance Variable paused Undocumented
def __init__(self): (source)

Undocumented

def connectionMade(self): (source)
from twisted.internet.interfaces.IProtocol
overrides twisted.internet.protocol.BaseProtocol.connectionMade

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.

def defineDone(self, result): (source)
overridden in twisted.protocols.dict.DictLookup
override to catch successful DEFINE
def defineFailed(self, reason): (source)
overridden in twisted.protocols.dict.DictLookup
override to catch reasonable failure responses to DEFINE
def dictCode_150_define(self, line): (source)
n definitions retrieved
def dictCode_151_define(self, line): (source)
Definition text follows
def dictCode_152_match(self, line): (source)
n matches found, text follows
def dictCode_220_conn(self, line): (source)
Greeting message
def dictCode_221_ready(self, line): (source)
We are about to get kicked off, do nothing
def dictCode_250_define(self, line): (source)
ok
def dictCode_250_match(self, line): (source)
ok
def dictCode_420_conn(self): (source)

Undocumented

def dictCode_421_conn(self): (source)

Undocumented

def dictCode_530_conn(self): (source)

Undocumented

def dictCode_550_define(self, line): (source)
Invalid database
def dictCode_550_match(self, line): (source)
Invalid database
def dictCode_551_match(self, line): (source)
Invalid strategy
def dictCode_552_define(self, line): (source)
No match
def dictCode_552_match(self, line): (source)
No match
def dictCode_default(self, line): (source)
Unknown message
def dictCode_text_define(self, line): (source)
A line of definition text received
def dictCode_text_match(self, line): (source)
One line of match text received
def dictConnected(self): (source)
overridden in twisted.protocols.dict.DictLookup
override to be notified when the server is ready to accept commands
def lineReceived(self, line): (source)
overrides twisted.protocols.basic.LineReceiver.lineReceived
Override this for when each line is received.
Parameters
line:bytesThe line which was received with the delimiter removed.
def matchDone(self, result): (source)
overridden in twisted.protocols.dict.DictLookup
override to catch successful MATCH
def matchFailed(self, reason): (source)
overridden in twisted.protocols.dict.DictLookup
override to catch resonable failure responses to MATCH
def protocolError(self, reason): (source)
overridden in twisted.protocols.dict.DictLookup
override to catch unexpected dict protocol conditions
def sendDefine(self, database, word): (source)
Send a dict DEFINE command
def sendLine(self, line): (source)
overrides twisted.protocols.basic.LineReceiver.sendLine
Throw up if the line is longer than 1022 characters
def sendMatch(self, database, strategy, word): (source)
Send a dict MATCH command
MAX_LENGTH: int = (source)
overrides twisted.protocols.basic.LineReceiver.MAX_LENGTH

Undocumented

Value
1024
factory = (source)
overrides twisted.internet.protocol.Protocol.factory

Undocumented

data = (source)

Undocumented

mode: str = (source)

Undocumented

result = (source)

Undocumented

state: str = (source)

Undocumented