Navigation
API > API/Runtime > API/Runtime/ChaosSolverEngine
Object that is able to discover, issue and execute commands back and forth between CVD and client/server/editor instances
| Name | FChaosVDRemoteSessionsManager |
| Type | class |
| Header File | /Engine/Source/Runtime/Experimental/ChaosSolverEngine/Public/Chaos/ChaosVDRemoteSessionsManager.h |
| Include Path | #include "Chaos/ChaosVDRemoteSessionsManager.h" |
Syntax
class FChaosVDRemoteSessionsManager
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FChaosVDRemoteSessionsManager() |
Chaos/ChaosVDRemoteSessionsManager.h |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| AllRemoteClientsTargetName | const FString | Chaos/ChaosVDRemoteSessionsManager.h | |
| AllRemoteClientsWrapperGUID | const FGuid | Chaos/ChaosVDRemoteSessionsManager.h | |
| AllRemoteServersTargetName | const FString | Chaos/ChaosVDRemoteSessionsManager.h | |
| AllRemoteServersWrapperGUID | const FGuid | Chaos/ChaosVDRemoteSessionsManager.h | |
| AllRemoteSessionsTargetName | const FString | Chaos/ChaosVDRemoteSessionsManager.h | |
| AllRemoteSessionsWrapperGUID | const FGuid | Chaos/ChaosVDRemoteSessionsManager.h | |
| AllSessionsTargetName | const FString | Chaos/ChaosVDRemoteSessionsManager.h | |
| AllSessionsWrapperGUID | const FGuid | Chaos/ChaosVDRemoteSessionsManager.h | |
| CustomSessionsTargetName | const FString | Chaos/ChaosVDRemoteSessionsManager.h | |
| CustomSessionsWrapperGUID | const FGuid | Chaos/ChaosVDRemoteSessionsManager.h | |
| InvalidSessionGUID | const FGuid | Chaos/ChaosVDRemoteSessionsManager.h | |
| LocalEditorSessionID | const FGuid | Chaos/ChaosVDRemoteSessionsManager.h | |
| LocalEditorSessionName | const FString | Chaos/ChaosVDRemoteSessionsManager.h | |
| MessageBusEndPointName | const FName | Chaos/ChaosVDRemoteSessionsManager.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| ActiveSessionsByInstanceId | TMap< FGuid, TSharedPtr< FChaosVDSessionInfo > > | Chaos/ChaosVDRemoteSessionsManager.h | ||
| LastPingTime | FDateTime | Holds the time at which the last ping was sent. | Chaos/ChaosVDRemoteSessionsManager.h | |
| MessageBusPtr | TWeakPtr< IMessageBus > | Holds a pointer to the message bus. | Chaos/ChaosVDRemoteSessionsManager.h | |
| MessageEndpoint | TSharedPtr< FMessageEndpoint > | Holds the messaging endpoint. | Chaos/ChaosVDRemoteSessionsManager.h | |
| PendingRecordingStatusMessages | TMap< FGuid, FChaosVDRecordingStatusMessage > | Chaos/ChaosVDRemoteSessionsManager.h | ||
| RecordingStartedDelegate | FChaosVDRecordingStateChangeDelegate | Chaos/ChaosVDRemoteSessionsManager.h | ||
| RecordingStoppedDelegate | FChaosVDRecordingStateChangeDelegate | Chaos/ChaosVDRemoteSessionsManager.h | ||
| SessionsUpdatedDelegate | FSimpleMulticastDelegate | Chaos/ChaosVDRemoteSessionsManager.h | ||
| TickHandle | FTSTicker::FDelegateHandle | Chaos/ChaosVDRemoteSessionsManager.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void EnumerateActiveSessions
(
const CallbackType& Callback |
Iterates trough all active and valid cvd sessions, and executes the provided callback to it. | Chaos/ChaosVDRemoteSessionsManager.h | |
TWeakPtr< FChaosVDSessionInfo > GetSessionInfo
(
FGuid Id |
Returns the session info object for the provided ID | Chaos/ChaosVDRemoteSessionsManager.h | |
void Initialize() |
Chaos/ChaosVDRemoteSessionsManager.h | ||
FChaosVDRecordingStateChangeDelegate & OnSessionRecordingStarted() |
Delegate that broadcast when a recording was started in a session (either local or remote) | Chaos/ChaosVDRemoteSessionsManager.h | |
FChaosVDRecordingStateChangeDelegate & OnSessionRecordingStopped() |
Delegate that broadcast when a recording stops in a session (either local or remote) | Chaos/ChaosVDRemoteSessionsManager.h | |
FSimpleMulticastDelegate & OnSessionsUpdated() |
Chaos/ChaosVDRemoteSessionsManager.h | ||
void PublishDataChannelStateChangeUpdate
(
const FChaosVDChannelStateChangeResponseMessage& InNewStateData |
Broadcast to the network a data channel state update | Chaos/ChaosVDRemoteSessionsManager.h | |
void PublishRecordingStatusUpdate
(
const FChaosVDRecordingStatusMessage& UpdateMessage |
Broadcast to the network a recording state update | Chaos/ChaosVDRemoteSessionsManager.h | |
void SendDataChannelStateChangeCommand
(
const FMessageAddress& InDestinationAddress, |
Issues a command to the provided address to change the state of a data channel | Chaos/ChaosVDRemoteSessionsManager.h | |
void SendStartRecordingCommand
(
const FMessageAddress& InDestinationAddress, |
Issues a command to the provided address that will start a CVD recording | Chaos/ChaosVDRemoteSessionsManager.h | |
void SendStopRecordingCommand
(
const FMessageAddress& InDestinationAddress |
Issues a command to the provided address to stop a CVD recording | Chaos/ChaosVDRemoteSessionsManager.h | |
void Shutdown() |
Chaos/ChaosVDRemoteSessionsManager.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static bool IsController() |
Returns true if this instance has controller capabilities (is either an editor or CVD Standalone, which is also an editor) | Chaos/ChaosVDRemoteSessionsManager.h |