# ``twisted`.`words`.`protocols`.`irc`.`DccSendProtocol``

class documentation

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

View In Hierarchy

Protocol for an outgoing Direct Client Connection SEND.

Method | `__init__` | 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 | `sendBlock` | Undocumented
Instance Variable | `blocksize` | An integer representing the size of an individual block of data.
Instance Variable | `bytesSent` | An integer representing the number of bytes sent.
Instance Variable | `completed` | An integer representing whether the transfer has been completed or not.
Instance Variable | `connected` | An integer representing whether the connection has been established or not.
Instance Variable | `file` | The file to be sent. This can be either a file object or simply the name of the file.

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 | `transport` | Undocumented

Inherited from `Ephemeral`:

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, file): (source)

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, data): (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
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 sendBlock(self): (source)

Undocumented

blocksize: `int` = (source)
An integer representing the size of an individual block of data.
bytesSent: `int` = (source)
An integer representing the number of bytes sent.
completed: `int` = (source)
An integer representing whether the transfer has been completed or not.
connected: `int` = (source)
overrides `twisted.internet.protocol.BaseProtocol.connected`
An integer representing whether the connection has been established or not.
file: `file` or `bytes` = (source)
The file to be sent. This can be either a file object or simply the name of the file.