ISessionManager Class Reference

#include <ISessionManager.h>

Inheritance diagram for ISessionManager:

Public Member Functions
virtual void	AddOwner (const FString &InOwner)=0
virtual const TArray< TSharedPtr< ISessionInstanceInfo > > &	GetSelectedInstances () const =0
virtual const TSharedPtr< ISessionInfo > &	GetSelectedSession () const =0
virtual void	GetSessions (TArray< TSharedPtr< ISessionInfo > > &OutSessions) const =0
virtual TSharedPtr< ISessionInstanceInfo >	GetInstance (const FGuid &Id) const =0
virtual bool	IsInstanceSelected (const TSharedRef< ISessionInstanceInfo > &Instance) const =0
virtual void	RemoveOwner (const FString &InOwner)=0
virtual bool	SelectSession (const TSharedPtr< ISessionInfo > &Session)=0
virtual bool	SetInstanceSelected (const TSharedRef< ISessionInstanceInfo > &Instance, bool Selected)=0
	DECLARE_EVENT_TwoParams (ISessionManager, FCanSelectSessionEvent, const TSharedPtr< ISessionInfo > &, bool &) virtual FCanSelectSessionEvent &OnCanSelectSession()=0
	DECLARE_EVENT_TwoParams (ISessionManager, FInstanceSelectionChangedEvent, const TSharedPtr< ISessionInstanceInfo > &, bool) virtual FInstanceSelectionChangedEvent &OnInstanceSelectionChanged()=0
	DECLARE_EVENT_ThreeParams (ISessionManager, FLogReceivedEvent, const TSharedRef< ISessionInfo > &, const TSharedRef< ISessionInstanceInfo > &, const TSharedRef< FSessionLogMessage > &)
virtual FLogReceivedEvent &	OnLogReceived ()=0
	DECLARE_EVENT_OneParam (ISessionManager, FSelectedSessionChangedEvent, const TSharedPtr< ISessionInfo > &) virtual FSelectedSessionChangedEvent &OnSelectedSessionChanged()=0
virtual FSimpleMulticastDelegate &	OnSessionsUpdated ()=0
virtual FSimpleMulticastDelegate &	OnSessionInstanceUpdated ()=0
virtual	~ISessionManager ()

Detailed Description

Interface for the session manager.

Constructor & Destructor Documentation

~ISessionManager()

virtual ISessionManager::~ISessionManager ( )

inlinevirtual

Virtual destructor.

Member Function Documentation

AddOwner()

virtual void ISessionManager::AddOwner ( const FString &  InOwner )

pure virtual

Adds an owner whose sessions we are interested in

Parameters

InOwner

Session owner we want to view sessions from

Implemented in FSessionManager.

DECLARE_EVENT_OneParam()

ISessionManager::DECLARE_EVENT_OneParam ( ISessionManager  , FSelectedSessionChangedEvent  , const TSharedPtr< ISessionInfo > &    ) &

pure virtual

Returns a delegate that is executed when the selected session changed.

Returns

The delegate.

DECLARE_EVENT_ThreeParams()

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

Returns a delegate that is executed when the selected session received a log message from one of its instances.

Returns

The delegate.

DECLARE_EVENT_TwoParams() [1/2]

ISessionManager::DECLARE_EVENT_TwoParams ( ISessionManager  , FCanSelectSessionEvent  , const TSharedPtr< ISessionInfo > &  , bool &    ) &

pure virtual

Returns a delegate that is executed before a session is being selected.

Returns

The delegate.

DECLARE_EVENT_TwoParams() [2/2]

ISessionManager::DECLARE_EVENT_TwoParams ( ISessionManager  , FInstanceSelectionChangedEvent  , const TSharedPtr< ISessionInstanceInfo > &  , bool    ) &

pure virtual

Returns a delegate that is executed when an instance changes its selection state.

Returns

The delegate.

GetInstance()

virtual TSharedPtr< ISessionInstanceInfo > ISessionManager::GetInstance ( const FGuid &  Id ) const

pure virtual

Attempts to retrieve an instance by it's unique instance id.

Parameters

Id	Instance id

Returns

Instance if it exist, otherwise a nullptr

GetSelectedInstances()

virtual const TArray< TSharedPtr< ISessionInstanceInfo > > & ISessionManager::GetSelectedInstances ( ) const

pure virtual

Gets the collection of currently selected engine instances.

Returns

The selected instances.

Implemented in FSessionManager.

GetSelectedSession()

virtual const TSharedPtr< ISessionInfo > & ISessionManager::GetSelectedSession ( ) const

pure virtual

Get the selected session - as chosen in the session browser

Returns

The session ID selected

Implemented in FSessionManager.

GetSessions()

virtual void ISessionManager::GetSessions ( TArray< TSharedPtr< ISessionInfo > > &  OutSessions ) const

pure virtual

Gets the list of all discovered sessions.

Parameters

OutSessions

Will hold the collection of sessions.

Implemented in FSessionManager.

IsInstanceSelected()

virtual bool ISessionManager::IsInstanceSelected ( const TSharedRef< ISessionInstanceInfo > &  Instance ) const

pure virtual

Checks whether the given instance is currently selected.

Returns

true if the instance is selected, false otherwise.

Implemented in FSessionManager.

OnLogReceived()

virtual FLogReceivedEvent & ISessionManager::OnLogReceived ( )

pure virtual

Implemented in FSessionManager.

OnSessionInstanceUpdated()

virtual FSimpleMulticastDelegate & ISessionManager::OnSessionInstanceUpdated ( )

pure virtual

Returns a delegate that is executed when a session instance is updated.

Returns

The delegate.

Implemented in FSessionManager.

OnSessionsUpdated()

virtual FSimpleMulticastDelegate & ISessionManager::OnSessionsUpdated ( )

pure virtual

Returns a delegate that is executed when the list of sessions has changed.

Returns

The delegate.

Implemented in FSessionManager.

RemoveOwner()

virtual void ISessionManager::RemoveOwner ( const FString &  InOwner )

pure virtual

Removes an owner whose sessions we are no longer interested in

Parameters

InOwner

Session owner we want to remove

Implemented in FSessionManager.

SelectSession()

virtual bool ISessionManager::SelectSession ( const TSharedPtr< ISessionInfo > &  Session )

pure virtual

Selects the specified session.

Parameters

Session

The session to the select (can be NULL to select none).

Returns

true if the session was selected, false otherwise.

Implemented in FSessionManager.

SetInstanceSelected()

virtual bool ISessionManager::SetInstanceSelected ( const TSharedRef< ISessionInstanceInfo > &  Instance, bool  Selected  )

pure virtual

Marks the specified item as selected or unselected.

Parameters

Instance	The instance to mark.
Selected	Whether the instance should be selected (true) or unselected (false).

Returns

true if the instance was selected, false otherwise.

Implemented in FSessionManager.

---

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

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