ISessionManager

Interface for the session manager.

Windows
MacOS
Linux

References

Module

SessionServices

Header

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

Include

#include "ISessionManager.h"

Syntax

class ISessionManager

Remarks

Interface for the session manager.

Variables

Destructors

Name Description

Public function Virtual

~ISessionManager()

Virtual destructor.

Functions

Name Description

Public function

void

 

AddOwner

(
    const FString& InOwner
)

Adds an owner whose sessions we are interested in

Public function Const

const TArray...

 

GetSelectedInstances()

Gets the collection of currently selected engine instances.

Public function Const

const TShare...

 

GetSelectedSession()

Get the selected session - as chosen in the session browser

Public function Const

void

 

GetSessions

(
    TArray< TSharedPtr< ISessionInfo >>...
)

Gets the list of all discovered sessions.

Public function Const

bool

 

IsInstanceSelected

(
    const TSharedRef< ISessionInstanceI...
)

Checks whether the given instance is currently selected.

Public function

ISessionMana...

 

OnCanSelectSession()

Public function

ISessionMana...

 

OnInstanceSelectionChanged()

Public function

FLogReceived...

 

OnLogReceived()

Public function

ISessionMana...

 

OnSelectedSessionChanged()

Public function

FSimpleMulti...

 

OnSessionInstanceUpdated()

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

Public function

FSimpleMulti...

 

OnSessionsUpdated()

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

Public function

void

 

RemoveOwner

(
    const FString& InOwner
)

Removes an owner whose sessions we are no longer interested in

Public function

bool

 

SelectSession

(
    const TSharedPtr< ISessionInfo >& ...
)

Selects the specified session.

Public function

bool

 

SetInstanceSelected

(
    const TSharedRef< ISessionInstanceI...,
    bool Selected
)

Marks the specified item as selected or unselected.

Classes

Name

Description

Public class

FCanSelectSessionEvent

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

Public class

FInstanceSelectionChangedEvent

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

Public class

FLogReceivedEvent

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

Public class

FSelectedSessionChangedEvent

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

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss