FOnlineServicesCommon

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

IOnlineServices

FOnlineServicesCommon

FOnlineServicesEOS

References

Module	OnlineServicesCommon
Header	/Engine/Plugins/Online/Experimental/OnlineServices/Source/OnlineServicesCommon/Public/Online/OnlineServicesCommon.h
Include	#include "Online/OnlineServicesCommon.h"

Syntax

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

Variables

	Name	Description
FOnlineComponen...	Components
FString	ConfigName
TUniquePtr< IOn...	ConfigProvider
TArray< FString...	ConfigSectionOverrides	Config section overrides
TMap< FString, ...	ExecCommands
uint32	InstanceIndex
FOnlineAsyncOpC...	OpCache
FOnlineAsyncOpQ...	ParallelQueue
TMap< FOnlineAc...	PerUserSerialQueue
FOnlineAsyncOpQ...	SerialQueue

Constructors

	Name	Description
	FOnlineServicesCommon ( const FString& InConfigName )
	FOnlineServicesCommon ( const FOnlineServicesCommon& )
	FOnlineServicesCommon ( FOnlineServicesCommon&& )

Destructors

	Name	Description
	~FOnlineServicesCommon()

Functions

	Name	Description
void	AddConfigSectionOverride ( const FString& Override )	Add a config section override. These will be used in the order they are added
void	Execute ( FOnlineAsyncExecutionPolicy Executi..., CallableType&& Callable )	Call a callable according to a specified execution policy
void	ExecuteOnGameThread ( CallableType&& Callable )	Call a callable on the game thread
ComponentTyp...	Get()	Retrieve any of the Interface IOnlineComponents
const FStrin...	GetConfigName()	Get the config name for the Subsystem
TArray< FStr...	GetConfigSectionHeiarchy ( const FString& OperationName )
TArray< FStr...	GetConfigSectionHeirachWithOverrides ( const TArray< FString >& SectionHe... )	Get an array of a config section with the overrides added in
TOnlineAsync...	GetJoinableOp ( typename OpType::Params&& Params, const TArray< FString > ConfigSecti... )
TOnlineAsync...	GetJoinableOp ( typename OpType::Params&& Params )
TOnlineAsync...	GetMergeableOp ( typename OpType::Params&& Params, const TArray< FString > ConfigSecti... )
TOnlineAsync...	GetMergeableOp ( typename OpType::Params&& Params )
TOnlineAsync...	GetOp ( typename OpType::Params&& Params, const TArray< FString > ConfigSecti... )	Get op (Interface)
TOnlineAsync...	GetOp ( typename OpType::Params&& Params )	Get op (OnlineServices)
FOnlineAsync...	GetParallelQueue()	Queue for executing tasks in parallel. Serial queues feed into this
FOnlineAsync...	GetSerialQueue ( const FOnlineAccountIdHandle& Acco... )	Queues for executing per-user tasks in serial
FOnlineAsync...	GetSerialQueue()	Queue for executing tasks in serial
void	Initialize()	Calls Initialize on all the components, called after RegisterComponents
void	LoadConfig()	Calls LoadConfig on all the components
bool	LoadConfig ( StructType& Struct, const FString& InterfaceName, const FString& OperationName )	Load a config struct for an interface + operation Will load values from the following sections: OnlineServices OnlineServices. OnlineServices.. (if InterfaceName is set) OnlineServices... (if OperationName is set)
bool	LoadConfig ( StructType& Struct, const TArray< FString >& SectionHe... )	Load a config struct for a section heiarchy, also using the ConfigSectionOverrides
void	PostInitialize()	Calls PostInitialize on all the components, called after Initialize
void	PreShutdown()	Calls PreShutdown on all the components, called prior to Shutdown
void	RegisterComponents()	Called to register all the IOnlineComponents with the IOnlineService, called after this is constructed
void	RegisterExecHandler ( const FString& Name, TUniquePtr< IOnlineExecHandler >&&... )
void	ResetConfigSectionOverrides()	Clear the list of config overrides
void	SetConfigProvider ( TUniquePtr< IOnlineConfigProvider >... )	Override the default config provider (FOnlineConfigProviderGConfig(GEngineini))
void	Shutdown()	Calls Shutdown on all the components, called before this is destructed

Overridden from IOnlineServices

	Name	Description
void	Destroy()
IAuthPtr	GetAuthInterface()
IConnectivit...	GetConnectivityInterface()
IExternalUIP...	GetExternalUIInterface()
IFriendsPtr	GetFriendsInterface()
ILobbiesPtr	GetLobbiesInterface()	Get the lobbies implementation
IPresencePtr	GetPresenceInterface()
IPrivilegesP...	GetPrivilegesInterface()
void	Init()	IOnlineServices.

Overridden from FTSTickerObjectBase

		Name	Description
	bool	Tick ( float DeltaSeconds )	Calls Tick on all the components

Overridden from FExec

		Name	Description
	bool	Exec ( UWorld* InWorld, const TCHAR* Cmd, FOutputDevice& Ar )	Exec handler

Typedefs

Name	Description
Super

Constants

Name	Description
NextInstanceIndex