ChunkSource.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
#pragma once
 
#include "Templates/Function.h"
#include "Containers/Set.h"
#include "Delegates/Delegate.h"
#include "Memory/MemoryFwd.h"
#include "Misc/Guid.h"
 
namespace BuildPatchServices
{
    class IChunkDataAccess;
 
    // This class is for providing chunks to a threaded file constructor that manages its own backing store.
    class IConstructorChunkSource
    {
    public:
        virtual ~IConstructorChunkSource() {}
 
        DECLARE_DELEGATE_FourParams(FChunkRequestCompleteDelegate, const FGuid& DataId, bool bAborted, bool bFailedToRead, void* UserPtr);
 
        typedef TUniqueFunction<void(bool bIsAborted)> FRequestProcessFn;
 
        virtual FRequestProcessFn CreateRequest(const FGuid& DataId, FMutableMemoryView DestinationBuffer, void* UserPtr, FChunkRequestCompleteDelegate CompleteFn) = 0;
 
        // Return the reference index at which we can no longer get this data id from this source.
        virtual int32 GetChunkUnavailableAt(const FGuid& DataId) const = 0;
    };
 
    class IChunkSource
    {
    public:
        virtual ~IChunkSource() {}
 
        virtual IChunkDataAccess* Get(const FGuid& DataId) = 0;
 
        virtual TSet<FGuid> AddRuntimeRequirements(TSet<FGuid> NewRequirements) = 0;
 
        virtual bool AddRepeatRequirement(const FGuid& RepeatRequirement) = 0;
 
        virtual void SetUnavailableChunksCallback(TFunction<void(TSet<FGuid>)> Callback) = 0;
    };
}