An abstract base class to handle file transfer (FT) requests. More...
#include <siprofilefthandler.h>
Public Member Functions | |
virtual | ~SIProfileFTHandler () |
virtual void | handleFTRequest (const JID &from, const std::string &id, const std::string &sid, const std::string &name, long size, const std::string &hash, const std::string &date, const std::string &mimetype, const std::string &desc, int stypes, long offset, long length)=0 |
virtual void | handleFTRequestError (Stanza *stanza, const std::string &sid)=0 |
virtual void | handleFTSOCKS5Bytestream (SOCKS5Bytestream *s5b)=0 |
An abstract base class to handle file transfer (FT) requests.
Definition at line 33 of file siprofilefthandler.h.
virtual ~SIProfileFTHandler | ( | ) | [inline, virtual] |
Virtual destructor.
Definition at line 40 of file siprofilefthandler.h.
virtual void handleFTRequest | ( | const JID & | from, | |
const std::string & | id, | |||
const std::string & | sid, | |||
const std::string & | name, | |||
long | size, | |||
const std::string & | hash, | |||
const std::string & | date, | |||
const std::string & | mimetype, | |||
const std::string & | desc, | |||
int | stypes, | |||
long | offset, | |||
long | length | |||
) | [pure virtual] |
This function is called to handle incoming file transfer requests, i.e. a remote entity requested to send a file to you. You should use either SIProfileFT::acceptFT() or SIProfileFT::declineFT() to accept or reject the request, respectively.
from | The file transfer requestor. | |
id | The request's id. This id MUST be supplied to either SIProfileFT::acceptFT() or SIProfileFT::declineFT(). | |
sid | The requested stream's ID. | |
name | The file name. | |
size | The file size. | |
hash | The file content's MD5 sum. | |
date | The file's last modification time. | |
mimetype | The file's mime-type. | |
desc | The file's description. | |
stypes | An ORed list of SIProfileFT::StreamType indicating the StreamTypes the initiator supports. | |
offset | The offset in bytes from which the file should be transmitted. | |
length | The number of bytes to send, starting from the given offset. A value of -1 indicates that the entire file is to be transmitted (taking the offset into account). |
virtual void handleFTRequestError | ( | Stanza * | stanza, | |
const std::string & | sid | |||
) | [pure virtual] |
This function is called to handle results of outgoing file transfer requests, i.e. you requested a stream (using SIProfileFT::requestFT()) to send a file to a remote entity.
from | The file transfer receiver. | |
sid | The stream ID. This function is called to handle a request error or decline. | |
stanza | The complete error stanza. | |
sid | The request's SID. |
virtual void handleFTSOCKS5Bytestream | ( | SOCKS5Bytestream * | s5b | ) | [pure virtual] |
This function is called to pass a negotiated SOCKS5 bytestream. The bytestream is not yet open and not ready to send/receive data.
s5b | The SOCKS5 bytestream. |