IMessageTracer Class Reference

#include <IMessageTracer.h>

Inheritance diagram for IMessageTracer:

Public Types
typedef TSharedRef< FMessageTracerMessageInfo >	FMessageTracerMessageInfoRef
typedef TSharedRef< FMessageTracerTypeInfo >	FMessageTracerTypeInfoRef

Public Member Functions
virtual void	Break ()=0
virtual void	Continue ()=0
virtual bool	IsBreaking () const =0
virtual bool	IsRunning () const =0
virtual void	Reset ()=0
virtual void	Step ()=0
virtual void	Stop ()=0
virtual bool	Tick (float DeltaTime)=0
virtual int32	GetEndpoints (TArray< TSharedPtr< FMessageTracerEndpointInfo > > &OutEndpoints) const =0
virtual int32	GetMessages (TArray< TSharedPtr< FMessageTracerMessageInfo > > &OutMessages) const =0
virtual int32	GetMessageTypes (TArray< TSharedPtr< FMessageTracerTypeInfo > > &OutTypes) const =0
virtual bool	HasMessages () const =0
	DECLARE_EVENT_OneParam (IMessageTracer, FOnMessageAdded, FMessageTracerMessageInfoRef) virtual FOnMessageAdded &OnMessageAdded()=0
virtual FOnMessagesReset &	OnMessagesReset ()=0
	DECLARE_EVENT_OneParam (IMessageTracer, FOnTypeAdded, FMessageTracerTypeInfoRef) virtual FOnTypeAdded &OnTypeAdded()=0

Protected Member Functions
virtual	~IMessageTracer ()

Detailed Description

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.

Member Typedef Documentation

FMessageTracerMessageInfoRef

typedef TSharedRef<FMessageTracerMessageInfo> IMessageTracer::FMessageTracerMessageInfoRef

FMessageTracerTypeInfoRef

typedef TSharedRef<FMessageTracerTypeInfo> IMessageTracer::FMessageTracerTypeInfoRef

Constructor & Destructor Documentation

~IMessageTracer()

virtual IMessageTracer::~IMessageTracer ( )

inlineprotectedvirtual

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

Member Function Documentation

Break()

virtual void IMessageTracer::Break ( )

pure virtual

Breaks message routing.

See also

Continue, IsBreaking, Step

Implemented in FMessageTracer.

Continue()

virtual void IMessageTracer::Continue ( )

pure virtual

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

See also

Break, Step

Implemented in FMessageTracer.

DECLARE_EVENT_OneParam() [1/2]

IMessageTracer::DECLARE_EVENT_OneParam ( IMessageTracer  , FOnMessageAdded  , FMessageTracerMessageInfoRef    ) &

pure virtual

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

Returns

The delegate.

DECLARE_EVENT_OneParam() [2/2]

IMessageTracer::DECLARE_EVENT_OneParam ( IMessageTracer  , FOnTypeAdded  , FMessageTracerTypeInfoRef    ) &

pure virtual

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

Returns

The delegate.

GetEndpoints()

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

pure virtual

Gets the list of known message endpoints.

Parameters

OutEndpoints

Will contain the list of endpoints.

Returns

The number of endpoints returned.

Implemented in FMessageTracer.

GetMessages()

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

pure virtual

Gets the collection of known messages.

Returns

The messages.

Implemented in FMessageTracer.

GetMessageTypes()

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

pure virtual

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.

Implemented in FMessageTracer.

HasMessages()

virtual bool IMessageTracer::HasMessages ( ) const

pure virtual

Checks whether there are any messages in the history.

Returns

true if there are messages, false otherwise.

Implemented in FMessageTracer.

IsBreaking()

virtual bool IMessageTracer::IsBreaking ( ) const

pure virtual

Checks whether the tracer is currently at a breakpoint.

Returns

true if at breakpoint, false otherwise.

See also

Break, IsRunning

Implemented in FMessageTracer.

IsRunning()

virtual bool IMessageTracer::IsRunning ( ) const

pure virtual

Checks whether the tracer is currently running.

Returns

true if the tracer is running, false otherwise.

See also

Continue, IsBreaking, Stop

Implemented in FMessageTracer.

OnMessagesReset()

virtual FOnMessagesReset & IMessageTracer::OnMessagesReset ( )

pure virtual

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

Returns

The delegate.

Implemented in FMessageTracer.

Reset()

virtual void IMessageTracer::Reset ( )

pure virtual

Resets the tracer.

Implemented in FMessageTracer.

Step()

virtual void IMessageTracer::Step ( )

pure virtual

Steps the tracer to the next message.

See also

Break, Continue, Stop

Implemented in FMessageTracer.

Stop()

virtual void IMessageTracer::Stop ( )

pure virtual

Stops the tracer.

See also

Continue, IsRunning, Step

Implemented in FMessageTracer.

Tick()

virtual bool IMessageTracer::Tick ( float  DeltaTime )

pure virtual

Ticks the tracer.

Parameters

DeltaTime

The time in seconds since the last tick.

Returns

true if any events were processed.

Implemented in FMessageTracer.

---

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

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