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

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

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.

Instance Variable filename The name of the file to get. (type: bytes)
Instance Variable fileSize The size of the file to get, which has a default value of -1 if the size of the file was not specified in the DCC SEND request. (type: int)
Instance Variable destDir The destination directory for the file to be received. (type: bytes)
Instance Variable overwrite An integer representing whether an existing file should be overwritten or not. This initially is an int but can be modified to be a bool using the set_overwrite method. (type: int or bool)
Instance Variable queryData queryData is a 3-tuple of (user, channel, data). (type: tuple)
Instance Variable fromUser This is the hostmask of the requesting user and is found at index 0 of queryData. (type: bytes)
Method __init__
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 See: protocol.Protocol.dataReceived
Method connectionLost When the connection is lost, I close the file.
Method __str__ Undocumented
Method __repr__ Undocumented

Inherited from Ephemeral (via DccFileReceiveBasic):

Method __getstate__ Undocumented
Method __setstate__ Undocumented

Inherited from Ephemeral (via DccFileReceiveBasic):

Method __getstate__ Undocumented
Method __setstate__ Undocumented

Inherited from Ephemeral (via DccFileReceiveBasic):

Method __getstate__ Undocumented
Method __setstate__ Undocumented

Inherited from Ephemeral (via DccFileReceiveBasic):

Method __getstate__ Undocumented
Method __setstate__ Undocumented
filename =
The name of the file to get. (type: bytes)
fileSize =
The size of the file to get, which has a default value of -1 if the size of the file was not specified in the DCC SEND request. (type: int)
destDir =
The destination directory for the file to be received. (type: bytes)
overwrite =
An integer representing whether an existing file should be overwritten or not. This initially is an int but can be modified to be a bool using the set_overwrite method. (type: int or bool)
queryData =
queryData is a 3-tuple of (user, channel, data). (type: tuple)
fromUser =
This is the hostmask of the requesting user and is found at index 0 of queryData. (type: bytes)
def __init__(self, filename, fileSize=-1, queryData=None, destDir='.', resumeOffset=0): (source)
ParametersresumeOffsetAn integer representing the amount of bytes from where the transfer of data should be resumed. (type: int)
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.

ParametersdirectoryThe directory where the file to be received will be placed. (type: bytes)
def set_filename(self, filename): (source)

Change the name of the file being transferred.

This replaces the file name provided by the sender.

ParametersfilenameThe new name for the file. (type: bytes)
def set_overwrite(self, boolean): (source)

May I overwrite existing files?

ParametersbooleanA boolean value representing whether existing files should be overwritten or not. (type: bool)
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 dataReceived(self, data): (source)

See: protocol.Protocol.dataReceived

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)

When the connection is lost, I close the file.

ParametersreasonThe reason why the connection was lost. (type: Failure)
def __str__(self): (source)
Undocumented
def __repr__(self): (source)
Undocumented
API Documentation for Twisted, generated by pydoctor at 2015-04-13 15:26:48.