Overview Package Class Source Class tree Glossary
previous class      next class frames      no frames

IpDrv.OnlineTitleFileDownloadMcp

Extends
MCPBase
Modifiers
native implements ( OnlineTitleFileInterface ) dependson ( OnlineSubsystem )

Provides a mechanism for downloading arbitrary files from the MCP server 

Core.Object
|   
+-- IpDrv.MCPBase
   |   
   +-- IpDrv.OnlineTitleFileDownloadMcp
Constants Summary
Inherited Contants from Core.Object
AspectRatio16x9, AspectRatio4x3, AspectRatio5x4, DegToRad, DegToUnrRot, INDEX_NONE, InvAspectRatio16x9, InvAspectRatio4x3, InvAspectRatio5x4, MaxInt, Pi, RadToDeg, RadToUnrRot, UnrRotToDeg, UnrRotToRad

Variables Summary
stringBaseUrl
intDownloadCount
array<FileNameToURLMapping>FilesToUrls
array<delegate<OnReadTitleFileComplete>>ReadTitleFileCompleteDelegates
floatTimeOut
array<TitleFileMcp>TitleFiles
Inherited Variables from Core.Object
Class, HashNext, HashOuterNext, Linker, LinkerIndex, Name, NetIndex, ObjectArchetype, ObjectFlags, ObjectInternalInteger, Outer, StateFrame, VfTableObject

Enumerations Summary
Inherited Enumerations from Core.Object
AlphaBlendType, EAspectRatioAxisConstraint, EAutomatedRunResult, EAxis, EDebugBreakType, EInputEvent, EInterpCurveMode, EInterpMethodType, ETickingGroup

Structures Summary
FileNameToURLMapping
FileName, UrlMapping
TitleFileMcp
HttpDownloader
Inherited Structures from Core.Object
Array_Mirror, BitArray_Mirror, BoneAtom, Box, BoxSphereBounds, Color, Cylinder, double, FColorVertexBuffer_Mirror, Guid, IndirectArray_Mirror, InlinePointerArray_Mirror, InterpCurveFloat, InterpCurveLinearColor, InterpCurvePointFloat, InterpCurvePointLinearColor, InterpCurvePointQuat, InterpCurvePointTwoVectors, InterpCurvePointVector, InterpCurvePointVector2D, InterpCurveQuat, InterpCurveTwoVectors, InterpCurveVector, InterpCurveVector2D, IntPoint, LinearColor, Map_Mirror, Matrix, MultiMap_Mirror, OctreeElementId, Plane, pointer, Quat, qword, RawDistribution, RenderCommandFence, RenderCommandFence_Mirror, Rotator, Set_Mirror, SHVector, SHVectorRGB, SparseArray_Mirror, TAlphaBlend, ThreadSafeCounter, TPOV, TwoVectors, UntypedBulkData_Mirror, Vector, Vector2D, Vector4

Delegates Summary
delegate OnReadTitleFileComplete (bool bWasSuccessful, tring FileName)

Functions Summary
function AddReadTitleFileCompleteDelegate (delegate<OnReadTitleFileComplete> ReadTitleFileCompleteDelegate))
functionbool ClearDownloadedFile (string FileName)
functionbool ClearDownloadedFiles ()
function ClearReadTitleFileCompleteDelegate (delegate<OnReadTitleFileComplete> ReadTitleFileCompleteDelegate))
functionbool GetTitleFileContents (string FileName, ut array<byte> FileContents)
functionEOnlineEnumerationReadState GetTitleFileState (string FileName))
functionbool ReadTitleFile (string FileToRead)
Inherited Functions from Core.Object
!, !=, $, $=, %, &, &&, *, **, *=, +, ++, +=, -, --, -=, / , /=, <, <<, <=, ==, >, >=, >>, >>>, @, @=, Abs, Acos, Asc, Asin, Atan, Atan2, BeginState, ByteToFloat, Caps, Chr, Clamp, ClampLength, ClampRotAxis, ClampRotAxisFromBase, ClampRotAxisFromRange, ClassIsChildOf, ClockwiseFrom, ColorToLinearColor, ContinuedState, Cos, Cross, DebugBreak, Disable, Dot, DumpStateStack, DynamicLoadObject, Enable, EndState, EvalInterpCurveFloat, EvalInterpCurveVector, EvalInterpCurveVector2D, Exp, FCeil, FClamp, FCubicInterp, FFloor, FindDeltaAngle, FindObject, FInterpConstantTo, FInterpEaseIn, FInterpEaseInOut, FInterpEaseOut, FInterpTo, float, FloatToByte, FMax, FMin, FPctByRange, FRand, GetAngularDegreesFromRadians, GetAngularDistance, GetAngularFromDotDist, GetAxes, GetBuildChangelistNumber, GetDotDistance, GetEngineVersion, GetEnum, GetFuncName, GetHeadingAngle, GetMappedRangeValue, GetPackageName, GetPerObjectConfigSections, GetRangePctByValue, GetRangeValueByPct, GetRightMost, GetRotatorAxis, GetScriptTrace, GetStateName, GetSystemTime, GetUnAxes, GotoState, InCylinder, InStr, InverseTransformNormal, InverseTransformVector, IsA, IsChildState, IsInState, IsPendingKill, IsUTracing, IsZero, JoinArray, Left, Len, Lerp, LerpColor, Localize, Locs, Loge, LogInternal, MakeColor, MakeLinearColor, MakeRotationMatrix, MakeRotationTranslationMatrix, MakeRotator, MatrixGetAxis, MatrixGetOrigin, MatrixGetRotator, Max, Mid, Min, MirrorVectorByNormal, Normal, Normalize, NormalizeRotAxis, NoZDot, OrthoRotation, ParseLocalizedPropertyPath, ParseStringIntoArray, PathName, PausedState, PointDistToLine, PointDistToPlane, PointDistToSegment, PointProjectToPlane, PoppedState, PopState, ProjectOnTo, PushedState, PushState, QuatDot, QuatFindBetween, QuatFromAxisAndAngle, QuatFromRotator, QuatInvert, QuatProduct, QuatRotateVector, QuatSlerp, QuatToRotator, Rand, RDiff, Repl, Right, RInterpTo, RLerp, RotRand, Round, RSize, RSmerp, RTransform, SaveConfig, SClampRotAxis, ScriptTrace, SetUTracing, Sin, Split, SplitString, Sqrt, Square, StaticSaveConfig, Tan, TimeStamp, ToHex, TransformNormal, TransformVector, TransformVectorByRotation, UnwindHeading, vect2d, VInterpTo, VLerp, VRand, VRandCone, VRandCone2, VSize, VSize2D, VSizeSq, VSizeSq2D, VSmerp, WarnInternal, ^, ^^, |, ||, ~, ~=

Variables Detail

BaseUrl Source code

var config string BaseUrl;
The base URL to use when downloading files, such that BaseUrl?TitleID=1234&FileName=MyFile.ini is the complete URL

DownloadCount Source code

var transient int DownloadCount;
The number of files in the array being processed

FilesToUrls Source code

var config array<FileNameToURLMapping> FilesToUrls;
The routing table to look in when trying to find special URL handlers

ReadTitleFileCompleteDelegates Source code

var private array<delegate<OnReadTitleFileComplete>> ReadTitleFileCompleteDelegates;
The list of delegates to notify when a file is read

TimeOut Source code

var config float TimeOut;
The amount of time to allow for downloading of the file

TitleFiles Source code

var private array<TitleFileMcp> TitleFiles;
The list of title files that have been read or are being read

Structures Detail

FileNameToURLMapping Source code

struct FileNameToURLMapping
{
var name FileName;
var name UrlMapping;
};
Allows the game to route a specific file or sets of files to a specific URL. If there is no special mapping for a file, then the base URL is used
FileName:
The name of the file to route to a specific URL
UrlMapping:
The URL to route the request to

TitleFileMcp Source code

struct TitleFileMcp extends OnlineSubsystem.TitleFile
{
var private native const pointer HttpDownloader;
};
Struct that matches one download object per file for parallel downloading
HttpDownloader:
The class that will communicate with backend to download the file

Delegates Detail

OnReadTitleFileComplete Source code

delegate OnReadTitleFileComplete ( bool bWasSuccessful,string FileName )
Delegate fired when a file read from the network platform's title specific storage is complete
@param bWasSuccessful whether the file read was successful or not
@param FileName the name of the file this was for

Functions Detail

AddReadTitleFileCompleteDelegate Source code

function AddReadTitleFileCompleteDelegate ( delegate<OnReadTitleFileComplete> ReadTitleFileCompleteDelegate) )
Adds the delegate to the list to be notified when a requested file has been read
@param ReadTitleFileCompleteDelegate the delegate to add

ClearDownloadedFile Source code

native function bool ClearDownloadedFile ( string FileName )
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

ClearDownloadedFiles Source code

native function bool ClearDownloadedFiles ( )
Empties the set of downloaded files if possible (no async tasks outstanding)
@return true if they could be deleted, false if they could not

ClearReadTitleFileCompleteDelegate Source code

function ClearReadTitleFileCompleteDelegate ( delegate<OnReadTitleFileComplete> ReadTitleFileCompleteDelegate) )
Removes the delegate from the notify list
@param ReadTitleFileCompleteDelegate the delegate to remove

GetTitleFileContents Source code

native function bool GetTitleFileContents ( string FileName,out array<byte> FileContents )
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

GetTitleFileState Source code

function EOnlineEnumerationReadState GetTitleFileState ( string FileName) )
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

ReadTitleFile Source code

native function bool ReadTitleFile ( string FileToRead )
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

Overview Package Class Source Class tree Glossary
previous class      next class frames      no frames
Creation time: ti 22-3-2011 19:56:53.982 - Created with UnCodeX