FControlClient

Simple helper class for communicating with trace system of a running instance.

Unreal Engine C++ API Reference > Developer > TraceAnalysis > Trace

References

   
Module TraceAnalysis
Header /Engine/Source/Developer/TraceAnalysis/Public/Trace/ControlClient.h
Include #include "Trace/ControlClient.h"

Syntax

class FControlClient  

Remarks

Simple helper class for communicating with trace system of a running instance.

Destructors

Type Name Description
  ~FControlClient () The destructor will ensure disconnection the FControlClient class goes out of scope.

Functions

Type Name Description
bool Connect ( const FInternetAddr& Address ) Initiates a connection to a runtime instance to control.
bool Connect ( const TCHAR* Host, uint16 Port ) Initiates a connection to a runtime instance to control.
void Disconnect () Disconnects the client from the runtime.
bool IsConnected () Returns true if the client is currently connected to a runtime
void Send ( const TCHAR* Command ) Sends a raw command to the instance.
void SendSendTo ( const TCHAR* Host ) Tells the runtime to attempt to record its trace event log to a socket.
void SendStop () Tells the runtime to stop tracing.
void SendToggleChannel ( const TCHAR* Channels, bool bState ) Toggles one or more channels on and off.
void SendWriteTo ( const TCHAR* Path ) Tells the runtime to attempt to record its trace event log to a file.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library