FCoreRedirectsContext Struct Reference

#include <CoreRedirectsContext.h>

Public Types
enum class	EFlags : uint32 {   None = 0 , DebugMode = 1 << 0 , ValidateAddedRedirects = 1 << 1 , UseRedirectionSummary = 1 << 2 ,   Default = ValidateAddedRedirects | UseRedirectionSummary }

Public Member Functions
UE_API void	InitializeContext ()
UE_API	FCoreRedirectsContext ()
UE_API	FCoreRedirectsContext (const FCoreRedirectsContext &OtherContext)
const bool	IsInitialized () const
const bool	IsInDebugMode () const
EFlags	GetFlags () const
void	SetFlags (EFlags Flags)
const bool	HasValidated () const
TMap< FName, ECoreRedirectFlags > &	GetConfigKeyMap ()
FCoreRedirects::FRedirectTypeMap &	GetRedirectTypeMap ()
UE_API FCoreRedirectsContext &	operator= (const FCoreRedirectsContext &Other)

Static Public Member Functions
static UE_API FCoreRedirectsContext &	GetGlobalContext ()
static UE_API FCoreRedirectsContext &	GetThreadContext ()
static UE_API void	SetThreadContext (FCoreRedirectsContext &NewContext)

Friends
struct	FScopeCoreRedirectsReadLockedContext
struct	FScopeCoreRedirectsWriteLockedContext
void	FCoreRedirects::ValidateAllRedirects ()

Detailed Description

Stores state required for FCoreRedirects API. The context encapsulates the necessary state for the FCoreRedirects API to function. Changine the context can be used to change the set of CoreRedirects for the current thread without affecting other threads. It is up to the user to ensure contexts are shared or not between threads. By default a single global context is shared amoung all threads until a thread local context is set.

Member Enumeration Documentation

EFlags

enum class FCoreRedirectsContext::EFlags : uint32

strong

Enumerator
None
DebugMode
ValidateAddedRedirects
UseRedirectionSummary
Default

Constructor & Destructor Documentation

FCoreRedirectsContext() [1/2]

FCoreRedirectsContext::FCoreRedirectsContext

(

)

Creates a context with a debug context name

FCoreRedirectsContext() [2/2]

FCoreRedirectsContext::FCoreRedirectsContext

(

const FCoreRedirectsContext &

OtherContext

)

Creates a context with a debug context name, and inherits the state from OtherContext. The state from OtherContext is copied into the new context

Member Function Documentation

GetConfigKeyMap()

TMap< FName, ECoreRedirectFlags > & FCoreRedirectsContext::GetConfigKeyMap ( )

inline

Map from config name to flag

GetFlags()

FCoreRedirectsContext::EFlags FCoreRedirectsContext::GetFlags ( ) const

inline

Gets the flags for the context

GetGlobalContext()

FCoreRedirectsContext & FCoreRedirectsContext::GetGlobalContext ( )

static

GetRedirectTypeMap()

FCoreRedirects::FRedirectTypeMap & FCoreRedirectsContext::GetRedirectTypeMap ( )

inline

Map from name of thing being mapped to full list. List must be filtered further

GetThreadContext()

FCoreRedirectsContext & FCoreRedirectsContext::GetThreadContext ( )

static

HasValidated()

const bool FCoreRedirectsContext::HasValidated ( ) const

inline

True if we have done our initial validation. After initial validation, each change to redirects will validate independently

InitializeContext()

void FCoreRedirectsContext::InitializeContext

(

)

Run initialization steps that are needed before any data can be stored from FCoreRedirects calls.

IsInDebugMode()

const bool FCoreRedirectsContext::IsInDebugMode ( ) const

inline

True if we are in debug mode that does extra validation

IsInitialized()

const bool FCoreRedirectsContext::IsInitialized ( ) const

inline

Get whether this has been initialized

operator=()

FCoreRedirectsContext & FCoreRedirectsContext::operator=

(

const FCoreRedirectsContext &

Other

)

SetFlags()

void FCoreRedirectsContext::SetFlags ( FCoreRedirectsContext::EFlags  NewFlags )

inline

Sets the flags for the context

SetThreadContext()

void FCoreRedirectsContext::SetThreadContext ( FCoreRedirectsContext &  NewContext )

static

Friends And Related Symbol Documentation

FCoreRedirects::ValidateAllRedirects

void FCoreRedirects::ValidateAllRedirects ( )

friend

FScopeCoreRedirectsReadLockedContext

friend struct FScopeCoreRedirectsReadLockedContext

friend

FScopeCoreRedirectsWriteLockedContext

friend struct FScopeCoreRedirectsWriteLockedContext

friend

---

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

• Engine/Source/Runtime/CoreUObject/Internal/UObject/CoreRedirects/CoreRedirectsContext.h
• Engine/Source/Runtime/CoreUObject/Private/UObject/CoreRedirectsContext.cpp