FSessionInfo Class Reference

#include <SessionInfo.h>

Inheritance diagram for FSessionInfo:

Public Member Functions
	FSessionInfo (const FGuid &InSessionId, 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	GetInstances (TArray< TSharedPtr< ISessionInstanceInfo > > &OutInstances) const override
virtual const FDateTime &	GetLastUpdateTime () const override
virtual const int32	GetNumInstances () const override
virtual const FGuid &	GetSessionId () const override
virtual const FString &	GetSessionName () const override
virtual const FString &	GetSessionOwner () const override
virtual const bool	IsStandalone () const override
virtual FInstanceDiscoveredEvent &	OnInstanceDiscovered () override
virtual FLogReceivedEvent &	OnLogReceived () override
virtual void	Terminate () override
Public Member Functions inherited from TSharedFromThis< FSessionInfo >
TSharedRef< FSessionInfo, Mode >	AsShared ()
TSharedRef< FSessionInfo const, Mode >	AsShared () const
TSharedRef< SubobjectType, Mode >	AsSharedSubobject (SubobjectType *SubobjectPtr) const
TWeakPtr< FSessionInfo, Mode >	AsWeak ()
TWeakPtr< FSessionInfo 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 ISessionInfo
	DECLARE_EVENT_TwoParams (ISessionInfo, FInstanceDiscoveredEvent, const TSharedRef< ISessionInfo > &, const TSharedRef< ISessionInstanceInfo > &) virtual FInstanceDiscoveredEvent &OnInstanceDiscovered()=0
	DECLARE_EVENT_ThreeParams (ISessionInfo, FLogReceivedEvent, const TSharedRef< ISessionInfo > &, const TSharedRef< ISessionInstanceInfo > &, const TSharedRef< FSessionLogMessage > &)
virtual	~ISessionInfo ()

Additional Inherited Members
Protected Member Functions inherited from TSharedFromThis< FSessionInfo >
	TSharedFromThis ()
	TSharedFromThis (TSharedFromThis const &)
UE_FORCEINLINE_HINT TSharedFromThis &	operator= (TSharedFromThis const &)
	~TSharedFromThis ()
Static Protected Member Functions inherited from TSharedFromThis< FSessionInfo >
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 session

Constructor & Destructor Documentation

FSessionInfo()

FSessionInfo::FSessionInfo	(	const FGuid &	InSessionId,
		const TSharedRef< IMessageBus, ESPMode::ThreadSafe > &	InMessageBus
	)

Creates and initializes a new instance.

Parameters

InSessionId	The session's identifier.
InMessageBus	The message bus to use.

Member Function Documentation

GetInstances()

void FSessionInfo::GetInstances ( TArray< TSharedPtr< ISessionInstanceInfo > > &  OutInstances ) const

overridevirtual

Gets a read-only collection of all instances that belong to this session.

Parameters

OutInstances

Will hold the collection of instances.

Implements ISessionInfo.

GetLastUpdateTime()

const FDateTime & FSessionInfo::GetLastUpdateTime ( ) const

overridevirtual

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

Returns

The receive time.

Implements ISessionInfo.

GetNumInstances()

const int32 FSessionInfo::GetNumInstances ( ) const

overridevirtual

Gets the number of engine instances that are part of the session.

Returns

The number of engine instances.

Implements ISessionInfo.

GetSessionId()

const FGuid & FSessionInfo::GetSessionId ( ) const

overridevirtual

Gets the session identifier.

Returns

Session identifier.

Implements ISessionInfo.

GetSessionName()

const FString & FSessionInfo::GetSessionName ( ) const

overridevirtual

Gets the name of the session.

Returns

Session name.

Implements ISessionInfo.

GetSessionOwner()

const FString & FSessionInfo::GetSessionOwner ( ) const

overridevirtual

Gets the name of the user that owns the session.

Returns

User name.

Implements ISessionInfo.

IsStandalone()

const bool FSessionInfo::IsStandalone ( ) const

overridevirtual

Checks whether this is a standalone session.

A session is standalone if has not been created from the Launcher.

Returns

true if this is a standalone session, false otherwise.

Implements ISessionInfo.

OnInstanceDiscovered()

virtual FInstanceDiscoveredEvent & FSessionInfo::OnInstanceDiscovered ( )

inlineoverridevirtual

OnLogReceived()

virtual FLogReceivedEvent & FSessionInfo::OnLogReceived ( )

inlineoverridevirtual

Implements ISessionInfo.

Terminate()

void FSessionInfo::Terminate ( )

overridevirtual

Terminates the session.

Implements ISessionInfo.

UpdateFromMessage() [1/2]

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

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

Parameters

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

UpdateFromMessage() [2/2]

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

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

Parameters

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

---

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

• Engine/Source/Runtime/SessionServices/Private/SessionInfo.h
• Engine/Source/Runtime/SessionServices/Private/SessionInfo.cpp