FMessageTracer Class Reference

#include <MessageTracer.h>

Inheritance diagram for FMessageTracer:

Public Member Functions
	FMessageTracer ()
virtual	~FMessageTracer ()
void	TraceAddedInterceptor (const TSharedRef< IMessageInterceptor, ESPMode::ThreadSafe > &Interceptor, const FTopLevelAssetPath &MessageType)
void	TraceAddedRecipient (const FMessageAddress &Address, const TSharedRef< IMessageReceiver, ESPMode::ThreadSafe > &Recipient)
void	TraceAddedSubscription (const TSharedRef< IMessageSubscription, ESPMode::ThreadSafe > &Subscription)
void	TraceDispatchedMessage (const TSharedRef< IMessageContext, ESPMode::ThreadSafe > &Context, const TSharedRef< IMessageReceiver, ESPMode::ThreadSafe > &Recipient, bool Async)
void	TraceHandledMessage (const TSharedRef< IMessageContext, ESPMode::ThreadSafe > &Context, const TSharedRef< IMessageReceiver, ESPMode::ThreadSafe > &Recipient)
void	TraceInterceptedMessage (const TSharedRef< IMessageContext, ESPMode::ThreadSafe > &Context, const TSharedRef< IMessageInterceptor, ESPMode::ThreadSafe > &Interceptor)
void	TraceRemovedInterceptor (const TSharedRef< IMessageInterceptor, ESPMode::ThreadSafe > &Interceptor, const FTopLevelAssetPath &MessageType)
void	TraceRemovedRecipient (const FMessageAddress &Address)
void	TraceRemovedSubscription (const TSharedRef< IMessageSubscription, ESPMode::ThreadSafe > &Subscription, const FTopLevelAssetPath &MessageType)
void	TraceRoutedMessage (const TSharedRef< IMessageContext, ESPMode::ThreadSafe > &Context)
void	TraceSentMessage (const TSharedRef< IMessageContext, ESPMode::ThreadSafe > &Context)
virtual void	Break () override
virtual void	Continue () override
virtual int32	GetEndpoints (TArray< TSharedPtr< FMessageTracerEndpointInfo > > &OutEndpoints) const override
virtual int32	GetMessages (TArray< TSharedPtr< FMessageTracerMessageInfo > > &OutMessages) const override
virtual int32	GetMessageTypes (TArray< TSharedPtr< FMessageTracerTypeInfo > > &OutTypes) const override
virtual bool	HasMessages () const override
virtual bool	IsBreaking () const override
virtual bool	IsRunning () const override
virtual FOnMessageAdded &	OnMessageAdded () override
virtual FOnMessagesReset &	OnMessagesReset () override
virtual FOnTypeAdded &	OnTypeAdded () override
virtual void	Reset () override
virtual void	Step () override
virtual void	Stop ()
virtual bool	Tick (float DeltaTime) override
Public Member Functions inherited from IMessageTracer
	DECLARE_EVENT_OneParam (IMessageTracer, FOnMessageAdded, FMessageTracerMessageInfoRef) virtual FOnMessageAdded &OnMessageAdded()=0
	DECLARE_EVENT_OneParam (IMessageTracer, FOnTypeAdded, FMessageTracerTypeInfoRef) virtual FOnTypeAdded &OnTypeAdded()=0

Protected Member Functions
void	ResetMessages ()
bool	ShouldBreak (const TSharedRef< IMessageContext, ESPMode::ThreadSafe > &Context) const
Protected Member Functions inherited from IMessageTracer
virtual	~IMessageTracer ()

Additional Inherited Members
Public Types inherited from IMessageTracer
typedef TSharedRef< FMessageTracerMessageInfo >	FMessageTracerMessageInfoRef
typedef TSharedRef< FMessageTracerTypeInfo >	FMessageTracerTypeInfoRef

Detailed Description

Implements a message bus tracers.

Constructor & Destructor Documentation

FMessageTracer()

FMessageTracer::FMessageTracer

(

)

Default constructor.

~FMessageTracer()

FMessageTracer::~FMessageTracer ( )

virtual

Virtual destructor.

Member Function Documentation

Break()

void FMessageTracer::Break ( )

overridevirtual

Breaks message routing.

See also

Continue, IsBreaking, Step

Implements IMessageTracer.

Continue()

void FMessageTracer::Continue ( )

overridevirtual

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

See also

Break, Step

Implements IMessageTracer.

GetEndpoints()

int32 FMessageTracer::GetEndpoints ( TArray< TSharedPtr< FMessageTracerEndpointInfo > > &  OutEndpoints ) const

overridevirtual

Gets the list of known message endpoints.

Parameters

OutEndpoints

Will contain the list of endpoints.

Returns

The number of endpoints returned.

Implements IMessageTracer.

GetMessages()

int32 FMessageTracer::GetMessages ( TArray< TSharedPtr< FMessageTracerMessageInfo > > &  OutMessages ) const

overridevirtual

Gets the collection of known messages.

Returns

The messages.

Implements IMessageTracer.

GetMessageTypes()

int32 FMessageTracer::GetMessageTypes ( TArray< TSharedPtr< FMessageTracerTypeInfo > > &  OutTypes ) const

overridevirtual

Gets the list of known message types filtered by name.

Parameters

NameFilter	The name substring to filter with.
OutTypes	Will contain the list of message types.

Returns

The number of message types returned.

Implements IMessageTracer.

HasMessages()

bool FMessageTracer::HasMessages ( ) const

overridevirtual

Checks whether there are any messages in the history.

Returns

true if there are messages, false otherwise.

Implements IMessageTracer.

IsBreaking()

bool FMessageTracer::IsBreaking ( ) const

overridevirtual

Checks whether the tracer is currently at a breakpoint.

Returns

true if at breakpoint, false otherwise.

See also

Break, IsRunning

Implements IMessageTracer.

IsRunning()

bool FMessageTracer::IsRunning ( ) const

overridevirtual

Checks whether the tracer is currently running.

Returns

true if the tracer is running, false otherwise.

See also

Continue, IsBreaking, Stop

Implements IMessageTracer.

OnMessageAdded()

virtual FOnMessageAdded & FMessageTracer::OnMessageAdded ( )

inlineoverridevirtual

OnMessagesReset()

virtual FOnMessagesReset & FMessageTracer::OnMessagesReset ( )

inlineoverridevirtual

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

Returns

The delegate.

Implements IMessageTracer.

OnTypeAdded()

virtual FOnTypeAdded & FMessageTracer::OnTypeAdded ( )

inlineoverridevirtual

Reset()

void FMessageTracer::Reset ( )

overridevirtual

Resets the tracer.

Implements IMessageTracer.

ResetMessages()

void FMessageTracer::ResetMessages ( )

protected

Resets traced messages.

ShouldBreak()

bool FMessageTracer::ShouldBreak ( const TSharedRef< IMessageContext, ESPMode::ThreadSafe > &  Context ) const

protected

Checks whether the tracer should break on the given message.

Parameters

Context

The context of the message to consider for breaking.

Step()

void FMessageTracer::Step ( )

overridevirtual

Steps the tracer to the next message.

See also

Break, Continue, Stop

Implements IMessageTracer.

Stop()

void FMessageTracer::Stop ( )

virtual

Stops the tracer.

See also

Continue, IsRunning, Step

Implements IMessageTracer.

Tick()

bool FMessageTracer::Tick ( float  DeltaTime )

overridevirtual

Ticks the tracer.

Parameters

DeltaTime

The time in seconds since the last tick.

Returns

true if any events were processed.

Implements IMessageTracer.

TraceAddedInterceptor()

void FMessageTracer::TraceAddedInterceptor	(	const TSharedRef< IMessageInterceptor, ESPMode::ThreadSafe > &	Interceptor,
		const FTopLevelAssetPath &	MessageType
	)

Notifies the tracer that a message interceptor has been added to the message bus.

Parameters

Interceptor	The added interceptor.
MessageType	The type of messages being intercepted.

TraceAddedRecipient()

void FMessageTracer::TraceAddedRecipient	(	const FMessageAddress &	Address,
		const TSharedRef< IMessageReceiver, ESPMode::ThreadSafe > &	Recipient
	)

Notifies the tracer that a message recipient has been added to the message bus.

Parameters

Address	The address of the added recipient.
Recipient	The added recipient.

TraceAddedSubscription()

void FMessageTracer::TraceAddedSubscription

(

const TSharedRef< IMessageSubscription, ESPMode::ThreadSafe > &

Subscription

)

Notifies the tracer that a message subscription has been added to the message bus.

Parameters

Subscription

The added subscription.

TraceDispatchedMessage()

void FMessageTracer::TraceDispatchedMessage	(	const TSharedRef< IMessageContext, ESPMode::ThreadSafe > &	Context,
		const TSharedRef< IMessageReceiver, ESPMode::ThreadSafe > &	Recipient,
		bool	Async
	)

Notifies the tracer that a message has been dispatched.

Parameters

Context	The context of the dispatched message.
Recipient	The message recipient.
Async	Whether the message was dispatched asynchronously.

TraceHandledMessage()

void FMessageTracer::TraceHandledMessage	(	const TSharedRef< IMessageContext, ESPMode::ThreadSafe > &	Context,
		const TSharedRef< IMessageReceiver, ESPMode::ThreadSafe > &	Recipient
	)

Notifies the tracer that a message has been handled.

Parameters

Context	The context of the dispatched message.
Recipient	The message recipient that handled the message.

TraceInterceptedMessage()

void FMessageTracer::TraceInterceptedMessage	(	const TSharedRef< IMessageContext, ESPMode::ThreadSafe > &	Context,
		const TSharedRef< IMessageInterceptor, ESPMode::ThreadSafe > &	Interceptor
	)

Notifies the tracer that a message has been intercepted.

Parameters

Context	The context of the intercepted message.
Interceptor	The interceptor.

TraceRemovedInterceptor()

void FMessageTracer::TraceRemovedInterceptor	(	const TSharedRef< IMessageInterceptor, ESPMode::ThreadSafe > &	Interceptor,
		const FTopLevelAssetPath &	MessageType
	)

Notifies the tracer that a message interceptor has been removed from the message bus.

Parameters

Interceptor	The removed interceptor.
MessageType	The type of messages that is no longer being intercepted.

TraceRemovedRecipient()

void FMessageTracer::TraceRemovedRecipient

(

const FMessageAddress &

Address

)

Notifies the tracer that a recipient has been removed from the message bus.

Parameters

Address

The address of the removed recipient.

TraceRemovedSubscription()

void FMessageTracer::TraceRemovedSubscription	(	const TSharedRef< IMessageSubscription, ESPMode::ThreadSafe > &	Subscription,
		const FTopLevelAssetPath &	MessageType
	)

Notifies the tracer that a message subscription has been removed from the message bus.

Parameters

Subscriber	The removed subscriber.
MessageType	The type of messages no longer being subscribed to.

TraceRoutedMessage()

void FMessageTracer::TraceRoutedMessage

(

const TSharedRef< IMessageContext, ESPMode::ThreadSafe > &

Context

)

Notifies the tracer that a message has been routed.

Parameters

Context

The context of the routed message.

TraceSentMessage()

void FMessageTracer::TraceSentMessage

(

const TSharedRef< IMessageContext, ESPMode::ThreadSafe > &

Context

)

Notifies the tracer that a message has been sent.

Parameters

Context

The context of the sent message.

---

The documentation for this class was generated from the following files:

• Engine/Source/Runtime/Messaging/Private/Bus/MessageTracer.h
• Engine/Source/Runtime/Messaging/Private/Bus/MessageTracer.cpp