#include <SessionInstanceInfo.h>

Inheritance diagram for FSessionInstanceInfo:

Public Member Functions
	FSessionInstanceInfo ()

virtual	~FSessionInstanceInfo ()

	FSessionInstanceInfo (const FGuid &InInstanceId, const TSharedRef< ISessionInfo > &InOwner, const TSharedRef< IMessageBus, ESPMode::ThreadSafe > &InMessageBus)

void	UpdateFromMessage (const FEngineServicePong &Message, const TSharedRef< IMessageContext, ESPMode::ThreadSafe > &Context)

void	UpdateFromMessage (const FSessionServicePong &Message, const TSharedRef< IMessageContext, ESPMode::ThreadSafe > &Context)

virtual void	ExecuteCommand (const FString &CommandString) override

virtual const FString &	GetBuildDate () const override

virtual const FString &	GetCurrentLevel () const override

virtual const FString &	GetDeviceName () const override

virtual int32	GetEngineVersion () const override

virtual const FGuid &	GetInstanceId () const override

virtual const FString &	GetInstanceName () const override

virtual const FString &	GetInstanceType () const override

virtual const FDateTime &	GetLastUpdateTime () const override

virtual const TArray< TSharedPtr< FSessionLogMessage > > &	GetLog () override

virtual TSharedPtr< ISessionInfo >	GetOwnerSession () override

virtual const FString &	GetPlatformName () const override

virtual float	GetWorldTimeSeconds () const override

virtual bool	IsAuthorized () const override

	DECLARE_DERIVED_EVENT (FSessionInstanceInfo, ISessionInstanceInfo::FLogReceivedEvent, FLogReceivedEvent)

virtual FLogReceivedEvent &	OnLogReceived () override

virtual bool	PlayHasBegun () const override

virtual void	Terminate () override

Public Member Functions inherited from TSharedFromThis< FSessionInstanceInfo >
TSharedRef< FSessionInstanceInfo, Mode >	AsShared ()

TSharedRef< FSessionInstanceInfo const, Mode >	AsShared () const

TSharedRef< SubobjectType, Mode >	AsSharedSubobject (SubobjectType *SubobjectPtr) const

TWeakPtr< FSessionInstanceInfo, Mode >	AsWeak ()

TWeakPtr< FSessionInstanceInfo const, Mode >	AsWeak () const

TWeakPtr< SubobjectType, Mode >	AsWeakSubobject (SubobjectType *SubobjectPtr) const

void	UpdateWeakReferenceInternal (TSharedPtr< SharedPtrType, SharedPtrMode > const InSharedPtr, OtherType InObject) const

void	UpdateWeakReferenceInternal (TSharedRef< SharedRefType, SharedPtrMode > const InSharedRef, OtherType InObject) const

UE_FORCEINLINE_HINT bool	DoesSharedInstanceExist () const

Public Member Functions inherited from ISessionInstanceInfo
	DECLARE_EVENT_TwoParams (ISessionInstanceInfo, FLogReceivedEvent, const TSharedRef< ISessionInstanceInfo > &, const TSharedRef< FSessionLogMessage > &)

virtual	~ISessionInstanceInfo ()

Additional Inherited Members
Protected Member Functions inherited from TSharedFromThis< FSessionInstanceInfo >
	TSharedFromThis ()

	TSharedFromThis (TSharedFromThis const &)

UE_FORCEINLINE_HINT TSharedFromThis &	operator= (TSharedFromThis const &)

	~TSharedFromThis ()

Static Protected Member Functions inherited from TSharedFromThis< FSessionInstanceInfo >
static UE_FORCEINLINE_HINT TSharedRef< OtherType, Mode >	SharedThis (OtherType *ThisPtr)

static UE_FORCEINLINE_HINT TSharedRef< OtherType const, Mode >	SharedThis (const OtherType *ThisPtr)

Detailed Description

Implements a class to maintain all info related to a game instance in a session

Constructor & Destructor Documentation

◆ FSessionInstanceInfo() [1/2]

FSessionInstanceInfo::FSessionInstanceInfo ( )

inline

Default constructor.

◆ ~FSessionInstanceInfo()

FSessionInstanceInfo::~FSessionInstanceInfo ( )

virtual

Destructor.

◆ FSessionInstanceInfo() [2/2]

FSessionInstanceInfo::FSessionInstanceInfo	(	const FGuid &	InInstanceId,
		const TSharedRef< ISessionInfo > &	InOwner,
		const TSharedRef< IMessageBus, ESPMode::ThreadSafe > &	InMessageBus
	)

Creates and initializes a new instance.

Parameters

InInstanceId	The instance's identifier.
InOwner	The session that owns this instance.
InMessageBus	The message bus to use.

Member Function Documentation

◆ DECLARE_DERIVED_EVENT()

FSessionInstanceInfo::DECLARE_DERIVED_EVENT	(	FSessionInstanceInfo	,
		ISessionInstanceInfo::FLogReceivedEvent	,
		FLogReceivedEvent
	)

◆ ExecuteCommand()

void FSessionInstanceInfo::ExecuteCommand ( const FString & CommandString )

overridevirtual

Executes a console command on this engine instance.

Parameters

CommandString The command to execute.

Implements ISessionInstanceInfo.

◆ GetBuildDate()

virtual const FString & FSessionInstanceInfo::GetBuildDate ( ) const

inlineoverridevirtual

Gets instance's build date.

Returns: The build date string.

Implements ISessionInstanceInfo.

◆ GetCurrentLevel()

virtual const FString & FSessionInstanceInfo::GetCurrentLevel ( ) const

inlineoverridevirtual

Gets the name of the level that the instance is currently running.

Returns: The name of the level.

Implements ISessionInstanceInfo.

◆ GetDeviceName()

virtual const FString & FSessionInstanceInfo::GetDeviceName ( ) const

inlineoverridevirtual

Gets the name of the device that this instance is running on.

Returns: The device name string.

Implements ISessionInstanceInfo.

◆ GetEngineVersion()

virtual int32 FSessionInstanceInfo::GetEngineVersion ( ) const

inlineoverridevirtual

Gets the instance's engine version number.

Returns: Engine version.

Implements ISessionInstanceInfo.

◆ GetInstanceId()

virtual const FGuid & FSessionInstanceInfo::GetInstanceId ( ) const

inlineoverridevirtual

Gets the instance identifier.

Returns: Instance identifier.

Implements ISessionInstanceInfo.

◆ GetInstanceName()

virtual const FString & FSessionInstanceInfo::GetInstanceName ( ) const

inlineoverridevirtual

Gets the name of this instance.

Returns: The instance name string.

Implements ISessionInstanceInfo.

◆ GetInstanceType()

virtual const FString & FSessionInstanceInfo::GetInstanceType ( ) const

inlineoverridevirtual

Gets the instance type (i.e. Editor or Game).

Returns: The game instance type string.

Implements ISessionInstanceInfo.

◆ GetLastUpdateTime()

virtual const FDateTime & FSessionInstanceInfo::GetLastUpdateTime ( ) const

inlineoverridevirtual

Gets the time at which the last update was received from this instance.

Returns: The receive time.

Implements ISessionInstanceInfo.

◆ GetLog()

virtual const TArray< TSharedPtr< FSessionLogMessage > > & FSessionInstanceInfo::GetLog ( )

inlineoverridevirtual

Gets the collection of log entries received from this instance.

Returns: Log entries.

Implements ISessionInstanceInfo.

◆ GetOwnerSession()

virtual TSharedPtr< ISessionInfo > FSessionInstanceInfo::GetOwnerSession ( )

inlineoverridevirtual

Gets a reference to the session that owns this instance.

Returns: Owner session.

Implements ISessionInstanceInfo.

◆ GetPlatformName()

virtual const FString & FSessionInstanceInfo::GetPlatformName ( ) const

inlineoverridevirtual

Gets the name of the platform that the instance is running on.

Returns: Platform name string.

Implements ISessionInstanceInfo.

◆ GetWorldTimeSeconds()

virtual float FSessionInstanceInfo::GetWorldTimeSeconds ( ) const

inlineoverridevirtual

Gets the instance's current game world time.

Returns: World time in seconds.

Implements ISessionInstanceInfo.

◆ IsAuthorized()

virtual bool FSessionInstanceInfo::IsAuthorized ( ) const

inlineoverridevirtual

Check whether the current user is authorized to interact with this instance.

Returns: true if the user is authorized, false otherwise.

Implements ISessionInstanceInfo.

◆ OnLogReceived()

virtual FLogReceivedEvent & FSessionInstanceInfo::OnLogReceived ( )

inlineoverridevirtual

Implements ISessionInstanceInfo.

◆ PlayHasBegun()

virtual bool FSessionInstanceInfo::PlayHasBegun ( ) const

inlineoverridevirtual

Checks whether this instance has already begun game play.

Returns: true if game play has begun, false otherwise.

Implements ISessionInstanceInfo.

◆ Terminate()

void FSessionInstanceInfo::Terminate ( )

overridevirtual

Terminates the instance.

Implements ISessionInstanceInfo.

◆ UpdateFromMessage() [1/2]

void FSessionInstanceInfo::UpdateFromMessage	(	const FEngineServicePong &	Message,
		const TSharedRef< IMessageContext, ESPMode::ThreadSafe > &	Context
	)

Updates this instance info with the data in the specified message.

Parameters

Message	The message containing engine information.
Context	The message context.

◆ UpdateFromMessage() [2/2]

void FSessionInstanceInfo::UpdateFromMessage	(	const FSessionServicePong &	Message,
		const TSharedRef< IMessageContext, ESPMode::ThreadSafe > &	Context
	)

Updates this instance info with the data in the specified message.

Parameters

Message	The message containing instance information.
Context	The message context.

The documentation for this class was generated from the following files:

Engine/Source/Runtime/SessionServices/Private/SessionInstanceInfo.h
Engine/Source/Runtime/SessionServices/Private/SessionInstanceInfo.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FSessionInstanceInfo() [1/2]

◆ ~FSessionInstanceInfo()

◆ FSessionInstanceInfo() [2/2]

Member Function Documentation

◆ DECLARE_DERIVED_EVENT()

◆ ExecuteCommand()

◆ GetBuildDate()

◆ GetCurrentLevel()

◆ GetDeviceName()

◆ GetEngineVersion()

◆ GetInstanceId()

◆ GetInstanceName()

◆ GetInstanceType()

◆ GetLastUpdateTime()

◆ GetLog()

◆ GetOwnerSession()

◆ GetPlatformName()

◆ GetWorldTimeSeconds()

◆ IsAuthorized()

◆ OnLogReceived()

◆ PlayHasBegun()

◆ Terminate()

◆ UpdateFromMessage() [1/2]

◆ UpdateFromMessage() [2/2]