FControlClient

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

Windows
MacOS
Linux

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

Name Description

Public function

~FControlClient()

The destructor will ensure disconnection the FControlClient class goes out of scope.

Functions

Name Description

Public function

bool

 

Connect

(
    const FInternetAddr& Address
)

Initiates a connection to a runtime instance to control.

Public function

bool

 

Connect

(
    const TCHAR* Host,
    uint16 Port
)

Initiates a connection to a runtime instance to control.

Public function

void

 

Disconnect()

Disconnects the client from the runtime.

Public function Const

bool

 

IsConnected()

Returns true if the client is currently connected to a runtime

Public function

void

 

Send

(
    const TCHAR* Command
)

Sends a raw command to the instance.

Public function

void

 

SendSendTo

(
    const TCHAR* Host
)

Tells the runtime to attempt to record its trace event log to a socket.

Public function

void

 

SendToggleChannel

(
    const TCHAR* Channels,
    bool bState
)

Toggles one or more channels on and off.

Public function

void

 

SendWriteTo

(
    const TCHAR* Path
)

Tells the runtime to attempt to record its trace event log to a file.
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss