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

This class provides support for receiving files from contacts.

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

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:

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

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.

Parameters reason (type: twisted.python.failure.Failure )

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