IoDispatcher.h File Reference

#include "Async/Future.h"
#include "Async/TaskGraphInterfaces.h"
#include "Containers/Array.h"
#include "Containers/ArrayView.h"
#include "Containers/Map.h"
#include "Containers/StringFwd.h"
#include "Containers/StringView.h"
#include "Containers/UnrealString.h"
#include "CoreTypes.h"
#include "Delegates/Delegate.h"
#include "GenericPlatform/GenericPlatformFile.h"
#include "HAL/CriticalSection.h"
#include "HAL/PlatformAtomics.h"
#include "HAL/PlatformFile.h"
#include "HAL/UnrealMemory.h"
#include "IO/IoBuffer.h"
#include "IO/IoChunkId.h"
#include "IO/IoContainerId.h"
#include "IO/IoDispatcherPriority.h"
#include "IO/IoHash.h"
#include "IO/IoStatus.h"
#include "Logging/LogMacros.h"
#include "Math/NumericLimits.h"
#include "Memory/MemoryFwd.h"
#include "Memory/MemoryView.h"
#include "Misc/AES.h"
#include "Misc/AssertionMacros.h"
#include "Misc/Build.h"
#include "Misc/ByteSwap.h"
#include "Misc/EnumClassFlags.h"
#include "Misc/Guid.h"
#include "Misc/IEngineCrypto.h"
#include "Misc/SecureHash.h"
#include "Serialization/Archive.h"
#include "Serialization/FileRegions.h"
#include "String/BytesToHex.h"
#include "Tasks/Task.h"
#include "Templates/Function.h"
#include "Templates/RefCounting.h"
#include "Templates/SharedPointer.h"
#include "Templates/TypeCompatibleBytes.h"
#include "Templates/UniquePtr.h"
#include "Templates/UnrealTemplate.h"
#include "UObject/NameTypes.h"
#include "UObject/UnrealNames.h"

Go to the source code of this file.

Classes
class	FIoStoreEnvironment
class	FIoChunkHash
class	FIoReadOptions
class	FIoRequest
class	FIoBatch
struct	FIoMappedRegion
struct	FIoDispatcherMountedContainer
struct	FIoSignatureError
struct	FIoSignatureErrorEvent
class	FIoDispatcher
class	FIoDirectoryIndexHandle
class	FIoDirectoryIndexReader
struct	FIoContainerSettings
struct	FIoStoreTocChunkInfo
struct	FIoStoreTocCompressedBlockInfo
struct	FIoStoreCompressedBlockInfo
struct	FIoStoreCompressedReadResult
class	FIoStoreReader

Typedefs
using	FIoReadCallback = TFunction< void(TIoStatusOr< FIoBuffer >)>
using	FDirectoryIndexVisitorFunction = TFunctionRef< bool(FStringView, const uint32)>

Enumerations
enum class	EIoReadOptionsFlags : uint32 { None = 0 , HardwareTargetBuffer = 1 << 0 }
enum class	EIoContainerFlags : uint8 {   None , Compressed = (1 << 0) , Encrypted = (1 << 1) , Signed = (1 << 2) ,   Indexed = (1 << 3) , OnDemand = (1 << 4) }

Functions
CORE_API	DECLARE_LOG_CATEGORY_EXTERN (LogIoDispatcher, Log, All)
	ENUM_CLASS_FLAGS (EIoReadOptionsFlags)
int32	ConvertToIoDispatcherPriority (EAsyncIOPriorityAndFlags AIOP)
	DECLARE_MULTICAST_DELEGATE_OneParam (FIoSignatureErrorDelegate, const FIoSignatureError &)
	DECLARE_MULTICAST_DELEGATE_OneParam (FIoContainerMountedDelegate, const FIoContainerId &)
	ENUM_CLASS_FLAGS (EIoContainerFlags)

Typedef Documentation

FDirectoryIndexVisitorFunction

using FDirectoryIndexVisitorFunction = TFunctionRef<bool(FStringView, const uint32)>

FIoReadCallback

using FIoReadCallback = TFunction<void(TIoStatusOr<FIoBuffer>)>

Enumeration Type Documentation

EIoContainerFlags

enum class EIoContainerFlags : uint8

strong

Enumerator
None
Compressed
Encrypted
Signed
Indexed
OnDemand

EIoReadOptionsFlags

enum class EIoReadOptionsFlags : uint32

strong

Enumerator
None
HardwareTargetBuffer	Use this flag to inform the decompressor that the memory is uncached or write-combined and therefore the usage of staging might be needed if reading directly from the original memory

Function Documentation

ConvertToIoDispatcherPriority()

int32 ConvertToIoDispatcherPriority ( EAsyncIOPriorityAndFlags  AIOP )

inline

DECLARE_LOG_CATEGORY_EXTERN()

CORE_API DECLARE_LOG_CATEGORY_EXTERN	(	LogIoDispatcher	,
		Log	,
		All
	)

DECLARE_MULTICAST_DELEGATE_OneParam() [1/2]

DECLARE_MULTICAST_DELEGATE_OneParam	(	FIoContainerMountedDelegate	,
		const FIoContainerId &
	)

DECLARE_MULTICAST_DELEGATE_OneParam() [2/2]

DECLARE_MULTICAST_DELEGATE_OneParam	(	FIoSignatureErrorDelegate	,
		const FIoSignatureError &
	)

ENUM_CLASS_FLAGS() [1/2]

ENUM_CLASS_FLAGS

(

EIoContainerFlags

)

ENUM_CLASS_FLAGS() [2/2]

ENUM_CLASS_FLAGS

(

EIoReadOptionsFlags

)