BuildPatchServices::FDirectoryBuildStreamer Class Reference

Inheritance diagram for BuildPatchServices::FDirectoryBuildStreamer:

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

Constructor & Destructor Documentation

FDirectoryBuildStreamer()

BuildPatchServices::FDirectoryBuildStreamer::FDirectoryBuildStreamer	(	FDirectoryBuildStreamerConfig	Config,
		FDirectoryBuildStreamerDependencies	Dependencies
	)

~FDirectoryBuildStreamer()

BuildPatchServices::FDirectoryBuildStreamer::~FDirectoryBuildStreamer ( )

virtual

Member Function Documentation

DequeueData()

uint32 BuildPatchServices::FDirectoryBuildStreamer::DequeueData ( uint8 *  Buffer, uint32  ReqSize, bool  WaitForData = true  )

overridevirtual

Fetches some data from the buffer, also removing it.

Parameters

IN	Buffer Pointer to buffer to receive the data.
IN	ReqSize The amount of data to attempt to retrieve.
IN	WaitForData Optional: Default true. Whether to wait until there is enough data in the buffer.

Returns

the amount of data retrieved.

Implements BuildPatchServices::IBuildStreamer.

GetAllFilenames()

TArray< FString > BuildPatchServices::FDirectoryBuildStreamer::GetAllFilenames ( ) const

overridevirtual

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.

Implements BuildPatchServices::IDirectoryBuildStreamer.

GetAllFiles()

TArray< FFileSpan > BuildPatchServices::FDirectoryBuildStreamer::GetAllFiles ( ) const

overridevirtual

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.

Implements BuildPatchServices::IDirectoryBuildStreamer.

GetBuildSize()

uint64 BuildPatchServices::FDirectoryBuildStreamer::GetBuildSize ( ) const

overridevirtual

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.

Implements BuildPatchServices::IDirectoryBuildStreamer.

GetEmptyFiles()

TArray< FString > BuildPatchServices::FDirectoryBuildStreamer::GetEmptyFiles ( ) const

overridevirtual

Gets a list of empty files that the build contains.

Returns

array of empty files in the build.

Implements BuildPatchServices::IDirectoryBuildStreamer.

GetFileSpan()

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

overridevirtual

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.

Implements BuildPatchServices::IDirectoryBuildStreamer.

HasAborted()

bool BuildPatchServices::FDirectoryBuildStreamer::HasAborted ( ) const

overridevirtual

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

Returns

True if it has aborted

Implements BuildPatchServices::IDirectoryBuildStreamer.

IsEndOfData()

bool BuildPatchServices::FDirectoryBuildStreamer::IsEndOfData ( ) const

overridevirtual

Whether there is any more data available to dequeue from the buffer.

Returns

true if there is no more data coming in, and the internal buffer is also empty.

Implements BuildPatchServices::IBuildStreamer.

---

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

• Engine/Source/Runtime/Online/BuildPatchServices/Private/Generation/DirectoryBuildStreamer.cpp