Navigation
API > API/Developer > API/Developer/TraceAnalysis
Simple helper class for communicating with trace system of a running instance.
| Name | FControlClient |
| Type | class |
| Header File | /Engine/Source/Developer/TraceAnalysis/Public/Trace/ControlClient.h |
| Include Path | #include "Trace/ControlClient.h" |
Syntax
class FControlClient
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
~FControlClient() |
The destructor will ensure disconnection the FControlClient class goes out of scope. | Trace/ControlClient.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| Socket | FSocket * | Trace/ControlClient.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool Connect
(
const FInternetAddr& Address |
Initiates a connection to a runtime instance to control. | Trace/ControlClient.h | |
bool Connect
(
const TCHAR* Host, |
Initiates a connection to a runtime instance to control. | Trace/ControlClient.h | |
void Disconnect() |
Disconnects the client from the runtime. | Trace/ControlClient.h | |
bool IsConnected() |
Returns true if the client is currently connected to a runtime | Trace/ControlClient.h | |
void Send
(
const TCHAR* Command |
Sends a raw command to the instance. | Trace/ControlClient.h | |
void SendSendTo
(
const TCHAR* Host |
Tells the runtime to attempt to record its trace event log to a socket. | Trace/ControlClient.h | |
void SendStop() |
Tells the runtime to stop tracing. | Trace/ControlClient.h | |
void SendToggleChannel
(
const TCHAR* Channels, |
Toggles one or more channels on and off. | Trace/ControlClient.h | |
void SendWriteTo
(
const TCHAR* Path |
Tells the runtime to attempt to record its trace event log to a file. | Trace/ControlClient.h |