twisted.words.protocols.irc.DccFileReceive : API documentation

Higher-level coverage for getting a file from DCC SEND.

I allow you to change the file's name and destination directory. I won't overwrite an existing file unless I've been told it's okay to do so. If passed the resumeOffset keyword argument I will attempt to resume the file from that amount of bytes.

XXX: I need to let the client know when I am finished. XXX: I need to decide how to keep a progress indicator updated. XXX: Client needs a way to tell me "Do not finish until I say so." XXX: I need to make sure the client understands if the file cannot be written.

Method	__init__	Undocumented
Method	set_directory	Set the directory where the downloaded file will be placed.
Method	set_filename	Change the name of the file being transferred.
Method	set_overwrite	May I overwrite existing files?
Method	connectionMade	Called when a connection is made.
Method	dataReceived	Called when data is received.
Method	connectionLost	When the connection is lost, I close the file.
Method	__str__	Undocumented
Method	__repr__	Undocumented

Inherited from BaseProtocol (via DccFileReceiveBasic, Protocol):

Method

makeConnection

Make a connection to a transport and a server.

Inherited from Ephemeral (via DccFileReceiveBasic):

Method	__getstate__	Undocumented
Method	__setstate__	Undocumented

def __init__(self, filename, fileSize=-1, queryData=None, destDir='.', resumeOffset=0): (source)

overrides twisted.words.protocols.irc.DccFileReceiveBasic.__init__

Undocumented

def set_directory(self, directory): (source)

Set the directory where the downloaded file will be placed.

May raise OSError if the supplied directory path is not suitable.

def set_filename(self, filename): (source)

Change the name of the file being transferred.

This replaces the file name provided by the sender.

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 dataReceived(self, data): (source)

from twisted.internet.interfaces.IProtocol

overrides twisted.words.protocols.irc.DccFileReceiveBasic.dataReceived

Called when data is received.

Warning: This just acknowledges to the remote host that the data has been received; it doesn't *do* anything with the data, so you'll want to override this.

def connectionLost(self, reason): (source)

from twisted.internet.interfaces.IProtocol

overrides twisted.internet.protocol.Protocol.connectionLost

When the connection is lost, I close the file.

t.w.p.i.DccFileReceive(DccFileReceiveBasic) : class documentation