1. Epic GamesDeveloper
  3. FOnlineSubsystemModule

FOnlineSubsystemModule

Online subsystem module class Wraps the loading of an online subsystem by name and allows new services to register themselves for use

API > API/Plugins > API/Plugins/OnlineSubsystem

Inheritance Hierarchy

References

   
Module OnlineSubsystem
Header /Engine/Plugins/Online/OnlineSubsystem/Source/Public/OnlineSubsystemModule.h
Include #include "OnlineSubsystemModule.h"

Syntax

class FOnlineSubsystemModule : public IModuleInterface

Remarks

Online subsystem module class Wraps the loading of an online subsystem by name and allows new services to register themselves for use

Constructors

  Type Name Description
Public function    

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function 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
Public function Const bool

DoesInstanceExist ( const FName InSubsystemName
)

 Does an instance of subsystem with the given name exist
Public function void  
Public function Virtual IOnlineSubsystem *

GetNativeSubsystem ( bool bAutoLoad
)

 Get the online subsystem native to the current hardware
Public function 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
Public function Virtual IOnlineSubsystem *

GetSubsystemByConfig ( const FString& ConfigString,
bool bAutoLoad
)

 Get the online subsystem associated with the given config string
Public function Virtual Const bool

IsOnlineSubsystemLoaded ( const FName InSubsystemName
)

 Determine if a subsystem is loaded by the OSS module
Public function Virtual void

RegisterPlatformService ( const FName FactoryName,
IOnlineFactory* Factory
)

 Register a new online subsystem interface with the base level factory provider
Public function void Shutdown the current default subsystem (may be the fallback) and attempt to reload the one specified in the configuration file
Public function Virtual void

UnregisterPlatformService ( const FName FactoryName
)

 Unregister an existing online subsystem interface from the base level factory provider

Overridden from IModuleInterface

  Type Name Description
Public function Virtual void Called before the module has been unloaded Overloaded to allow online subsystems to cancel any outstanding http requests
Public function Virtual void Called before the module is unloaded, right before the module object is destroyed.
Public function Virtual void 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
Public function Virtual bool Override this to set whether your module would like cleanup on application shutdown
Public function Virtual bool Override this to set whether your module is allowed to be unloaded on the fly

Typedefs

Name Description
FEnumerateOnlineSubsystemCb Enumerate all loaded online subsystems

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page