1. Epic GamesDeveloper
  3. FOnlineServicesCommon

FOnlineServicesCommon

API > API/Plugins > API/Plugins/OnlineServicesCommon

   
Name FOnlineServicesCommon
Type class
Header File /Engine/Plugins/Online/OnlineServices/Source/OnlineServicesCommon/Public/Online/OnlineServicesCommon.h
Include Path #include "Online/OnlineServicesCommon.h"

Syntax

class FOnlineServicesCommon :  
    public UE::Online::IOnlineServices ,  
    public TSharedFromThis< FOnlineServicesCommon > ,  
    public FTSTickerObjectBase ,  
    public FSelfRegisteringExec

Inheritance Hierarchy

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

FOnlineServicesCommon ( const FString& InServiceConfigName,
FName InInstanceName
)

   Online/OnlineServicesCommon.h  

FOnlineServicesCommon ( const FString& InServiceConfigName,
FName InInstanceName,
FName InInstanceConfigName
)

   Online/OnlineServicesCommon.h  
  Online/OnlineServicesCommon.h  
  Online/OnlineServicesCommon.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~FOnlineServicesCommon()

   Online/OnlineServicesCommon.h  

Enums

Protected

Name Remarks
EAsyncOpFlushReason  

Typedefs

Name Type Remarks Include Path
Super IOnlineServices   Online/OnlineServicesCommon.h

Constants

Name Type Remarks Include Path
NextInstanceIndex uint32   Online/OnlineServicesCommon.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
OpCache FOnlineAsyncOpCache   Online/OnlineServicesCommon.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddConfigSectionOverride ( const FString& Override
)

 Add a config section override. These will be used in the order they are added Online/OnlineServicesCommon.h  

virtual void AssignBaseInterfaceSharedPtr ( const FOnlineTypeName& TypeName,
void* OutBaseInterfaceSP
)

   Online/OnlineServicesCommon.h  

void Execute ( FOnlineAsyncExecutionPolicy ExecutionPolicy,
CallableType&& Callable
)

 Call a callable according to a specified execution policy Online/OnlineServicesCommon.h  

void ExecuteOnGameThread ( CallableType&& Callable
)

 Call a callable on the game thread Online/OnlineServicesCommon.h  

ComponentType * Get()

 Retrieve any of the Interface IOnlineComponents Online/OnlineServicesCommon.h  

const FString & GetConfigName()

 Get the ini config name for the Subsystem Online/OnlineServicesCommon.h  

TArray< FString > GetConfigSectionHeiarchy ( const FString& OperationName
) const

   Online/OnlineServicesCommon.h  

TArray< FString > GetConfigSectionHeirachWithOverrides ( const TArray< FString >& SectionHeirarchy
) const

   Online/OnlineServicesCommon.h  

TArray< FString > GetConfigSectionHeirarchy ( const FString& OperationName
) const

   Online/OnlineServicesCommon.h  

TArray< FString > GetConfigSectionHeirarchyWithOverrides ( const TArray< FString >& SectionHeirarchy
) const

 Get an array of a config section with the overrides added in Online/OnlineServicesCommon.h  

TOnlineAsyncOpRef< OpType > GetJoinableOp ( typename OpType::Params&& Params
)

   Online/OnlineServicesCommon.h  

TOnlineAsyncOpRef< OpType > GetJoinableOp ( typename OpType::Params&& Params,
const TArray< FString >& ConfigSectionHeirarchy
)

   Online/OnlineServicesCommon.h  

TOnlineAsyncOpRef< OpType > GetMergeableOp ( typename OpType::Params&& Params
)

   Online/OnlineServicesCommon.h  

TOnlineAsyncOpRef< OpType > GetMergeableOp ( typename OpType::Params&& Params,
const TArray< FString >& ConfigSectionHeirarchy
)

   Online/OnlineServicesCommon.h  

TOnlineAsyncOpRef< OpType > GetOp ( typename OpType::Params&& Params
)

 Get op (OnlineServices) Online/OnlineServicesCommon.h  

TOnlineAsyncOpRef< OpType > GetOp ( typename OpType::Params&& Params,
const TArray< FString >& ConfigSectionHeirarchy
)

 Get op (Interface) Online/OnlineServicesCommon.h  

FOnlineAsyncOpQueueParallel & GetParallelQueue()

 Queue for executing tasks in parallel. Serial queues feed into this Online/OnlineServicesCommon.h  

FOnlineAsyncOpQueue & GetSerialQueue ( const FAccountId& AccountId
)

 Queues for executing per-user tasks in serial Online/OnlineServicesCommon.h  
Queue for executing tasks in serial Online/OnlineServicesCommon.h  

const FString & GetServiceConfigName()

   Online/OnlineServicesCommon.h  

virtual void Initialize()

 Calls Initialize on all the components, called after RegisterComponents Online/OnlineServicesCommon.h  

bool LoadConfig ( StructType& Struct,
const FString& InterfaceName,
const FString& OperationName
) const

 Load a config struct for an interface + operation Will load values from the following sections: OnlineServices OnlineServices. (if InterfaceName is set) OnlineServices. OnlineServices.. (if InterfaceName is set) OnlineServices... (if OperationName is set) Online/OnlineServicesCommon.h  

bool LoadConfig ( StructType& Struct,
const TArray< FString >& SectionHeirarchy
) const

 Load a config struct for a section heirarchy, also using the ConfigSectionOverrides Online/OnlineServicesCommon.h  

virtual void PostInitialize()

 Calls PostInitialize on all the components, called after Initialize Online/OnlineServicesCommon.h  

virtual void PreShutdown()

 Calls PreShutdown on all the components, called prior to Shutdown Online/OnlineServicesCommon.h  

virtual void RegisterComponents()

 Called to register all the IOnlineComponents with the IOnlineService, called after this is constructed Online/OnlineServicesCommon.h  

void RegisterExecHandler ( const FString& Name,
TUniquePtr< IOnlineExecHandler >&& Handler
)

   Online/OnlineServicesCommon.h  

void ResetConfigSectionOverrides()

 Clear the list of config overrides Online/OnlineServicesCommon.h  

void SetConfigProvider ( TUniquePtr< IOnlineConfigProvider >&& InConfigProvider
)

 Override the default config provider (FOnlineConfigProviderGConfig(GEngineini)) Online/OnlineServicesCommon.h  

virtual void Shutdown()

 Calls Shutdown on all the components, called before this is destructed Online/OnlineServicesCommon.h  

virtual void UpdateConfig()

 Calls UpdateConfig on all the components Online/OnlineServicesCommon.h  

Overridden from IOnlineServices

Name Remarks Include Path Unreal Specifiers

virtual void Destroy()

   Online/OnlineServicesCommon.h  

virtual IAchievementsPtr GetAchievementsInterface()

   Online/OnlineServicesCommon.h  

virtual IAuthPtr GetAuthInterface()

   Online/OnlineServicesCommon.h  

virtual ICommercePtr GetCommerceInterface()

   Online/OnlineServicesCommon.h  

virtual IConnectivityPtr GetConnectivityInterface()

   Online/OnlineServicesCommon.h  

virtual IExternalUIPtr GetExternalUIInterface()

   Online/OnlineServicesCommon.h  

virtual FName GetInstanceConfigName()

   Online/OnlineServicesCommon.h  

virtual FName GetInstanceName()

   Online/OnlineServicesCommon.h  

virtual ILeaderboardsPtr GetLeaderboardsInterface()

   Online/OnlineServicesCommon.h  

virtual ILobbiesPtr GetLobbiesInterface()

   Online/OnlineServicesCommon.h  

virtual IPresencePtr GetPresenceInterface()

   Online/OnlineServicesCommon.h  

virtual IPrivilegesPtr GetPrivilegesInterface()

   Online/OnlineServicesCommon.h  

virtual TOnlineResult< FGetResolvedConnectString > GetResolvedConnectString ( FGetResolvedConnectString::Params&& Params
)

   Online/OnlineServicesCommon.h  

virtual ISessionsPtr GetSessionsInterface()

   Online/OnlineServicesCommon.h  

virtual ISocialPtr GetSocialInterface()

   Online/OnlineServicesCommon.h  

virtual IStatsPtr GetStatsInterface()

   Online/OnlineServicesCommon.h  

virtual ITitleFilePtr GetTitleFileInterface()

   Online/OnlineServicesCommon.h  

virtual IUserFilePtr GetUserFileInterface()

   Online/OnlineServicesCommon.h  

virtual IUserInfoPtr GetUserInfoInterface()

   Online/OnlineServicesCommon.h  

virtual void Init()

 IOnlineServices. Online/OnlineServicesCommon.h  

Overridden from FTSTickerObjectBase

Name Remarks Include Path Unreal Specifiers

virtual bool Tick ( float DeltaSeconds
)

 Calls Tick on all the components Online/OnlineServicesCommon.h  

Protected

Name Remarks Include Path Unreal Specifiers

void Flush ( EAsyncOpFlushReason FlushReason
)

   Online/OnlineServicesCommon.h  

virtual void FlushTick ( float DeltaSeconds
)

   Online/OnlineServicesCommon.h  

void LoadCommonConfig()

   Online/OnlineServicesCommon.h  

void LogErrorIfOnlineServicesHasShutdown()

   Online/OnlineServicesCommon.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page