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`.`ftp`.`DTP``

class documentation

`class DTP(protocol.Protocol): (source)`

Implements interfaces: `twisted.internet.interfaces.IConsumer`

View In Hierarchy

Undocumented

Method | `connectionLost` | Called when the connection is shut down.
Method | `connectionMade` | Called when a connection is made.
Method | `dataReceived` | Called whenever data is received.
Method | `pauseProducing` | Undocumented
Method | `registerConsumer` | Undocumented
Method | `registerProducer` | Register to receive data from a producer.
Method | `resumeProducing` | Undocumented
Method | `sendLine` | Send a line to data channel.
Method | `sendListResponse` | Undocumented
Method | `stopProducing` | Undocumented
Method | `unregisterProducer` | Stop consuming data from a producer, without disconnecting.
Method | `write` | The producer will write data by calling this method.
Instance Variable | `isConnected` | Undocumented
Method | `_conswrite` | Undocumented
Method | `_formatOneListResponse` | Helper method to format one entry's info into a text entry like: 'drwxrwxrwx 0 user group 0 Jan 01 1970 filename.txt'
Method | `_unregConsumer` | Undocumented
Class Variable | `_encoding` | Undocumented
Instance Variable | `_buffer` | Undocumented
Instance Variable | `_cons` | Undocumented
Instance Variable | `_onConnLost` | Undocumented

Inherited from `Protocol`:

Method | `logPrefix` | Return a prefix matching the class name, to identify log messages related to this protocol instance.
Class Variable | `factory` | Undocumented

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

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

def connectionLost(self, reason): (source)
from `twisted.internet.interfaces.IProtocol`
overrides `twisted.internet.protocol.Protocol.connectionLost`

Called when the connection is shut down.

Clear any circular references here, and any external references to this Protocol. The connection has been closed.

Parameters
reason:`twisted.python.failure.Failure` | 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 dataReceived(self, bytes): (source)
from `twisted.internet.interfaces.IProtocol`
overrides `twisted.internet.protocol.Protocol.dataReceived`

Called whenever data is received.

Use this method to translate to a higher-level message. Usually, some callback will be made upon the receipt of each complete protocol message.

Parameters
bytes | Undocumented
data | a string of indeterminate length. Please keep in mind that you will probably need to buffer some data, as partial (or multiple) protocol messages may be received! I recommend that unit tests for protocols call through to this method with differing chunk sizes, down to one byte at a time.

def pauseProducing(self): (source)

Undocumented

def registerConsumer(self, cons): (source)

Undocumented

def registerProducer(self, producer, streaming): (source)
from `twisted.internet.interfaces.IConsumer`

Register to receive data from a producer.

This sets self to be a consumer for a producer. When this object runs out of data (as when a send(2) call on a socket succeeds in moving the last data from a userspace buffer into a kernelspace buffer), it will ask the producer to resumeProducing().

For `IPullProducer` providers, `resumeProducing` will be called once each time data is required.

For `IPushProducer` providers, `pauseProducing` will be called whenever the write buffer fills up and `resumeProducing` will only be called when it empties. The consumer will only call `resumeProducing` to balance a previous `pauseProducing` call; the producer is assumed to start in an un-paused state.

Parameters
producer | Undocumented
streaming | `True` if `producer` provides `IPushProducer`, `False` if `producer` provides `IPullProducer`.
Raises
`RuntimeError` | If a producer is already registered.

def resumeProducing(self): (source)

Undocumented

def sendLine(self, line): (source)

Send a line to data channel.

Parameters
line:`bytes` | The line to be sent.

def sendListResponse(self, name, response): (source)

Undocumented

def stopProducing(self): (source)

Undocumented

def unregisterProducer(self): (source)
from `twisted.internet.interfaces.IConsumer`

Stop consuming data from a producer, without disconnecting.

def write(self, data): (source)
from `twisted.internet.interfaces.IConsumer`

The producer will write data by calling this method.

The implementation must be non-blocking and perform whatever buffering is necessary. If the producer has provided enough data for now and it is a `IPushProducer`, the consumer may call its `pauseProducing` method.

isConnected: `bool` = (source)

Undocumented

def _conswrite(self, bytes): (source)

Undocumented

def _formatOneListResponse(self, name, size, directory, permissions, hardlinks, modified, owner, group): (source)

Helper method to format one entry's info into a text entry like: 'drwxrwxrwx 0 user group 0 Jan 01 1970 filename.txt'

Parameters
name | `bytes` name of the entry (file or directory or link)
size | `int` size of the entry
directory | evals to `bool` - whether the entry is a directory
permissions | `twisted.python.filepath.Permissions` object representing that entry's permissions
hardlinks | `int` number of hardlinks
modified | `float` - entry's last modified time in seconds since the epoch
owner | `str` username of the owner
group | `str` group name of the owner
Returns
`str` in the requisite format

def _unregConsumer(self, ignored): (source)

Undocumented

_encoding: `str` = (source)

Undocumented

_buffer = (source)

Undocumented

_cons = (source)

Undocumented

_onConnLost = (source)

Undocumented