#include <FileListTransferCBInterface.h>

Public Attributes
bool	allocateIrIDataChunkAutomatically
unsigned int	dataChunkLength
char *	firstDataChunk
char *	iriDataChunk
unsigned int	iriWriteOffset
OnFileStruct *	onFileStruct
unsigned int	partCount
unsigned int	partTotal
RakNetGUID	senderGuid
SystemAddress	senderSystemAddress

Detailed Description

Definition at line 69 of file FileListTransferCBInterface.h.

Member Data Documentation

bool RakNet::FileListTransferCBInterface::FileProgressStruct::allocateIrIDataChunkAutomatically

Parameters:

[in] allocateIrIDataChunkAutomatically If true, then RakNet will hold iriDataChunk for you and return it in OnFile. Defaults to true

Definition at line 90 of file FileListTransferCBInterface.h.

unsigned int RakNet::FileListTransferCBInterface::FileProgressStruct::dataChunkLength

Parameters:

[out] dataChunkLength How many bytes long firstDataChunk and iriDataChunk are

Definition at line 78 of file FileListTransferCBInterface.h.

char* RakNet::FileListTransferCBInterface::FileProgressStruct::firstDataChunk

Parameters:

[out] firstDataChunk The first partLength of the final file. If you store identifying information about the file in the first partLength bytes, you can read them while the download is taking place. If this hasn't arrived yet, firstDataChunk will be 0

Definition at line 80 of file FileListTransferCBInterface.h.

char* RakNet::FileListTransferCBInterface::FileProgressStruct::iriDataChunk

Parameters:

[out] iriDataChunk If the remote system is sending this file using IncrementalReadInterface, then this is the chunk we just downloaded. It will not exist in memory after this callback. You should either store this to disk, or in memory. If it is 0, then the file is smaller than one chunk, and will be held in memory automatically

Definition at line 82 of file FileListTransferCBInterface.h.

unsigned int RakNet::FileListTransferCBInterface::FileProgressStruct::iriWriteOffset

Parameters:

[out] iriWriteOffset Offset in bytes from the start of the file for the data pointed to by iriDataChunk

Definition at line 84 of file FileListTransferCBInterface.h.

OnFileStruct* RakNet::FileListTransferCBInterface::FileProgressStruct::onFileStruct

Parameters:

[out] onFileStruct General information about this file, such as the filename and the first partLength bytes. You do NOT need to save this data yourself. The complete file will arrive normally.

Definition at line 72 of file FileListTransferCBInterface.h.

unsigned int RakNet::FileListTransferCBInterface::FileProgressStruct::partCount

Parameters:

[out] partCount The zero based index into partTotal. The percentage complete done of this file is 100 * (partCount+1)/partTotal

Definition at line 74 of file FileListTransferCBInterface.h.

unsigned int RakNet::FileListTransferCBInterface::FileProgressStruct::partTotal

Parameters:

[out] partTotal The total number of parts this file was split into. Each part will be roughly the MTU size, minus the UDP header and RakNet headers

Definition at line 76 of file FileListTransferCBInterface.h.

RakNetGUID RakNet::FileListTransferCBInterface::FileProgressStruct::senderGuid

Parameters:

[out] Who sent this file. Not valid when using TCP, only RakPeer (UDP)