twisted.words.protocols.msn.FileReceive : API documentation

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 _PauseableMixin (via LineReceiver):

Method	pauseProducing	Undocumented
Method	resumeProducing	Undocumented
Method	stopProducing	Undocumented

Inherited from _PauseableMixin (via LineReceiver):

Method	pauseProducing	Undocumented
Method	resumeProducing	Undocumented
Method	stopProducing	Undocumented

Inherited from _PauseableMixin (via LineReceiver):

Method	pauseProducing	Undocumented
Method	resumeProducing	Undocumented
Method	stopProducing	Undocumented

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)

Parameters	auth	auth string received in the file invitation.
	myUserHandle	your userhandle.
	file	A string or file object represnting the file to save data to.
	directory	optional parameter specifiying the directory. Defaults to the current directory.
	overwrite	if true and a file of the same name exists on your system, it will be overwritten. (0 by default)

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 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.

def parseHeader(self, header): (source)

parse the header of each 'message' to obtain the segment length

def lineReceived(self, line): (source)

overrides twisted.protocols.basic.LineReceiver.lineReceived

Override this for when each line is received.

Parameters line The line which was received with the delimiter removed. (type: bytes)

def rawDataReceived(self, data): (source)