twisted.protocols.dict.DictClient : API documentation

class documentation

class twisted.protocols.dict.DictClient(basic.LineReceiver): (source)

Known subclasses: twisted.protocols.dict.DictLookup

dict (RFC2229) client

Instance Variable	data	Undocumented
Class Variable	MAX_LENGTH	Undocumented
Instance Variable	state	Undocumented
Instance Variable	mode	Undocumented
Instance Variable	result	Undocumented
Class Variable	factory	Undocumented
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'`.
Instance Variable	line_mode	Undocumented
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.
Instance Variable	_buffer	Undocumented
Instance Variable	_busyReceiving	Undocumented

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

Instance Variable	connected	Undocumented
Instance Variable	transport	Undocumented
Method	makeConnection	Make a connection to a transport and a server.

Inherited from _PauseableMixin (via LineReceiver):

Instance Variable	paused	Undocumented
Method	pauseProducing	Undocumented
Method	resumeProducing	Undocumented
Method	stopProducing	Undocumented

data = (source)

Undocumented

MAX_LENGTH = (source)

overrides twisted.protocols.basic.LineReceiver.MAX_LENGTH

Undocumented

(type: int)

state = (source)

Undocumented

(type: str)

mode = (source)

Undocumented

(type: str)

result = (source)

Undocumented

factory = (source)

overrides twisted.internet.protocol.Protocol.factory

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 sendLine(self, line): (source)

overrides twisted.protocols.basic.LineReceiver.sendLine

Throw up if the line is longer than 1022 characters

def lineReceived(self, line): (source)

overrides twisted.protocols.basic.LineReceiver.lineReceived

Override this for when each line is received.

Parameters line The line which was received with the delimiter removed. (type: bytes)

def dictCode_default(self, line): (source)

Unknown message

def dictCode_221_ready(self, line): (source)

We are about to get kicked off, do nothing

def dictCode_220_conn(self, line): (source)

Greeting message

def dictCode_530_conn(self): (source)

Undocumented

def dictCode_420_conn(self): (source)

Undocumented

def dictCode_421_conn(self): (source)

Undocumented

def sendDefine(self, database, word): (source)

Send a dict DEFINE command

def sendMatch(self, database, strategy, word): (source)

Send a dict MATCH command

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_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_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 dictCode_250_define(self, line): (source)

def dictCode_250_match(self, line): (source)

def protocolError(self, reason): (source)

overridden in twisted.protocols.dict.DictLookup

override to catch unexpected dict protocol conditions

def dictConnected(self): (source)

overridden in twisted.protocols.dict.DictLookup

override to be notified when the server is ready to accept commands

def defineFailed(self, reason): (source)

overridden in twisted.protocols.dict.DictLookup

override to catch reasonable failure responses to DEFINE

def defineDone(self, result): (source)

overridden in twisted.protocols.dict.DictLookup

override to catch successful DEFINE

def matchFailed(self, reason): (source)

overridden in twisted.protocols.dict.DictLookup

override to catch resonable failure responses to MATCH

def matchDone(self, result): (source)

overridden in twisted.protocols.dict.DictLookup

override to catch successful MATCH

API Documentation for Twisted, generated by pydoctor 20.12.1 at 2021-02-28 19:53:36.