UE::IoStore::FOnDemandHostGroup Class Reference

#include <OnDemandHostGroup.h>

Classes
struct	FImpl

Public Member Functions
UE_API	FOnDemandHostGroup ()
UE_API	~FOnDemandHostGroup ()
UE_API TConstArrayView< FAnsiString >	Hosts () const
UE_API FAnsiStringView	Host (int32 Index) const
UE_API FAnsiStringView	CycleHost (int32 &InOutIndex) const
UE_API void	SetPrimaryHost (int32 Index)
UE_API FAnsiStringView	PrimaryHost () const
UE_API int32	PrimaryHostIndex () const
UE_API bool	IsEmpty () const

Static Public Member Functions
static UE_API TIoStatusOr< FOnDemandHostGroup >	Create (FAnsiStringView Url)
static UE_API TIoStatusOr< FOnDemandHostGroup >	Create (FStringView Url)
static UE_API TIoStatusOr< FOnDemandHostGroup >	Create (TConstArrayView< FAnsiString > Urls)
static UE_API TIoStatusOr< FOnDemandHostGroup >	Create (TConstArrayView< FString > Urls)

Static Public Attributes
static UE_API FName	DefaultName = FName("Default")

Friends
bool	operator== (const FOnDemandHostGroup &Lhs, const FOnDemandHostGroup &Rhs)
uint32	GetTypeHash (const FOnDemandHostGroup &Endpoint)

Detailed Description

Holds a set of host URLs.

Constructor & Destructor Documentation

FOnDemandHostGroup()

UE::IoStore::FOnDemandHostGroup::FOnDemandHostGroup

(

)

Creates a new empty host group.

~FOnDemandHostGroup()

UE::IoStore::FOnDemandHostGroup::~FOnDemandHostGroup

(

)

Destructor.

Member Function Documentation

Create() [1/4]

TIoStatusOr< FOnDemandHostGroup > UE::IoStore::FOnDemandHostGroup::Create ( FAnsiStringView  Url )

static

Create a new host group with the specified URL.

Create() [2/4]

TIoStatusOr< FOnDemandHostGroup > UE::IoStore::FOnDemandHostGroup::Create ( FStringView  Url )

static

Create a new host group with the specified URL.

Create() [3/4]

TIoStatusOr< FOnDemandHostGroup > UE::IoStore::FOnDemandHostGroup::Create ( TConstArrayView< FAnsiString >  Urls )

static

Create a new host group with the specified URLs.

Create() [4/4]

TIoStatusOr< FOnDemandHostGroup > UE::IoStore::FOnDemandHostGroup::Create ( TConstArrayView< FString >  Urls )

static

Create a new host group with the specified URLs.

CycleHost()

FAnsiStringView UE::IoStore::FOnDemandHostGroup::CycleHost

(

int32 &

InOutIndex

)

const

Get the next available host starting from the specified index.

Host()

FAnsiStringView UE::IoStore::FOnDemandHostGroup::Host

(

int32

Index

)

const

Get the URL at the specified index.

Hosts()

TConstArrayView< FAnsiString > UE::IoStore::FOnDemandHostGroup::Hosts

(

)

const

Returns the list of available host URLs.

IsEmpty()

bool UE::IoStore::FOnDemandHostGroup::IsEmpty

(

)

const

Returns whether the group is empty or not.

PrimaryHost()

FAnsiStringView UE::IoStore::FOnDemandHostGroup::PrimaryHost

(

)

const

Get the primary host URL.

PrimaryHostIndex()

int32 UE::IoStore::FOnDemandHostGroup::PrimaryHostIndex

(

)

const

Get the primary host index.

SetPrimaryHost()

void UE::IoStore::FOnDemandHostGroup::SetPrimaryHost

(

int32

Index

)

Set the primary host URL.

Friends And Related Symbol Documentation

GetTypeHash

uint32 GetTypeHash ( const FOnDemandHostGroup &  Endpoint )

friend

Returns the type hash of the endpoint.

operator==

bool operator== ( const FOnDemandHostGroup &  Lhs, const FOnDemandHostGroup &  Rhs  )

friend

Returns whether two endpoint instance are the same or not.

Member Data Documentation

DefaultName

FName UE::IoStore::FOnDemandHostGroup::DefaultName = FName("Default")

static

Default host group name.

---

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

• Engine/Source/Runtime/Experimental/IoStore/OnDemandCore/Public/IO/OnDemandHostGroup.h
• Engine/Source/Runtime/Experimental/IoStore/OnDemandCore/Private/OnDemandHostGroup.cpp