Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | Related Pages
gloox::SIProfileFTHandler

SIProfileFTHandler Class Reference

An abstract base class to handle file transfer (FT) requests. More...

#include <siprofilefthandler.h>

List of all members.

Public Member Functions

virtual ~SIProfileFTHandler ()
virtual void handleFTRequest (const JID &from, 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 (const IQ &iq, const std::string &sid)=0
virtual void handleFTBytestream (Bytestream *bs)=0
virtual const std::string handleOOBRequestResult (const JID &from, const std::string &sid)=0

Detailed Description

An abstract base class to handle file transfer (FT) requests.

See SIProfileFT for more information regarding file transfer.

Author:
Jakob Schroeter <js@camaya.net>
Since:
0.9

Definition at line 36 of file siprofilefthandler.h.

Constructor & Destructor Documentation

virtual ~SIProfileFTHandler (   )  [inline, virtual]
 

Virtual destructor.

Definition at line 43 of file siprofilefthandler.h.

Member Function Documentation

virtual void handleFTBytestream (  Bytestream *  bs  )  [pure virtual]
 

This function is called to pass a negotiated bytestream (SOCKS5 or IBB). The bytestream is not yet open and not ready to send/receive data.

Note:
To initialize the bytestream and to prepare it for data transfer do the following, preferable in that order:
  • register a SOCKS5BytestreamDataHandler with the SOCKS5Bytestream,
  • set up a separate thread for the bytestream or integrate it into your main loop,
  • call its connect() method and check the return value. To not block your application while the data transfer and/or the connection attempts last, you most likely want to put the bytestream into its own thread or process (before calling connect() on it). It is safe to do so without additional synchronization.
Parameters:
bs The bytestream.

virtual void handleFTRequest (  const JID &  from,
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.

Parameters:
from The file transfer requestor.
sid The requested stream's ID. This sid MUST be supplied to SIProfileFT::acceptFT() and SIProfileFT::declineFT(), respectively.
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 (  const IQ &  iq,
const std::string &  sid
)  [pure virtual]
 

This function is called to handle a request error or decline.

Parameters:
stanza The complete error stanza.
sid The request's SID.

virtual const std::string handleOOBRequestResult (  const JID &  from,
const std::string &  sid
)  [pure virtual]
 

This function is called if the contact chose OOB as the mechanism.

Parameters:
from The conatct's JID.
sid The stream's ID.
Returns:
The file's URL.

The documentation for this class was generated from the following file:
Generated on Tue Apr 22 15:10:15 2008 for gloox by  doxygen 1.4.1