IoStoreOnDemandCore

API > API/Runtime

   
Name IoStoreOnDemandCore
Type Runtime
Location /Engine/Source/Runtime/Experimental/IoStore/OnDemandCore/
Module Build Rules IoStoreOnDemandCore.Build.cs

Classes

Name Remarks
FHttpIoDispatcher HTTP I/O dispatcher .
FIoHttpBatch Issue one or more HTTP request in a batch.
FIoHttpHeaders HTTP headers.
FIoHttpMetadata Non shipping metadata about an HTTP request.
FIoHttpRequest An HTTP request handle.
FIoHttpResponse A HTTP response.
FIoRelativeUrl A relative URL from the host.
FOnDemandContentHandle Keeps referenced data pinned in the cache until released.
FOnDemandHostGroup Holds a set of host URLs.
FOnDemandHttpStats Container for http stats
FOnDemandInstallRequest A single-ownership handle to an install request.
FOnDemandRequest Interface for on-demand request types.

Structs

Name Remarks
EOnDemandInstallCasTypeNS Specifies a particular CAS Type when relevant
FCasError Payload struct
FCasJournalError Payload struct
FCasSnapshotError Payload struct
FChunkHashError Payload struct
FChunkMissingError Payload struct
FContextDeclaration_InstallCacheErrorContext  
FDownloadRequired Payload struct
FErrorDeclaration_CasError Factory object/comparison object for error
FErrorDeclaration_CasJournalError Factory object/comparison object for error
FErrorDeclaration_CasSnapshotError Factory object/comparison object for error
FErrorDeclaration_ChunkHashError Factory object/comparison object for error
FErrorDeclaration_ChunkMissingError Factory object/comparison object for error
FErrorDeclaration_DownloadRequired Factory object/comparison object for error
FErrorDeclaration_HttpError Factory object/comparison object for error
FErrorDeclaration_InstallCacheDefragError Factory object/comparison object for error
FErrorDeclaration_InstallCacheDefragHashMismatchError Factory object/comparison object for error
FErrorDeclaration_InstallCacheFlushError Factory object/comparison object for error
FErrorDeclaration_InstallCacheFlushLastAccessError Factory object/comparison object for error
FErrorDeclaration_InstallCachePurgeError Factory object/comparison object for error
FErrorDeclaration_InstallCacheVerificationError Factory object/comparison object for error
FErrorDeclaration_InstallerCacheFullError Factory object/comparison object for error
FErrorDeclaration_InstallReplayLoadError Factory object/comparison object for error
FErrorDeclaration_InstallReplaySaveError Factory object/comparison object for error
FHttpError Payload struct
FInstallCacheDefragError Payload struct
FInstallCacheDefragHashMismatchError Payload struct
FInstallCacheErrorContext  
FInstallCacheErrorState Cache-state snapshot taken at the moment an install-cache error is produced.
FInstallCacheFlushError Payload struct
FInstallCacheFlushLastAccessError Payload struct
FInstallCachePurgeError Payload struct
FInstallCacheVerificationError Payload struct
FInstallerCacheFullError Payload struct
FInstallReplayLoadError Payload struct
FInstallReplaySaveError Payload struct
FIoHttpOptions Options for controlling the behavior of an HTTP request.
FIoHttpRange Represents a range within a resource.
FOnDemandCacheUsage Holds information about install and streaming cache usage
FOnDemandDefragArgs Arguments for defragmenting on-demand content.
FOnDemandDefragResult Holds information about a defrag request
FOnDemandGetCacheUsageArgs Arguments for getting the install cache usage.
FOnDemandGetInstallSizeArgs Arguments for getting the size of on-demand content.
FOnDemandImmediateAnalytic  
FOnDemandImmediateAnalyticHandler  
FOnDemandInstallArgs Arguments for installing/downloading on-demand content.
FOnDemandInstallCacheUsage Holds information about the install cache usage
FOnDemandInstallHandleCacheUsage  
FOnDemandInstallProgress Holds information about progress for an install request.
FOnDemandInstallResult Holds information about an install request.
FOnDemandInstallSizeResult Holds information about an install size request.
FOnDemandIsOnDemandArgs Arguments for checking if any on-demand content exists in the dependency graph.
FOnDemandIsOnDemandResult Results for GetIsOnDemand
FOnDemandMountArgs Arguments for mounting on-demand container TOC(s).
FOnDemandMountResult Holds information about a mount request.
FOnDemandPurgeArgs Arguments for purging on-demand content.
FOnDemandPurgeResult Holds information about a purge request
FOnDemandRegisterHostGroupArgs Arguments for registering a new host group.
FOnDemandRegisterHostGroupResult Holds the result when registering a host group.
FOnDemandStreamingCacheUsage Holds information about the streaming cache usage
FOnDemandToc  
FOnDemandTocAdditionalFile  
FOnDemandTocContainerEntry  
FOnDemandTocEntry  
FOnDemandTocHeader  
FOnDemandTocSentinel  
FOnDemandTocTagSet  
FOnDemandTocTagSetPackageList  
FOnDemandVerifyCacheResult Result from verifying the install cache.
FTocMeta  

Interfaces

Name Remarks
IAnalyticsRecording Interface for recording analytics over a given time period
IHttpIoDispatcher HTTP I/O dispatcher interface.
IIoHttpRequestHandle A reference counted HTTP I/O dispatcher request handle.
IOnDemandDevelopmentExtension An interface for exceptional scenarios.
IOnDemandIoStore Interface for installing and streaming content on-demand.
IOnDemandIoStoreFactory Module feature for creating a concrete implementation of the on-demand I/O store.

Enums

Public

Name Remarks
UE::IoStore::OnDemand::ECasErrorCode Previously recorded by pushing an FChunkHashMismatchErrorContext onto an InstallCacheDefragError.

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
CasError FErrorDeclaration_CasError Singleton instance of factory object IO/OnDemandError.h  
CasJournalError FErrorDeclaration_CasJournalError Singleton instance of factory object IO/OnDemandError.h  
CasSnapshotError FErrorDeclaration_CasSnapshotError Singleton instance of factory object IO/OnDemandError.h  
ChunkHashError FErrorDeclaration_ChunkHashError Singleton instance of factory object IO/OnDemandError.h  
ChunkMissingError FErrorDeclaration_ChunkMissingError Singleton instance of factory object IO/OnDemandError.h  
DownloadRequired FErrorDeclaration_DownloadRequired Singleton instance of factory object IO/OnDemandError.h  
HttpError FErrorDeclaration_HttpError Singleton instance of factory object IO/OnDemandError.h  
InstallCacheDefragError FErrorDeclaration_InstallCacheDefragError Singleton instance of factory object IO/OnDemandError.h  
InstallCacheDefragHashMismatchError FErrorDeclaration_InstallCacheDefragHashMismatchError Singleton instance of factory object IO/OnDemandError.h  
InstallCacheFlushError FErrorDeclaration_InstallCacheFlushError Singleton instance of factory object IO/OnDemandError.h  
InstallCacheFlushLastAccessError FErrorDeclaration_InstallCacheFlushLastAccessError Singleton instance of factory object IO/OnDemandError.h  
InstallCachePurgeError FErrorDeclaration_InstallCachePurgeError Singleton instance of factory object IO/OnDemandError.h  
InstallCacheVerificationError FErrorDeclaration_InstallCacheVerificationError Singleton instance of factory object IO/OnDemandError.h  
InstallerCacheFullError FErrorDeclaration_InstallerCacheFullError Singleton instance of factory object IO/OnDemandError.h  
InstallReplayLoadError FErrorDeclaration_InstallReplayLoadError Singleton instance of factory object IO/OnDemandError.h  
InstallReplaySaveError FErrorDeclaration_InstallReplaySaveError Singleton instance of factory object IO/OnDemandError.h  
StaticModuleName FUtf8StringView   IO/OnDemandError.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void LexFromString ( UE::IoStore::EOnDemandInstallCasType& CacheType,
FStringView String
)

   IO/IoStoreOnDemand.h  
  IO/IoStoreOnDemand.h  

FString LexToString ( UE::IoStore::EOnDemandTocFlags TocFlags
)

   IO/OnDemandToc.h  

void SerializeForError ( FCbWriter& Writer,
const UE::IoStore::OnDemand::FInstallCacheErrorContext& Context
)

   IO/OnDemandError.h  

void SerializeForLog ( FCbWriter& Writer,
const FIoChunkId& ChunkId
)

   IO/OnDemandError.h  

void SerializeForLog ( FCbWriter& Writer,
EIoErrorCode ErrorCode
)

   IO/OnDemandError.h  

void SerializeForLog ( FCbWriter& Writer,
const FFileSystemError& Error
)

   IO/OnDemandError.h  

UE::IoStore::TResult< ResultType > UE::IoStore::OnDemand::MakeCasError ( UE::IoStore::EOnDemandInstallCasType CasType,
ECasErrorCode ErrorCode,
EIoErrorCode IoErrorCode,
FString&& ErrorMessage,
FFileSystemError&& FileSystemError,
uint32 SystemErrorCode
)

   IO/OnDemandError.h  

UE::IoStore::FResult UE::IoStore::OnDemand::MakeJournalError ( ECasErrorCode ErrorCode,
EIoErrorCode IoErrorCode,
FString&& ErrorMessage,
FFileSystemError&& FileSystemError,
uint32 SystemErrorCode
)

   IO/OnDemandError.h  

UE::IoStore::TResult< ResultType > UE::IoStore::OnDemand::MakeSnapshotError ( ECasErrorCode ErrorCode,
EIoErrorCode IoErrorCode,
FString&& ErrorMessage,
uint32 SystemErrorCode
)

   IO/OnDemandError.h  

UE::IoStore::TResult< ResultType > UE::IoStore::OnDemand::MakeSnapshotError ( ECasErrorCode ErrorCode,
EIoErrorCode IoErrorCode,
FString&& ErrorMessage,
FFileSystemError&& FileSystemError,
uint32 SystemErrorCode
)

   IO/OnDemandError.h  
  IO/OnDemandError.h  
  IO/OnDemandError.h  
  IO/OnDemandError.h  
  IO/OnDemandError.h  
  IO/OnDemandError.h  
  IO/OnDemandError.h  
  IO/OnDemandError.h  
  IO/OnDemandError.h  
  IO/OnDemandError.h  
  IO/OnDemandError.h  
  IO/OnDemandError.h  
  IO/OnDemandError.h  
  IO/OnDemandError.h  
  IO/OnDemandError.h  
  IO/OnDemandError.h  
  IO/OnDemandError.h  

void UE::IoStore::OnDemand::SerializeForLog ( FCbWriter& Writer,
ECasErrorCode Code
)

   IO/OnDemandError.h  

const TCHAR * UE::IoStore::OnDemand::ToString ( ECasErrorCode Code
)

   IO/OnDemandError.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page