134 lines
3.7 KiB
Ucode
134 lines
3.7 KiB
Ucode
/**
|
|
* Copyright 1998-2013 Epic Games, Inc. All Rights Reserved.
|
|
*/
|
|
|
|
/**
|
|
* Provides a mechanism for downloading arbitrary files from the MCP server
|
|
*/
|
|
class OnlineTitleFileDownloadMcp extends OnlineTitleFileDownloadBase
|
|
native;
|
|
|
|
/** Struct that matches one download object per file for parallel downloading */
|
|
struct native TitleFileMcp extends OnlineSubsystem.TitleFile
|
|
{
|
|
/** The class that will communicate with backend to download the file */
|
|
var private native const pointer HttpDownloader{class FHttpDownloadBinary};
|
|
};
|
|
|
|
/** The list of title files that have been read or are being read */
|
|
var private array<TitleFileMcp> TitleFiles;
|
|
|
|
/** The number of files in the array being processed */
|
|
var transient int DownloadCount;
|
|
|
|
/**
|
|
* Starts an asynchronous read of the specified file from the network platform's
|
|
* title specific file store
|
|
*
|
|
* @param FileToRead the name of the file to read
|
|
*
|
|
* @return true if the calls starts successfully, false otherwise
|
|
*/
|
|
native function bool ReadTitleFile(string FileToRead, optional EOnlineFileType FileType = OFT_Binary);
|
|
|
|
/**
|
|
* Copies the file data into the specified buffer for the specified file
|
|
*
|
|
* @param FileName the name of the file to read
|
|
* @param FileContents the out buffer to copy the data into
|
|
*
|
|
* @return true if the data was copied, false otherwise
|
|
*/
|
|
native function bool GetTitleFileContents(string FileName,out array<byte> FileContents);
|
|
|
|
/**
|
|
* Determines the async state of the tile file read operation
|
|
*
|
|
* @param FileName the name of the file to check on
|
|
*
|
|
* @return the async state of the file read
|
|
*/
|
|
function EOnlineEnumerationReadState GetTitleFileState(string FileName)
|
|
{
|
|
local int FileIndex;
|
|
|
|
FileIndex = TitleFiles.Find('FileName',FileName);
|
|
if (FileIndex != INDEX_NONE)
|
|
{
|
|
return TitleFiles[FileIndex].AsyncState;
|
|
}
|
|
return OERS_Failed;
|
|
}
|
|
|
|
/**
|
|
* Empties the set of downloaded files if possible (no async tasks outstanding)
|
|
*
|
|
* @return true if they could be deleted, false if they could not
|
|
*/
|
|
native function bool ClearDownloadedFiles();
|
|
|
|
/**
|
|
* Empties the cached data for this file if it is not being downloaded currently
|
|
*
|
|
* @param FileName the name of the file to remove from the cache
|
|
*
|
|
* @return true if it could be deleted, false if it could not
|
|
*/
|
|
native function bool ClearDownloadedFile(string FileName);
|
|
|
|
cpptext
|
|
{
|
|
// FTickableObject interface
|
|
/**
|
|
* Ticks any outstanding async tasks that need processing
|
|
*
|
|
* @param DeltaTime the amount of time that has passed since the last tick
|
|
*/
|
|
virtual void Tick(FLOAT DeltaTime);
|
|
|
|
// Helpers
|
|
|
|
/**
|
|
* Searches the list of files for the one that matches the filename
|
|
*
|
|
* @param FileName the file to search for
|
|
*
|
|
* @return the file details
|
|
*/
|
|
FORCEINLINE FTitleFileMcp* GetTitleFile(const FString& FileName)
|
|
{
|
|
// Search for the specified file
|
|
for (INT Index = 0; Index < TitleFiles.Num(); Index++)
|
|
{
|
|
FTitleFileMcp* TitleFile = &TitleFiles(Index);
|
|
if (TitleFile &&
|
|
TitleFile->Filename == FileName)
|
|
{
|
|
return TitleFile;
|
|
}
|
|
}
|
|
return NULL;
|
|
}
|
|
|
|
/**
|
|
* Fires the delegates so the caller knows the file download is complete
|
|
*
|
|
* @param TitleFile the information for the file that was downloaded
|
|
*/
|
|
void TriggerDelegates(const FTitleFile* TitleFile);
|
|
|
|
/**
|
|
* Builds the URL to use when fetching the specified file
|
|
*
|
|
* @param FileName the file that is being requested
|
|
*
|
|
* @return the URL to use with all of the per platform extras
|
|
*/
|
|
virtual FString BuildURLParameters(const FString& FileName)
|
|
{
|
|
return FString::Printf(TEXT("TitleID=%d&PlatformID=%d&Filename=%s"),
|
|
appGetTitleId(),
|
|
(DWORD)appGetPlatformType(),
|
|
*FileName);
|
|
}
|
|
} |