Navigation
API > API/Runtime > API/Runtime/Messaging
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.
| Name | IMessageTracer |
| Type | class |
| Header File | /Engine/Source/Runtime/Messaging/Public/IMessageTracer.h |
| Include Path | #include "IMessageTracer.h" |
Syntax
class IMessageTracer
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~IMessageTracer() |
Hidden destructor. The life time of a message tracer is managed by the message bus. | IMessageTracer.h |
Classes
| Name | Remarks |
|---|---|
| FOnMessageAdded | A delegate that is executed when the collection of known messages has changed. |
| FOnMessagesReset | A delegate that is executed when the message history has been reset. |
| FOnTypeAdded | A delegate that is executed when the collection of known messages types has changed. |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FMessageTracerMessageInfoRef | TSharedRef< FMessageTracerMessageInfo > | IMessageTracer.h | |
| FMessageTracerTypeInfoRef | TSharedRef< FMessageTracerTypeInfo > | IMessageTracer.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void Break () |
Breaks message routing. | IMessageTracer.h | |
void Continue () |
Starts the tracer or continues message routing from the current breakpoint. | IMessageTracer.h | |
int32 GetEndpoints
(
TArray< TSharedPtr< FMessageTracerEndpointInfo > >& OutEndpoints |
Gets the list of known message endpoints. | IMessageTracer.h | |
int32 GetMessages
(
TArray< TSharedPtr< FMessageTracerMessageInfo > >& OutMessages |
Gets the collection of known messages. | IMessageTracer.h | |
int32 GetMessageTypes
(
TArray< TSharedPtr< FMessageTracerTypeInfo > >& OutTypes |
Gets the list of known message types filtered by name. | IMessageTracer.h | |
bool HasMessages() |
Checks whether there are any messages in the history. | IMessageTracer.h | |
bool IsBreaking () |
Checks whether the tracer is currently at a breakpoint. | IMessageTracer.h | |
bool IsRunning () |
Checks whether the tracer is currently running. | IMessageTracer.h | |
IMessageTracer::FOnMessageAdded TBaseMulticastDelegate_OneParam OnMessageAdded() |
IMessageTracer.h | ||
IMessageTracer::FOnMessagesReset TBaseMulticastDelegate_NoParams OnMessagesReset() |
IMessageTracer.h | ||
IMessageTracer::FOnTypeAdded TBaseMulticastDelegate_OneParam OnTypeAdded() |
IMessageTracer.h | ||
void Reset() |
Resets the tracer. | IMessageTracer.h | |
void Step () |
Steps the tracer to the next message. | IMessageTracer.h | |
void Stop () |
Stops the tracer. | IMessageTracer.h | |
bool Tick
(
float DeltaTime |
Ticks the tracer. | IMessageTracer.h |