UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FStorageServerConnection Class Reference

#include <StorageServerConnection.h>

Classes

struct  FChunkBatchRequestEntry
 
struct  Workspaces
 

Public Member Functions

 FStorageServerConnection ()=default
 
 ~FStorageServerConnection ()=default
 
bool Initialize (TArrayView< const FString > HostAddresses, const int32 Port, const FAnsiStringView &InBaseURI)
 
TIoStatusOr< WorkspacesGetWorkspaces ()
 
TIoStatusOr< FString > CreateShare (const FString &WorkspaceId, const FString &SharePath, const FString &Alias)
 
bool IsConnectedToWorkspace () const
 
void PackageStoreRequest (TFunctionRef< void(FPackageStoreEntryResource &&)> Callback)
 
void FileManifestRequest (TFunctionRef< void(FIoChunkId Id, FStringView Path, int64 RawSize)> Callback)
 
void ChunkInfosRequest (TFunctionRef< void(FIoChunkId Id, FIoHash RawHash, int64 RawSize)> Callback)
 
int64 ChunkSizeRequest (const FIoChunkId &ChunkId)
 
TIoStatusOr< FIoBufferReadChunkRequest (const FIoChunkId &ChunkId, const uint64 Offset, const uint64 Size, const TOptional< FIoBuffer > OptDestination, const bool bHardwareTargetBuffer)
 
void ReadChunkRequestAsync (const FIoChunkId &ChunkId, const uint64 Offset, const uint64 Size, const TOptional< FIoBuffer > OptDestination, const bool bHardwareTargetBuffer, TFunctionRef< void(TIoStatusOr< FIoBuffer > Data)> OnResponse)
 
FIoStatus ReadChunkBatchRequest (const TArray< FChunkBatchRequestEntry > &Chunks, TFunctionRef< void(FIoChunkId Id, EStorageServerContentType MimeType, FIoBuffer Data, const TOptional< uint64 > &ModTag)> OnResponse, bool bSkipData=false)
 
FStringView GetHostAddr () const
 
void GetAndResetStats (IStorageServerPlatformFile::FConnectionStats &OutStats)
 

Constructor & Destructor Documentation

◆ FStorageServerConnection()

FStorageServerConnection::FStorageServerConnection ( )
default

◆ ~FStorageServerConnection()

FStorageServerConnection::~FStorageServerConnection ( )
default

Member Function Documentation

◆ ChunkInfosRequest()

void FStorageServerConnection::ChunkInfosRequest ( TFunctionRef< void(FIoChunkId Id, FIoHash RawHash, int64 RawSize)>  Callback)

◆ ChunkSizeRequest()

int64 FStorageServerConnection::ChunkSizeRequest ( const FIoChunkId ChunkId)

◆ CreateShare()

TIoStatusOr< FString > FStorageServerConnection::CreateShare ( const FString &  WorkspaceId,
const FString &  SharePath,
const FString &  Alias 
)

◆ FileManifestRequest()

void FStorageServerConnection::FileManifestRequest ( TFunctionRef< void(FIoChunkId Id, FStringView Path, int64 RawSize)>  Callback)

◆ GetAndResetStats()

void FStorageServerConnection::GetAndResetStats ( IStorageServerPlatformFile::FConnectionStats OutStats)

◆ GetHostAddr()

FStringView FStorageServerConnection::GetHostAddr ( ) const
inline

◆ GetWorkspaces()

TIoStatusOr< FStorageServerConnection::Workspaces > FStorageServerConnection::GetWorkspaces ( )

◆ Initialize()

bool FStorageServerConnection::Initialize ( TArrayView< const FString >  HostAddresses,
const int32  Port,
const FAnsiStringView InBaseURI 
)

◆ IsConnectedToWorkspace()

bool FStorageServerConnection::IsConnectedToWorkspace ( ) const
inline

◆ PackageStoreRequest()

void FStorageServerConnection::PackageStoreRequest ( TFunctionRef< void(FPackageStoreEntryResource &&)>  Callback)

◆ ReadChunkBatchRequest()

FIoStatus FStorageServerConnection::ReadChunkBatchRequest ( const TArray< FChunkBatchRequestEntry > &  Chunks,
TFunctionRef< void(FIoChunkId Id, EStorageServerContentType MimeType, FIoBuffer Data, const TOptional< uint64 > &ModTag)>  OnResponse,
bool  bSkipData = false 
)

◆ ReadChunkRequest()

TIoStatusOr< FIoBuffer > FStorageServerConnection::ReadChunkRequest ( const FIoChunkId ChunkId,
const uint64  Offset,
const uint64  Size,
const TOptional< FIoBuffer OptDestination,
const bool  bHardwareTargetBuffer 
)

◆ ReadChunkRequestAsync()

void FStorageServerConnection::ReadChunkRequestAsync ( const FIoChunkId ChunkId,
const uint64  Offset,
const uint64  Size,
const TOptional< FIoBuffer OptDestination,
const bool  bHardwareTargetBuffer,
TFunctionRef< void(TIoStatusOr< FIoBuffer > Data)>  OnResponse 
)

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