t.w.p.m.FileSend(LineReceiver) : class documentation

Part of twisted.words.protocols.msn View Source View In Hierarchy

This class provides support for sending files to other contacts.
Instance Variable bytesSent the number of bytes that have currently been sent.
Instance Variable completed true if the send has completed.
Instance Variable connected true if a connection has been established.
Instance Variable targetUser the target user (contact).
Instance Variable segmentSize the segment (block) size.
Instance Variable auth the auth cookie (number) to use when sending the transfer invitation
Method __init__
Method connectionMade Called when a connection is made.
Method connectionLost Called when the connection is shut down.
Method lineReceived Override this for when each line is received.
Method handle_VER Undocumented
Method handle_USR Undocumented
Method handle_TFR Undocumented
Method handle_BYE Undocumented
Method handle_CCL Undocumented
Method handle_UNKNOWN Undocumented
Method makeHeader make the appropriate header given a specific segment size.
Method sendPart send a segment of data

Inherited from LineReceiver:

Class Variable delimiter The line-ending delimiter to use. By default this is b'\r\n'.
Class Variable MAX_LENGTH The maximum length of a line to allow (If a sent line is longer than this, the connection is dropped). Default is 16384.
Method clearLineBuffer Clear buffered data.
Method dataReceived Protocol.dataReceived. Translates bytes into lines, and calls lineReceived (or rawDataReceived, depending on mode.)
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.
Method rawDataReceived Override this for when raw data is received.
Method sendLine Sends a line to the other end of the connection.
Method lineLengthExceeded Called when the maximum line length has been reached. Override if it needs to be dealt with in some special way.

Inherited from Protocol (via LineReceiver):

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.

Inherited from _PauseableMixin (via LineReceiver):

Method pauseProducing Undocumented
Method resumeProducing Undocumented
Method stopProducing Undocumented
bytesSent =
the number of bytes that have currently been sent.
completed =
true if the send has completed.
connected =
true if a connection has been established.
targetUser =
the target user (contact).
segmentSize =
the segment (block) size.
auth =
the auth cookie (number) to use when sending the transfer invitation
def __init__(self, file): (source)
ParametersfileA string or file object represnting the file to send.
def connectionMade(self): (source)
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 connectionLost(self, reason): (source)
Called when the connection is shut down.

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

def lineReceived(self, line): (source)
Override this for when each line is received.
ParameterslineThe line which was received with the delimiter removed. (type: bytes)
def handle_VER(self, params): (source)
Undocumented
def handle_USR(self, params): (source)
Undocumented
def handle_TFR(self, params): (source)
Undocumented
def handle_BYE(self, params): (source)
Undocumented
def handle_CCL(self, params): (source)
Undocumented
def handle_UNKNOWN(self, cmd, params): (source)
Undocumented
def makeHeader(self, size): (source)
make the appropriate header given a specific segment size.
def sendPart(self): (source)
send a segment of data
API Documentation for Twisted, generated by pydoctor at 2012-12-26 12:18:15.