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 : public UE::TraceBasedDebuggers::FRemoteSessionsManager
Inheritance Hierarchy
- FSharedFromThisBase → TSharedFromThis → FRemoteSessionsManager → FChaosVDRemoteSessionsManager
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FChaosVDRemoteSessionsManager() |
Chaos/ChaosVDRemoteSessionsManager.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| ActiveSessionsByInstanceId | TMap< FGuid, TSharedPtr< FChaosVDSessionInfo > > | Chaos/ChaosVDRemoteSessionsManager.h | ||
| RecordingStartedDelegate | FChaosVDRecordingStateChangeDelegate | Chaos/ChaosVDRemoteSessionsManager.h | ||
| RecordingStoppedDelegate | FChaosVDRecordingStateChangeDelegate | Chaos/ChaosVDRemoteSessionsManager.h | ||
| SessionDiscoveredDelegate | FChaosVDSessionDiscoverDelegate | Chaos/ChaosVDRemoteSessionsManager.h | ||
| SessionExpiredDelegate | FChaosVDSessionDiscoverDelegate | Chaos/ChaosVDRemoteSessionsManager.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void EnumerateActiveSessions
(
const CallbackType& Callback |
Iterates through all active and valid cvd sessions, and executes the provided callback to it. | Chaos/ChaosVDRemoteSessionsManager.h | |
TWeakPtr< FChaosVDSessionInfo > GetFirstAvailableSingleSessionInfo() |
Returns the first available session info | Chaos/ChaosVDRemoteSessionsManager.h | |
| Returns the session info object for the provided ID | Chaos/ChaosVDRemoteSessionsManager.h | ||
void Initialize
(
const TSharedPtr< IMessageBus >& InMessageBus |
Chaos/ChaosVDRemoteSessionsManager.h | ||
FChaosVDSessionDiscoverDelegate & OnSessionDiscovered() |
Chaos/ChaosVDRemoteSessionsManager.h | ||
FChaosVDSessionDiscoverDelegate & OnSessionExpired() |
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 | |
void PublishDataChannelStateChangeUpdate
(
const FChaosVDChannelStateChangeResponseMessage& InNewStateData |
Broadcast to the network a data channel state update | Chaos/ChaosVDRemoteSessionsManager.h | |
void PublishRecordingStatusUpdate
(
const FChaosVDRecordingStatusMessage& InUpdateMessage |
Broadcast to the network a recording state update | Chaos/ChaosVDRemoteSessionsManager.h | |
void PublishTraceConnectionDetailsUpdate
(
const FChaosVDTraceConnectionDetailsMessage& InUpdateMessage |
Broadcast to the network new trace connection details as they become available | 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 |