RakNet  4.0
Public Member Functions | List of all members
RakNet::FileListProgress Class Reference

Callback interface set with FileList::SetCallback() in case you want progress notifications when FileList::AddFilesFromDirectory() is called. More...

#include <FileList.h>

Inheritance diagram for RakNet::FileListProgress:
RakNet::AutopatcherServer RakNet::FLP_Printf

Public Member Functions

virtual void OnAddFilesFromDirectoryStarted (FileList *fileList, char *dir)
 First callback called when FileList::AddFilesFromDirectory() starts.
 
virtual void OnDirectory (FileList *fileList, char *dir, unsigned int directoriesRemaining)
 Called for each directory, when that directory begins processing.
 
virtual void OnFile (FileList *fileList, char *dir, char *fileName, unsigned int fileSize)
 Called for each file, when that file begins processing.
 
virtual void OnFilePush (const char *fileName, unsigned int fileLengthBytes, unsigned int offset, unsigned int bytesBeingSent, bool done, SystemAddress targetSystem, unsigned short setId)
 This function is called when we are sending a file to a remote system.
 
virtual void OnFilePushesComplete (SystemAddress systemAddress, unsigned short setId)
 This function is called when all files have been read and are being transferred to a remote system.
 
virtual void OnSendAborted (SystemAddress systemAddress)
 This function is called when a send to a system was aborted (probably due to disconnection)
 

Detailed Description

Callback interface set with FileList::SetCallback() in case you want progress notifications when FileList::AddFilesFromDirectory() is called.

Member Function Documentation

virtual void RakNet::FileListProgress::OnFilePush ( const char *  fileName,
unsigned int  fileLengthBytes,
unsigned int  offset,
unsigned int  bytesBeingSent,
bool  done,
SystemAddress  targetSystem,
unsigned short  setId 
)
inlinevirtual

This function is called when we are sending a file to a remote system.

Parameters
[in]fileNameThe name of the file being sent
[in]fileLengthBytesHow long the file is
[in]offsetThe offset in bytes into the file that we are sending
[in]bytesBeingSentHow many bytes we are sending this push
[in]doneIf this file is now done with this push
[in]targetSystemWho we are sending to

The documentation for this class was generated from the following file: