1. Epic GamesDeveloper
  3. FOnlineServicesCommon

FOnlineServicesCommon

API > API/Plugins > API/Plugins/OnlineServicesCommon > API/Plugins/OnlineServicesCommon/Online

Inheritance Hierarchy

References

   
Module OnlineServicesCommon
Header /Engine/Plugins/Online/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

  Type Name Description
Protected variable FOnlineComponentRegistry Components  
Protected variable FString ConfigName  
Protected variable TUniquePtr< IOnlineConfigProvider > ConfigProvider  
Protected variable TArray< FString > ConfigSectionOverrides Config section overrides
Protected variable TMap< FString, TUniquePtr< IOnlineExecHandler > > ExecCommands  
Protected variable uint32 InstanceIndex  
Protected variable FName InstanceName  
Public variable FOnlineAsyncOpCache OpCache  
Protected variable FOnlineAsyncOpQueueParallel ParallelQueue  
Protected variable TMap< FAccountId, TUniquePtr< FOnlineAsyncOpQueueSerial > > PerUserSerialQueue  
Protected variable FOnlineAsyncOpQueueSerial SerialQueue  

Constructors

  Type Name Description
Public function    
Public function    
Public function  

FOnlineServicesCommon ( const FString& InConfigName,
FName InInstanceName
)

  

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function void

AddConfigSectionOverride ( const FString& Override
)

 Add a config section override. These will be used in the order they are added
Public function void

Execute ( FOnlineAsyncExecutionPolicy ExecutionPolicy,
CallableType&& Callable
)

 Call a callable according to a specified execution policy
Public function void

ExecuteOnGameThread ( CallableType&& Callable
)

 Call a callable on the game thread
Public function ComponentType *

Get ()

 Retrieve any of the Interface IOnlineComponents
Public function Const const FString & Get the config name for the Subsystem
Public function Const TArray< FString >

GetConfigSectionHeiarchy ( const FString& OperationName
)

  
Public function Const TArray< FString >

GetConfigSectionHeirachWithOverrides ( const TArray< FString >& SectionHeiarchy
)

 Get an array of a config section with the overrides added in
Public function TOnlineAsyncOpRef< OpType >

GetJoinableOp ( typename OpType::Params&& Params
)

  
Public function TOnlineAsyncOpRef< OpType >

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

  
Public function TOnlineAsyncOpRef< OpType >

GetMergeableOp ( typename OpType::Params&& Params
)

  
Public function TOnlineAsyncOpRef< OpType >

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

  
Public function TOnlineAsyncOpRef< OpType >

GetOp ( typename OpType::Params&& Params
)

 Get op (OnlineServices)
Public function TOnlineAsyncOpRef< OpType >

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

 Get op (Interface)
Public function FOnlineAsyncOpQueueParallel & Queue for executing tasks in parallel. Serial queues feed into this
Public function FOnlineAsyncOpQueue &

GetSerialQueue ( const FAccountId& AccountId
)

 Queues for executing per-user tasks in serial
Public function FOnlineAsyncOpQueue & Queue for executing tasks in serial
Public function Virtual void Calls Initialize on all the components, called after RegisterComponents
Protected function void  
Public function Const bool

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

 Load a config struct for a section heiarchy, also using the ConfigSectionOverrides
Public function Const 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. (if InterfaceName is set) OnlineServices. OnlineServices.. (if InterfaceName is set) OnlineServices... (if OperationName is set)
Public function Virtual void Calls PostInitialize on all the components, called after Initialize
Public function Virtual void Calls PreShutdown on all the components, called prior to Shutdown
Public function Virtual void Called to register all the IOnlineComponents with the IOnlineService, called after this is constructed
Public function void  
Public function void Clear the list of config overrides
Public function void Override the default config provider (FOnlineConfigProviderGConfig(GEngineini))
Public function Virtual void Calls Shutdown on all the components, called before this is destructed
Public function Virtual void Calls UpdateConfig on all the components

Overridden from IOnlineServices

  Type Name Description
Public function Virtual void

AssignBaseInterfaceSharedPtr ( const FOnlineTypeName& TypeName,
void* OutBaseInterfaceSP
)

  
Public function Virtual void

Destroy ()

  
Public function Virtual IAchievementsPtr  
Public function Virtual IAuthPtr  
Public function Virtual ICommercePtr  
Public function Virtual IConnectivityPtr  
Public function Virtual IExternalUIPtr  
Public function Virtual Const FName Get the instance name of this instance.
Public function Virtual ILeaderboardsPtr Get the leaderboards implementation
Public function Virtual ILobbiesPtr Get the lobbies implementation
Public function Virtual IPresencePtr  
Public function Virtual IPrivilegesPtr  
Public function Virtual TOnlineResult< FGetResolvedConnectString > Get the connectivity string used for client travel
Public function Virtual ISessionsPtr Get the sessions implementation
Public function Virtual ISocialPtr Get the social interface, used to interact with friends lists, blocked user lists, and any other social relationships
Public function Virtual IStatsPtr Get the stats implementation
Public function Virtual ITitleFilePtr  
Public function Virtual IUserFilePtr  
Public function Virtual IUserInfoPtr  
Public function Virtual void

Init ()

 IOnlineServices.

Overridden from FTSTickerObjectBase

  Type Name Description
Public function Virtual bool

Tick ( float DeltaSeconds
)

 Calls Tick on all the components

Typedefs

Name Description
Super  

Constants

Name Description
NextInstanceIndex  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page