Navigation
API > API/Runtime > API/Runtime/Messaging
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
| Type | Name | Description | |
|---|---|---|---|
  |
Hidden destructor. The life time of a message tracer is managed by the message bus. |
Functions
| Type | Name | Description | |
|---|---|---|---|
 |
void | Break () |
Breaks message routing. |
 |
void | Continue () |
Starts the tracer or continues message routing from the current breakpoint. |
  |
int32 | GetEndpoints
(
TArray< TSharedPtr< FMessageTracerEndpointInfo >>& OutEndpoints |
Gets the list of known message endpoints. |
  |
int32 | GetMessages
(
TArray< TSharedPtr< FMessageTracerMessageInfo >>& OutMessages |
Gets the collection of known messages. |
  |
int32 | GetMessageTypes
(
TArray< TSharedPtr< FMessageTracerTypeInfo >>& OutTypes |
Gets the list of known message types filtered by name. |
  |
bool | HasMessages () |
Checks whether there are any messages in the history. |
  |
bool | IsBreaking () |
Checks whether the tracer is currently at a breakpoint. |
  |
bool | IsRunning () |
Checks whether the tracer is currently running. |
 |
IMessageTracer::FOnMessageAdded TBaseMulticastDelegate_OneParam | ||
 |
IMessageTracer::FOnMessagesReset TBaseMulticastDelegate_NoParams | ||
 |
IMessageTracer::FOnTypeAdded TBaseMulticastDelegate_OneParam | OnTypeAdded () |
|
 |
void | Reset () |
Resets the tracer. |
 |
void | Step () |
Steps the tracer to the next message. |
 |
void | Stop () |
Stops the tracer. |
 |
bool | Tick
(
float DeltaTime |
Ticks the tracer. |
Classes
| Type | Name | Description | |
|---|---|---|---|
 |
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 | Description |
|---|---|
| FMessageTracerMessageInfoRef | |
| FMessageTracerTypeInfoRef |