Navigation
API > API/Runtime > API/Runtime/SessionServices
Interface for game instances.
| Name | ISessionInfo |
| Type | class |
| Header File | /Engine/Source/Runtime/SessionServices/Public/ISessionInfo.h |
| Include Path | #include "ISessionInfo.h" |
Syntax
class ISessionInfo
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~ISessionInfo() |
Virtual destructor. | ISessionInfo.h |
Classes
| Name | Remarks |
|---|---|
| FInstanceDiscoveredEvent | A delegate that is executed when a new instance has been discovered. |
| FLogReceivedEvent | A delegate that is executed when a new log message has been received. |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| OnInstanceDiscovered | ISessionInfo::FLogReceivedEvent & | ISessionInfo.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void GetInstances
(
TArray< TSharedPtr< ISessionInstanceInfo > >& OutInstances |
Gets a read-only collection of all instances that belong to this session. | ISessionInfo.h | |
const FDateTime & GetLastUpdateTime() |
Gets the time at which the last update was received from this instance. | ISessionInfo.h | |
const int32 GetNumInstances() |
Gets the number of engine instances that are part of the session. | ISessionInfo.h | |
const FGuid & GetSessionId() |
Gets the session identifier. | ISessionInfo.h | |
const FString & GetSessionName() |
Gets the name of the session. | ISessionInfo.h | |
const FString & GetSessionOwner() |
Gets the name of the user that owns the session. | ISessionInfo.h | |
const bool IsStandalone () |
Checks whether this is a standalone session. | ISessionInfo.h | |
ISessionInfo::FInstanceDiscoveredEvent TBaseMulticastDelegate_TwoParams OnInstanceDiscovered() |
ISessionInfo.h | ||
FLogReceivedEvent & OnLogReceived() |
ISessionInfo.h | ||
void Terminate() |
Terminates the session. | ISessionInfo.h |