UnrealEngineUWP/Engine/Source/Runtime/RuntimeAssetCache/Public/RuntimeAssetCachePluginInterface.h

// Copyright 1998-2015 Epic Games, Inc. All Rights Reserved.

#pragma once
#include "RuntimeAssetCachePluginInterface.generated.h"

UINTERFACE()
class URuntimeAssetCacheBuilder : public UInterface
{
	GENERATED_BODY()
};

/**
* Interface for runtime asset cache cache builders.
* This API will be called concurrently.
**/
class RUNTIMEASSETCACHE_API IRuntimeAssetCacheBuilder
{
	GENERATED_BODY()

public:

	/**
	* Get the builder type name. This is used to categorize cached data to buckets.
	* @return Type name of builder.
	*/
	virtual const TCHAR* GetTypeName() const = 0;

	/**
	* Get the name of cache builder, this is used as part of the cache key.
	* @return Name of cache builder
	*/
	virtual const TCHAR* GetBuilderName() const = 0;

	/**
	* Returns the name uniquely describing the asset.
	* @return Asset unique name.
	*/
	virtual FString GetAssetUniqueName() const = 0;

	/**
	* Does the work of creating serialized cache entry.
	* @return Pointer to contiguous memory block with serialized cache entry on success, nullptr otherwise.
	*/
	virtual void* Build() = 0;

	/**
	 * Get size in bytes of serialized cache entry.
	 * @return Cache entry size.
	 */
	virtual int64 GetSerializedDataSize() = 0;

	/**
	* Serializes data into archive
	* @param Ar Archive to serialize to.
	* @param InData Data to serialize.
	*/
	virtual void SerializeData(FArchive& Ar, void* InData)
	{
		Ar.Serialize(InData, GetSerializedDataSize());
	}

	/**
	* Gets asset version to rebuild cache if cached asset is too old.
	* @return Asset version.
	*/
	virtual int32 GetAssetVersion() = 0;
};