Navigation
API > API/Plugins > API/Plugins/ConcertInsightsCore
Manages synchronized traces.
This listens for remote requests for starting traces. Intended to be subclassed.
| Name | FTraceControls |
| Type | class |
| Header File | /Engine/Plugins/Developer/Concert/ConcertInsights/ConcertInsightsCore/Source/ConcertInsightsCore/Public/TraceControls.h |
| Include Path | #include "TraceControls.h" |
Syntax
class FTraceControls : public FNoncopyable
Inheritance Hierarchy
- FNoncopyable → FTraceControls
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FTraceControls() |
TraceControls.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FTraceControls() |
TraceControls.h |
Classes
| Name | Remarks |
|---|---|
| FOnSynchronizedTraceStarted | |
| FOnSynchronizedTraceStopped |
Structs
| Name | Remarks |
|---|---|
| FSynchronizedSessionData |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| InProgressSynchronizedTrace | TOptional< FSynchronizedSessionData > | Data for the currently running synchronized trace. Unset if not running. | TraceControls.h | |
| OnSynchronizedTraceStartedDelegate | FOnSynchronizedTraceStarted | TraceControls.h | ||
| OnSynchronizedTraceStoppedDelegate | FOnSynchronizedTraceStopped | TraceControls.h | ||
| RegisteredSessions | TSet< TWeakPtr< IConcertSession > > | Sessions these controls are listening for requests on. | TraceControls.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FStartTraceArgs GetDefaultSynchronizedTraceArgs() |
Gets the default trace arguments to use | TraceControls.h | |
bool IsInSynchronizedTrace() |
TraceControls.h | ||
bool IsTracing() |
Whether a trace is currently occuring | TraceControls.h | |
FOnSynchronizedTraceStarted & OnSynchronizedTraceStarted() |
Broadcasts when a synchronized trace is started for any reason, such as the local machine starting it or a remote request being accepted. | TraceControls.h | |
FOnSynchronizedTraceStopped & OnSynchronizedTraceStopped() |
Broadcasts when a synchronized trace is stopped for any reason, such as the local machine stopping it or being told so by a remote request. | TraceControls.h | |
bool StartSynchronizedTrace
(
TSharedRef< IConcertSession > Session, |
TraceControls.h | ||
bool StartSynchronizedTrace
(
TSharedRef< IConcertSession > Session, |
Starts a synchronized trace across multiple endpoints. | TraceControls.h | |
void StopSynchronizedTrace() |
Stops a synchronized trace if one is ongoing. | TraceControls.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool CanSendRequestsToEndpoint
(
const FGuid& EndpointId, |
TraceControls.h | ||
FInitArgs GetInitEventArgs() |
Checks whether joining a trace is ok and if so, return the data to put into the ConcertInsights init event. | TraceControls.h | |
void OnLeaveSession
(
IConcertSession& Session |
Called by subclasses to notify that the local application has left the session. | TraceControls.h | |
virtual void OnSynchronizedTraceAccepted
(
const FConcertSessionContext& Context, |
Called when an incoming synchronized trace was accepted. | TraceControls.h | |
void RegisterTraceRequestsHandler
(
const TSharedRef< IConcertSession >& Session |
Registers handlers for trace requests. | TraceControls.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static TUniquePtr< TControls > Make
(
TArgs&&... Arg |
TraceControls.h |