FileListTransferCBInterface.h

Go to the documentation of this file.

#ifndef __FILE_LIST_TRANSFER_CALLBACK_INTERFACE_H
#define __FILE_LIST_TRANSFER_CALLBACK_INTERFACE_H

#include "RakMemoryOverride.h"
#include "FileListNodeContext.h"

#ifdef _MSC_VER
#pragma warning( push )
#endif

namespace RakNet
{

class FileListTransferCBInterface
{
public:
    // Note: If this structure is changed the struct in the swig files need to be changed as well
    struct OnFileStruct
    {
        unsigned fileIndex;

        char fileName[512];

        char *fileData;

        BitSize_t byteLengthOfThisFile;

        BitSize_t bytesDownloadedForThisFile;

        unsigned short setID;

        unsigned numberOfFilesInThisSet;

        unsigned byteLengthOfThisSet;

        unsigned bytesDownloadedForThisSet;

        FileListNodeContext context;

        SystemAddress senderSystemAddress;

        RakNetGUID senderGuid;
    };

    // Note: If this structure is changed the struct in the swig files need to be changed as well
    struct FileProgressStruct
    {
        OnFileStruct *onFileStruct;
        unsigned int partCount;
        unsigned int partTotal;
        unsigned int dataChunkLength;
        char *firstDataChunk;
        char *iriDataChunk;
        unsigned int iriWriteOffset;
        SystemAddress senderSystemAddress;
        RakNetGUID senderGuid;
        bool allocateIrIDataChunkAutomatically;
    };

    struct DownloadCompleteStruct
    {
        unsigned short setID;

        unsigned numberOfFilesInThisSet;

        unsigned byteLengthOfThisSet;

        SystemAddress senderSystemAddress;

        RakNetGUID senderGuid;
    };

    FileListTransferCBInterface() {}
    virtual ~FileListTransferCBInterface() {}

    virtual bool OnFile(OnFileStruct *onFileStruct)=0;

    virtual void OnFileProgress(FileProgressStruct *fps)=0;

    virtual bool Update(void) {return true;}

    virtual bool OnDownloadComplete(DownloadCompleteStruct *dcs) {(void) dcs; return false;}

    virtual void OnDereference(void) {}
};

} // namespace RakNet

#ifdef _MSC_VER
#pragma warning( pop )
#endif

#endif