1. Epic GamesDeveloper
  3. FOnlineSubsystemImpl

FOnlineSubsystemImpl

[FOnlineSubsystemImpl](API\Plugins\OnlineSubsystem\FOnlineSubsystemImpl) - common functionality to share across online platforms, not intended for direct use

API > API/Plugins > API/Plugins/OnlineSubsystem

Inheritance Hierarchy

References

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

Syntax

class FOnlineSubsystemImpl :  
    public IOnlineSubsystem,  
    public FTSTickerObjectBase

Remarks

FOnlineSubsystemImpl - common functionality to share across online platforms, not intended for direct use

Variables

  Type Name Description
Protected variable bool bForceDedicated Whether or not the online subsystem is in forced dedicated server mode
Protected variable bool bTickerStarted Is the ticker started
Protected variable TArray< FNextTickDelegate > CurrentTickBuffer Buffer to hold callbacks for the current tick (so it's safe to call ExecuteNextTick within a tick callback)
Protected variable FName InstanceName Instance name (disambiguates PIE instances for example)
Protected variable UNamedInterfaces * NamedInterfaces Holds all currently named interfaces
Protected variable TQueue< FNextTickDelegate, EQueueMode::Mpsc > NextTickQueue Queue to hold callbacks scheduled for next tick using ExecuteNextTick
Protected variable FName SubsystemName Name of the subsystem

Constructors

  Type Name Description
Protected function   Hidden on purpose
Protected function  

FOnlineSubsystemImpl ( FName InSubsystemName,
FName InInstanceName
)

  
Protected function  

FOnlineSubsystemImpl ( FName InSubsystemName,
FName InInstanceName,
FTSTicker& Ticker
)

  

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function void Queue a delegate to be executed on the next tick
Public function void

ExecuteNextTick ( LAMBDA_TYPE&& Callback
)

 Templated helper for calling ExecuteDelegateNextTick with a lambda function
Public function Static FString

FilterResponseStr ( const FString& ResponseStr,
const TArray< FString >& RedactFields
)

 Modify a response string so that it can be logged cleanly
Protected function void Load in any named interfaces specified by the ini configuration
Public function Virtual void

OnConfigSectionsChanged ( const FString& IniFilename,
const TSet< FString >& SectionNames
)

 Delegate for config file changes.
Protected function void Delegate fired when named interfaces are cleaned up at exit
Protected function void Start Ticker
Protected function void Stop Ticker

Overridden from IOnlineSubsystem

  Type Name Description
Public function Virtual bool

Exec ( UWorld* InWorld,
const TCHAR* Cmd,
FOutputDevice& Ar
)

 Exec handler that allows the online subsystem to process exec commands
Public function Virtual Const IOnlineAchievementsPtr Get the interface for accessing online achievements
Public function Virtual Const IOnlineChatPtr Get the interface for user-user and user-room chat functionality
Public function Virtual Const IOnlineEntitlementsPtr Get the interface for accessing user entitlements
Public function Virtual Const IOnlineEventsPtr Get the interface for accessing online achievements
Public function Virtual Const IOnlineExternalUIPtr Get the interface for accessing the external UIs of a service
Public function Virtual Const IOnlineGameActivityPtr Get interface for accessing the game activity
Public function Virtual Const IOnlineGameItemStatsPtr Get interface for accessing the game item stats
Public function Virtual Const IOnlineGameMatchesPtr Get interface for accessing game matches
Public function Virtual Const IOnlineGroupsPtr IOnlineSubsystem.
Public function Virtual Const IOnlineIdentityPtr Get the interface for accessing identity online services
Public function Virtual Const FName Get the instance name, which is typically "default" or "none" but distinguishes one instance from another in "Play In Editor" mode.
Public function Virtual Const IOnlineLeaderboardsPtr Get the interface for accessing leaderboards/rankings of a service
Public function Virtual Const IOnlineMessagePtr Get the interface for accessing online messages
Public function Virtual Const IMessageSanitizerPtr

GetMessageSanitizer ( int32 LocalUserNum,
FString& OutAuthTypeToExclude
)

 Get the interface for accessing the message sanitizer service
Public function Virtual UObject *

GetNamedInterface ( FName InterfaceName
)

 Get custom UObject data preserved by the online subsystem
Public function Virtual Const EOnlineEnvironment::Type  
Public function Virtual Const FString  
Public function Virtual Const IOnlinePartyPtr Get the interface for accessing the player party services
Public function Virtual Const IOnlinePresencePtr Get the interface for managing rich presence information
Public function Virtual Const IOnlinePurchasePtr Get the interface for purchasing
Public function Virtual Const IOnlineSharedCloudPtr Get the interface for sharing user files in the cloud
Public function Virtual Const IOnlineSharingPtr Get the interface for accessing online sharing
Public function Virtual Const FText  
Public function Virtual Const IOnlineStatsPtr Get the interface for accessing online stats
Public function Virtual Const IOnlineStoreV2Ptr Get the interface for accessing an online store
Public function Virtual Const FName Return the name of the subsystem
Public function Virtual Const IOnlineTimePtr Get the interface for accessing the server time from an online service
Public function Virtual Const IOnlineTitleFilePtr Get the interface for accessing title file online services
Public function Virtual Const IOnlineTournamentPtr Get the interface for managing tournament information
Public function Virtual Const IOnlineTurnBasedPtr Get the interface for managing turn based multiplayer games
Public function Virtual Const IOnlineUserCloudPtr Get the interface for accessing user files in the cloud
Public function Virtual Const IOnlineUserPtr Get the interface for accessing online user information
Public function Virtual Const IOnlineVoicePtr Get the interface for accessing voice related data
Public function Virtual Const bool Is the online subsystem associated with the game/editor/engine running as dedicated.
Public function Virtual Const bool  
Public function Virtual Const bool

IsLocalPlayer ( const FUniqueNetId& UniqueId
)

 Is a player local to this machine by unique id
Public function Virtual Const bool Is this instance of the game running as a server (dedicated OR listen) checks the Engine if possible for netmode status
Public function Virtual void Perform any shutdown actions prior to any other modules being unloaded/shutdown
Public function Virtual void

ReloadConfigs ( const TSet< FString >& ConfigSections
)

 Reload the configuration if it is relevant for this OSS instance
Public function Virtual void

SetForceDedicated ( bool bForce
)

 Force the online subsystem to behave as if it's associated with running a dedicated server
Public function Virtual void

SetNamedInterface ( FName InterfaceName,
UObject* NewInterface
)

 Set a custom UObject to be preserved by the online subsystem
Public function Virtual void

SetUsingMultiplayerFeatures ( const FUniqueNetId& UniqueId,
bool bUsingMP
)

 Some platforms must know when the game is using Multiplayer features so they can do recurring authorization checks.
Public function Virtual bool Shutdown the underlying subsystem APIs

Overridden from FTSTickerObjectBase

  Type Name Description
Public function Virtual bool

Tick ( float DeltaTime
)

 FTSTickerObjectBase.

Constants

Name Description
DefaultInstanceName Name given to default OSS instances (disambiguates for PIE)

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page