BuildPatchServices::IDirectoryBuildStreamer Class Reference

#include <BuildStreamer.h>

Inheritance diagram for BuildPatchServices::IDirectoryBuildStreamer:

Public Member Functions
virtual bool	GetFileSpan (uint64 StartingIdx, FFileSpan &FileSpan) const =0
virtual TArray< FString >	GetEmptyFiles () const =0
virtual TArray< FString >	GetAllFilenames () const =0
virtual uint64	GetBuildSize () const =0
virtual TArray< FFileSpan >	GetAllFiles () const =0
virtual bool	HasAborted () const =0
Public Member Functions inherited from BuildPatchServices::IBuildStreamer
virtual	~IBuildStreamer ()
virtual uint32	DequeueData (uint8 *Buffer, uint32 ReqSize, bool WaitForData=true)=0
virtual bool	IsEndOfData () const =0

Member Function Documentation

GetAllFilenames()

virtual TArray< FString > BuildPatchServices::IDirectoryBuildStreamer::GetAllFilenames ( ) const

pure virtual

Gets a list of all filenames that the build contains. Will block until the list of files is enumerated and ignored files have been stripped out.

Returns

array of filenames in the build.

Implemented in BuildPatchServices::FDirectoryBuildStreamer.

GetAllFiles()

virtual TArray< FFileSpan > BuildPatchServices::IDirectoryBuildStreamer::GetAllFiles ( ) const

pure virtual

Get the list of file spans for each file in the build, including empty files. MUST be called only after IsEndOfData returns true.

Returns

the list of files in the build and their details.

Implemented in BuildPatchServices::FDirectoryBuildStreamer.

GetBuildSize()

virtual uint64 BuildPatchServices::IDirectoryBuildStreamer::GetBuildSize ( ) const

pure virtual

Get the total build size that was streamed. MUST be called only after IsEndOfData returns true.

Returns

the number of bytes in the streamed build.

Implemented in BuildPatchServices::FDirectoryBuildStreamer.

GetEmptyFiles()

virtual TArray< FString > BuildPatchServices::IDirectoryBuildStreamer::GetEmptyFiles ( ) const

pure virtual

Gets a list of empty files that the build contains.

Returns

array of empty files in the build.

Implemented in BuildPatchServices::FDirectoryBuildStreamer.

GetFileSpan()

virtual bool BuildPatchServices::IDirectoryBuildStreamer::GetFileSpan ( uint64  StartingIdx, FFileSpan &  FileSpan  ) const

pure virtual

Retrieves the file details for a specific start index.

Parameters

IN	StartingIdx The data index into the build image.
OUT	FileSpan Receives a copy of the file span data.

Returns

true if the data byte at StartingIdx is the start of a file, false indicates that FileSpan was not set.

Implemented in BuildPatchServices::FDirectoryBuildStreamer.

HasAborted()

virtual bool BuildPatchServices::IDirectoryBuildStreamer::HasAborted ( ) const

pure virtual

Gets if the streamer has aborted and is no longer streaming data

Returns

True if it has aborted

Implemented in BuildPatchServices::FDirectoryBuildStreamer.

---

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

• Engine/Source/Runtime/Online/BuildPatchServices/Private/Generation/BuildStreamer.h