ISessionInfo Class Reference

#include <ISessionInfo.h>

Inheritance diagram for ISessionInfo:

Public Member Functions
virtual void	GetInstances (TArray< TSharedPtr< ISessionInstanceInfo > > &OutInstances) const =0
virtual const FDateTime &	GetLastUpdateTime () const =0
virtual const int32	GetNumInstances () const =0
virtual const FGuid &	GetSessionId () const =0
virtual const FString &	GetSessionName () const =0
virtual const FString &	GetSessionOwner () const =0
virtual const bool	IsStandalone () const =0
virtual void	Terminate ()=0
	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 FLogReceivedEvent &	OnLogReceived ()=0
virtual	~ISessionInfo ()

Detailed Description

Interface for game instances.

Constructor & Destructor Documentation

~ISessionInfo()

virtual ISessionInfo::~ISessionInfo ( )

inlinevirtual

Virtual destructor.

Member Function Documentation

DECLARE_EVENT_ThreeParams()

ISessionInfo::DECLARE_EVENT_ThreeParams	(	ISessionInfo	,
		FLogReceivedEvent	,
		const TSharedRef< ISessionInfo > &	,
		const TSharedRef< ISessionInstanceInfo > &	,
		const TSharedRef< FSessionLogMessage > &
	)

A delegate that is executed when a new log message has been received.

Returns

The delegate.

DECLARE_EVENT_TwoParams()

ISessionInfo::DECLARE_EVENT_TwoParams ( ISessionInfo  , FInstanceDiscoveredEvent  , const TSharedRef< ISessionInfo > &  , const TSharedRef< ISessionInstanceInfo > &    ) &

pure virtual

A delegate that is executed when a new instance has been discovered.

Returns

The delegate.

GetInstances()

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

pure virtual

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

Parameters

OutInstances

Will hold the collection of instances.

Implemented in FSessionInfo.

GetLastUpdateTime()

virtual const FDateTime & ISessionInfo::GetLastUpdateTime ( ) const

pure virtual

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

Returns

The receive time.

Implemented in FSessionInfo.

GetNumInstances()

virtual const int32 ISessionInfo::GetNumInstances ( ) const

pure virtual

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

Returns

The number of engine instances.

Implemented in FSessionInfo.

GetSessionId()

virtual const FGuid & ISessionInfo::GetSessionId ( ) const

pure virtual

Gets the session identifier.

Returns

Session identifier.

Implemented in FSessionInfo.

GetSessionName()

virtual const FString & ISessionInfo::GetSessionName ( ) const

pure virtual

Gets the name of the session.

Returns

Session name.

Implemented in FSessionInfo.

GetSessionOwner()

virtual const FString & ISessionInfo::GetSessionOwner ( ) const

pure virtual

Gets the name of the user that owns the session.

Returns

User name.

Implemented in FSessionInfo.

IsStandalone()

virtual const bool ISessionInfo::IsStandalone ( ) const

pure virtual

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.

Implemented in FSessionInfo.

OnLogReceived()

virtual FLogReceivedEvent & ISessionInfo::OnLogReceived ( )

pure virtual

Implemented in FSessionInfo.

Terminate()

virtual void ISessionInfo::Terminate ( )

pure virtual

Terminates the session.

Implemented in FSessionInfo.

---

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

• Engine/Source/Runtime/SessionServices/Public/ISessionInfo.h