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`.`words`.`protocols`.`irc`.`DccFileReceiveBasic``

class documentation

`class DccFileReceiveBasic(protocol.Protocol, styles.Ephemeral): (source)`

Known subclasses: `twisted.words.protocols.irc.DccFileReceive`

View In Hierarchy

Bare protocol to receive a Direct Client Connection SEND stream.

This does enough to keep the other guy talking, but you'll want to extend my dataReceived method to *do* something with the data I get.

Method | `__init__` | No summary
Method | `dataReceived` | See: `protocol.Protocol.dataReceived`
Instance Variable | `bytesReceived` | An integer representing the number of bytes of data received.
Instance Variable | `resume` | Undocumented

Inherited from `Protocol`:

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.
Class Variable | `factory` | Undocumented

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

Method | `connectionMade` | Called when a connection is made.
Method | `makeConnection` | Make a connection to a transport and a server.
Instance Variable | `connected` | Undocumented
Instance Variable | `transport` | Undocumented

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

Method | `__getstate__` | Undocumented
Method | `__reduce__` | Serialize any subclass of `Ephemeral` in a way which replaces it with `Ephemeral` itself.
Method | `__setstate__` | Undocumented
Instance Variable | `__class__` | Undocumented

def __init__(self, resumeOffset=0): (source)
overridden in `twisted.words.protocols.irc.DccFileReceive`

Parameters
resumeOffset:`int` | An integer representing the amount of bytes from where the transfer of data should be resumed.

def dataReceived(self, data): (source)
from `twisted.internet.interfaces.IProtocol`
overrides `twisted.internet.protocol.Protocol.dataReceived`
overridden in `twisted.words.protocols.irc.DccFileReceive`

See: `protocol.Protocol.dataReceived`

Warning: This just acknowledges to the remote host that the data has been received; it doesn't do anything with the data, so you'll want to override this.

bytesReceived: `int` = (source)

An integer representing the number of bytes of data received.

resume = (source)

Undocumented