Go to the latest version of this document.
search in docstrings

Search bar offers the following options:

- Term presence. The below example searches for documents that must contain “foo”, might contain “bar” and must not contain “baz”: `+foo bar -baz`
- Wildcards. The below example searches for documents with words beginning with “foo”: `foo*`
- Search in specific fields. The following search matches all objects in "twisted.mail" that matches “search”: `+qname:twisted.mail.* +search`

  Possible fields: 'name', 'qname' (fully qualified name), 'docstring', and 'kind'. Last two fields are only applicable if "search in docstrings" is enabled.

- Fuzzy matches. The following search matches all documents that have a word within 1 edit distance of “foo”: `foo~1`

Results provided by Lunr.js

# ``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 | `connectionMade` | Called when a connection is made.
Method | `defineDone` | override to catch successful DEFINE
Method | `defineFailed` | override to catch reasonable failure responses to DEFINE
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_220_conn` | Greeting message
Method | `dictCode_221_ready` | We are about to get kicked off, do nothing
Method | `dictCode_250_define` | ok
Method | `dictCode_250_match` | ok
Method | `dictCode_420_conn` | Undocumented
Method | `dictCode_421_conn` | Undocumented
Method | `dictCode_530_conn` | Undocumented
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_default` | Unknown message
Method | `dictCode_text_define` | A line of definition text received
Method | `dictCode_text_match` | One line of match text received
Method | `dictConnected` | override to be notified when the server is ready to accept commands
Method | `lineReceived` | Override this for when each line is received.
Method | `matchDone` | override to catch successful MATCH
Method | `matchFailed` | override to catch reasonable failure responses to MATCH
Method | `protocolError` | override to catch unexpected dict protocol conditions
Method | `sendDefine` | Send a dict DEFINE command
Method | `sendLine` | Throw up if the line is longer than 1022 characters
Method | `sendMatch` | 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 | `clearLineBuffer` | Clear buffered data.
Method | `dataReceived` | Protocol.dataReceived. Translates bytes into lines, and calls lineReceived (or rawDataReceived, depending on mode.)
Method | `lineLengthExceeded` | Called when the maximum line length has been reached. Override if it needs to be dealt with in some special way.
Method | `rawDataReceived` | Override this for when raw data is received.
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.
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 | `_busyReceiving` | Undocumented

Inherited from `Protocol` (via `LineReceiver`):

Method | `connectionLost` | Called when the connection is shut down.
Method | `logPrefix` | Return a prefix matching the class name, to identify log messages related to this protocol instance.

Inherited from `BaseProtocol` (via `LineReceiver`, `Protocol`):

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

Inherited from `_PauseableMixin` (via `LineReceiver`, `Protocol`, `BaseProtocol`):

Method | `pauseProducing` | Undocumented
Method | `resumeProducing` | Undocumented
Method | `stopProducing` | 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:`bytes` | The 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 reasonable 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