twisted.words.protocols.irc.DccSendProtocol(protocol.Protocol, styles.Ephemeral) class documentationtwisted.words.protocols.irc
View Source
(View In Hierarchy)
Protocol for an outgoing Direct Client Connection SEND.
| Instance Variable | blocksize | An integer representing the size of an individual block of data. (type: int) |
| Instance Variable | file | The file to be sent. This can be either a file object or simply the name
of the file. (type: file
or bytes) |
| Instance Variable | bytesSent | An integer representing the number of bytes sent. (type: int) |
| Instance Variable | completed | An integer representing whether the transfer has been completed or not. (type: int) |
| Instance Variable | connected | An integer representing whether the connection has been established or not. (type: int) |
| Method | __init__ | Undocumented |
| Method | connectionMade | Called when a connection is made. |
| Method | dataReceived | Called whenever data is received. |
| Method | sendBlock | Undocumented |
| Method | connectionLost | Called when the connection is shut down. |
Inherited from Protocol:
| Method | logPrefix | Return a prefix matching the class name, to identify log messages related to this protocol instance. |
Inherited from BaseProtocol (via Protocol):
| Method | makeConnection | Make a connection to a transport and a server. |
Inherited from Ephemeral:
| Method | __reduce__ | Serialize any subclass of Ephemeral
in a way which replaces it with Ephemeral
itself. |
| Method | __getstate__ | Undocumented |
| Method | __setstate__ | Undocumented |
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.
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. |
Called when the connection is shut down.
Clear any circular references here, and any external references to this Protocol. The connection has been closed.