Navigation
API > API/Plugins > API/Plugins/OnlineSubsystem
Online subsystem module class Wraps the loading of an online subsystem by name and allows new services to register themselves for use
| Name | FOnlineSubsystemModule |
| Type | class |
| Header File | /Engine/Plugins/Online/OnlineSubsystem/Source/Public/OnlineSubsystemModule.h |
| Include Path | #include "OnlineSubsystemModule.h" |
Syntax
class FOnlineSubsystemModule : public IModuleInterface
Implements Interfaces
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FOnlineSubsystemModule() |
OnlineSubsystemModule.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FOnlineSubsystemModule() |
OnlineSubsystemModule.h |
Structs
| Name | Remarks |
|---|---|
| FInstanceNameEntry | Cached instance names for efficient lookup in ParseOnlineSubsystemName. |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FEnumerateOnlineSubsystemCb | TFunction< void(IOnlineSubsystem *)> | Enumerate all loaded online subsystems | OnlineSubsystemModule.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| ConfigDefinedSubsystems | TMap< FString, FName > | Name of the online service associated with User Defined strings Specified in Base |
OnlineSubsystemModule.h | |
| DefaultPlatformService | FName | Name of the default online service requested Specified in DefaultEngine.ini [OnlineSubsystem] DefaultPlatformService | OnlineSubsystemModule.h | |
| InstanceNames | TMap< FName, FInstanceNameEntry > | OnlineSubsystemModule.h | ||
| ModuleRedirects | TMap< FString, FName > | Config driven override of module name for online subsystem | OnlineSubsystemModule.h | |
| NativePlatformService | FName | Name of the online service associated with the native platform Specified in Base |
OnlineSubsystemModule.h | |
| OnlineFactories | TMap< FName, IOnlineFactory * > | Existing instances of any online subsystems created |
OnlineSubsystemModule.h | |
| OnlineSubsystemFailureNotes | TSet< FName > | Have we warned already for a given online subsystem creation failure | OnlineSubsystemModule.h | |
| OnlineSubsystems | TMap< FName, IOnlineSubsystemPtr > | Mapping of all currently loaded platform service subsystems to their name | OnlineSubsystemModule.h | |
| OnlineSubsystemsLock | FTransactionallySafeCriticalSection | Lock for access to OnlineSubsystems array to allow for multiple threads to be able to create/get online subsystems simultaneously. | OnlineSubsystemModule.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void DestroyOnlineSubsystem
(
const FName InSubsystemName |
Destroys an online subsystem created internally via access with GetOnlineSubsystem Typically destruction of the subsystem is handled at application exit, but there may be rare instances where the subsystem is destroyed by request | OnlineSubsystemModule.h | |
bool DoesInstanceExist
(
const FName InSubsystemName |
Does an instance of subsystem with the given name exist | OnlineSubsystemModule.h | |
void EnumerateOnlineSubsystems
(
FEnumerateOnlineSubsystemCb& EnumCb |
OnlineSubsystemModule.h | ||
virtual IOnlineSubsystem * GetNativeSubsystem
(
bool bAutoLoad |
Get the online subsystem native to the current hardware | OnlineSubsystemModule.h | |
virtual IOnlineSubsystem * GetOnlineSubsystem
(
const FName InSubsystemName |
Main entry point for accessing an online subsystem by name Will load the appropriate module if the subsystem isn't currently loaded It's possible that the subsystem doesn't exist and therefore can return NULL | OnlineSubsystemModule.h | |
virtual IOnlineSubsystem * GetSubsystemByConfig
(
const FString& ConfigString, |
Get the online subsystem associated with the given config string | OnlineSubsystemModule.h | |
virtual bool IsOnlineSubsystemLoaded
(
const FName InSubsystemName |
Determine if a subsystem is loaded by the OSS module | OnlineSubsystemModule.h | |
virtual void RegisterPlatformService
(
const FName FactoryName, |
Register a new online subsystem interface with the base level factory provider | OnlineSubsystemModule.h | |
void ReloadDefaultSubsystem () |
Shutdown the current default subsystem (may be the fallback) and attempt to reload the one specified in the configuration file | OnlineSubsystemModule.h | |
virtual void UnregisterPlatformService
(
const FName FactoryName |
Unregister an existing online subsystem interface from the base level factory provider | OnlineSubsystemModule.h |
Overridden from IModuleInterface
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void PreUnloadCallback() |
Called before the module has been unloaded Overloaded to allow online subsystems to cancel any outstanding http requests | OnlineSubsystemModule.h | |
virtual void ShutdownModule () |
Called before the module is unloaded, right before the module object is destroyed. | OnlineSubsystemModule.h | |
virtual void StartupModule() |
Called right after the module DLL has been loaded and the module object has been created Overloaded to allow the default subsystem a chance to load | OnlineSubsystemModule.h | |
virtual bool SupportsAutomaticShutdown() |
Override this to set whether your module would like cleanup on application shutdown | OnlineSubsystemModule.h | |
virtual bool SupportsDynamicReloading() |
Override this to set whether your module is allowed to be unloaded on the fly | OnlineSubsystemModule.h |