IMessageTracer

Interface for message tracers.

Choose your operating system:

Windows

macOS

Linux

References

Module

Messaging

Header

/Engine/Source/Runtime/Messaging/Public/IMessageTracer.h

Include

#include "IMessageTracer.h"

Syntax

class IMessageTracer

Remarks

Interface for message tracers.

This interface provides access to the message tracer that is built into a message bus. Message tracers are able to monitor and record all activities on a message bus. This includes the sending and receiving of messages, the registering and unregistering of message endpoints and interceptors and adding and removal of subscriptions.

Destructors

Name Description

Protected function Virtual

~IMessageTracer()

Hidden destructor. The life time of a message tracer is managed by the message bus.

Functions

Name Description

Public function

void

 

Break()

Breaks message routing.

Public function

void

 

Continue()

Starts the tracer or continues message routing from the current breakpoint.

Public function Const

int32

 

GetEndpoints

Gets the list of known message endpoints.

Public function Const

int32

 

GetMessages

Gets the collection of known messages.

Public function Const

int32

 

GetMessageTypes

Gets the list of known message types filtered by name.

Public function Const

bool

 

HasMessages()

Checks whether there are any messages in the history.

Public function Const

bool

 

IsBreaking()

Checks whether the tracer is currently at a breakpoint.

Public function Const

bool

 

IsRunning()

Checks whether the tracer is currently running.

Public function

IMessageTrac...

 

OnMessageAdded()

Public function

IMessageTrac...

 

OnMessagesReset()

Public function

IMessageTrac...

 

OnTypeAdded()

Public function

void

 

Reset()

Resets the tracer.

Public function

void

 

Step()

Steps the tracer to the next message.

Public function

void

 

Stop()

Stops the tracer.

Public function

bool

 

Tick

(
    float DeltaTime
)

Ticks the tracer.

Classes

Name

Description

Public class

FOnMessageAdded

A delegate that is executed when the collection of known messages has changed.

Public class

FOnMessagesReset

A delegate that is executed when the message history has been reset.

Public class

FOnTypeAdded

A delegate that is executed when the collection of known messages types has changed.

Typedefs