Main Page | Namespace List | Class Hierarchy | Class List | File List | Namespace Members | Class Members | File Members | Related Pages

MSN::FileTransferInvitation Class Reference

#include <filetransfer.h>

Inheritance diagram for MSN::FileTransferInvitation:

MSN::Invitation List of all members.

Detailed Description

Contains information about the invitation that was sent or received when a file transfer was initiated.


Public Member Functions

 FileTransferInvitation (Invitation::ApplicationType application_, std::string cookie_, Passport otherUser_, SwitchboardServerConnection *switchboardConnection_, std::string fileName_, long unsigned fileSize_, void *userData_=NULL)
 Create a new FileTransferInvitation.
virtual void invitationWasAccepted (const std::string &body)
 The remote side accepted our file transfer.
virtual void invitationWasCanceled (const std::string &body)
 The remote side canceled our file transfer.
void acceptTransfer (const std::string &destinationFile)
 The user wishes to accept the file transfer, and have the file written to destinationFile.
void rejectTransfer ()
 The user wishes to decline the file transfer.
void cancelTransfer ()
 The user wishes to cancel the file transfer.

Public Attributes

std::string fileName
 The name of the file that is being transferred.
long unsigned fileSize
 The size in bytes of the file that is being transferred.
void * userData
 A pointer to user-specified data that can be used to identify this transfer.


Constructor & Destructor Documentation

MSN::FileTransferInvitation::FileTransferInvitation Invitation::ApplicationType  application_,
std::string  cookie_,
Passport  otherUser_,
SwitchboardServerConnection switchboardConnection_,
std::string  fileName_,
long unsigned  fileSize_,
void *  userData_ = NULL
[inline]
 

Create a new FileTransferInvitation.

Todo:
Do all of these parameters really need to be in the constructor?


Member Function Documentation

void MSN::FileTransferInvitation::acceptTransfer const std::string &  destinationFile  ) 
 

The user wishes to accept the file transfer, and have the file written to destinationFile.

Todo:
Should the received data be passed back to the user to store in the file? This would remove some of the complexity in the file transfer code.

void MSN::FileTransferInvitation::cancelTransfer  ) 
 

The user wishes to cancel the file transfer.

void MSN::FileTransferInvitation::invitationWasAccepted const std::string &  body  )  [virtual]
 

The remote side accepted our file transfer.

Notify calling code.

Implements MSN::Invitation.

void MSN::FileTransferInvitation::invitationWasCanceled const std::string &  body  )  [virtual]
 

The remote side canceled our file transfer.

Notify calling code.

Implements MSN::Invitation.

void MSN::FileTransferInvitation::rejectTransfer  ) 
 

The user wishes to decline the file transfer.


Member Data Documentation

std::string MSN::FileTransferInvitation::fileName
 

The name of the file that is being transferred.

long unsigned MSN::FileTransferInvitation::fileSize
 

The size in bytes of the file that is being transferred.

void* MSN::FileTransferInvitation::userData
 

A pointer to user-specified data that can be used to identify this transfer.


The documentation for this class was generated from the following files:
Generated on Sun Feb 6 19:59:40 2005 for libmsn by  doxygen 1.4.1