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

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

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)

Parameters file A string or file object represnting the file to send.

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

twisted.words.protocols.msn.FileSend(LineReceiver) class documentation

`twisted.words.protocols.msn.FileSend(LineReceiver)` class documentation