UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
UE::IoStore::FIASHostGroup Class Referencefinal

#include <IasHostGroup.h>

Classes

struct  FImpl
 

Public Types

enum class  EReconnectionResult : uint8 { AlreadyConnected = 0 , Reconnected , FailedToConnect }
 

Public Member Functions

 FIASHostGroup ()
 
 FIASHostGroup (FName Name, FAnsiStringView TestPath)
 
 FIASHostGroup (FName Name, FOnDemandHostGroup &&HostGroup)
 
 ~FIASHostGroup ()=default
 
FName GetName () const
 
const FAnsiStringGetTestPath () const
 
bool IsResolved () const
 
bool IsConnected () const
 
FIoStatus Resolve (TConstArrayView< FAnsiString > HostUrls)
 
FIoStatus Resolve (TConstArrayView< FString > HostUrls)
 
void Connect (int32 HostIndex)
 
void Disconnect ()
 
EReconnectionResult AttemptReconnection (uint32 TimeoutMs, std::atomic_bool &CancellationToken)
 
void OnSuccessfulResponse ()
 
bool OnFailedResponse ()
 
FAnsiStringView GetPrimaryHostUrl () const
 
int32 GetPrimaryHostIndex () const
 
const FOnDemandHostGroupGetUnderlyingHostGroup () const
 
TConstArrayView< FAnsiStringGetHostUrls () const
 

Static Public Member Functions

static TIoStatusOr< FIASHostGroupCreate (FName Name, TConstArrayView< FAnsiString > HostUrls)
 
static TIoStatusOr< FIASHostGroupCreate (FName Name, TConstArrayView< FString > HostUrls)
 

Member Enumeration Documentation

◆ EReconnectionResult

Enumerator
AlreadyConnected 
Reconnected 
FailedToConnect 

Constructor & Destructor Documentation

◆ FIASHostGroup() [1/3]

UE::IoStore::FIASHostGroup::FIASHostGroup ( )

◆ FIASHostGroup() [2/3]

UE::IoStore::FIASHostGroup::FIASHostGroup ( FName  Name,
FAnsiStringView  TestPath 
)

◆ FIASHostGroup() [3/3]

UE::IoStore::FIASHostGroup::FIASHostGroup ( FName  Name,
FOnDemandHostGroup &&  HostGroup 
)

◆ ~FIASHostGroup()

UE::IoStore::FIASHostGroup::~FIASHostGroup ( )
default

Member Function Documentation

◆ AttemptReconnection()

FIASHostGroup::EReconnectionResult UE::IoStore::FIASHostGroup::AttemptReconnection ( uint32  TimeoutMs,
std::atomic_bool &  CancellationToken 
)

◆ Connect()

void UE::IoStore::FIASHostGroup::Connect ( int32  HostIndex)

◆ Create() [1/2]

TIoStatusOr< FIASHostGroup > UE::IoStore::FIASHostGroup::Create ( FName  Name,
TConstArrayView< FAnsiString HostUrls 
)
static

◆ Create() [2/2]

TIoStatusOr< FIASHostGroup > UE::IoStore::FIASHostGroup::Create ( FName  Name,
TConstArrayView< FString >  HostUrls 
)
static

◆ Disconnect()

void UE::IoStore::FIASHostGroup::Disconnect ( )

◆ GetHostUrls()

TConstArrayView< FAnsiString > UE::IoStore::FIASHostGroup::GetHostUrls ( ) const

◆ GetName()

FName UE::IoStore::FIASHostGroup::GetName ( ) const

◆ GetPrimaryHostIndex()

int32 UE::IoStore::FIASHostGroup::GetPrimaryHostIndex ( ) const

◆ GetPrimaryHostUrl()

FAnsiStringView UE::IoStore::FIASHostGroup::GetPrimaryHostUrl ( ) const

◆ GetTestPath()

const FAnsiString & UE::IoStore::FIASHostGroup::GetTestPath ( ) const

◆ GetUnderlyingHostGroup()

const FOnDemandHostGroup & UE::IoStore::FIASHostGroup::GetUnderlyingHostGroup ( ) const

◆ IsConnected()

bool UE::IoStore::FIASHostGroup::IsConnected ( ) const

◆ IsResolved()

bool UE::IoStore::FIASHostGroup::IsResolved ( ) const

◆ OnFailedResponse()

bool UE::IoStore::FIASHostGroup::OnFailedResponse ( )

◆ OnSuccessfulResponse()

void UE::IoStore::FIASHostGroup::OnSuccessfulResponse ( )

◆ Resolve() [1/2]

FIoStatus UE::IoStore::FIASHostGroup::Resolve ( TConstArrayView< FAnsiString HostUrls)

◆ Resolve() [2/2]

FIoStatus UE::IoStore::FIASHostGroup::Resolve ( TConstArrayView< FString >  HostUrls)

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