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

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

This class provides support for receiving files from contacts.
Instance Variable fileSize the size of the receiving file. (you will have to set this)
Instance Variable connected true if a connection has been established.
Instance Variable completed true if the transfer is complete.
Instance Variable bytesReceived number of bytes (of the file) received. This does not include header data.
Method __init__ No summary
Method connectionMade Called when a connection is made.
Method connectionLost Called when the connection is shut down.
Method parseHeader parse the header of each 'message' to obtain the segment length
Method lineReceived Override this for when each line is received.
Method rawDataReceived Override this for when raw data is received.
Method handle_VER Undocumented
Method handle_FIL Undocumented
Method handle_UNKNOWN Undocumented
Method gotSegment called when a segment (block) of data arrives.

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 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
fileSize =
the size of the receiving file. (you will have to set this)
connected =
true if a connection has been established.
completed =
true if the transfer is complete.
bytesReceived =
number of bytes (of the file) received. This does not include header data.
def __init__(self, auth, myUserHandle, file, directory='', overwrite=0): (source)
Parametersauthauth string received in the file invitation.
myUserHandleyour userhandle.
fileA string or file object represnting the file to save data to.
directoryoptional parameter specifiying the directory. Defaults to the current directory.
overwriteif true and a file of the same name exists on your system, it will be overwritten. (0 by default)
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 parseHeader(self, header): (source)
parse the header of each 'message' to obtain the segment length
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 rawDataReceived(self, data): (source)
Override this for when raw data is received.
def handle_VER(self, params): (source)
Undocumented
def handle_FIL(self, params): (source)
Undocumented
def handle_UNKNOWN(self, cmd, params): (source)
Undocumented
def gotSegment(self, data): (source)
called when a segment (block) of data arrives.
API Documentation for Twisted, generated by pydoctor at 2013-11-08 22:07:30.