#include <IMessageBusListener.h>

Inheritance diagram for IBusListener:

Public Member Functions
virtual	~IBusListener ()

virtual ENamedThreads::Type	GetListenerThread () const =0

virtual void	NotifyRegistration (const FMessageAddress &Address, EMessageBusNotification Notification)=0

Detailed Description

Interface for message bus listener.

Classes that implement this interface are able to receive notifications from a message bus. A bus listener will receive a call to its appropriate IBusListener.Notify* method for dispatched notifications it is listening to.

This interface provides a rather low-level mechanism for listening to notification. Instead of implementing it, Most users will want to use an instance of see FMessageEndpoint, which provides a much more convenient way of listening to bus notifications.

See also: FMessageEndpoint, IMessageBus

Constructor & Destructor Documentation

◆ ~IBusListener()

virtual IBusListener::~IBusListener ( )

inlinevirtual

Member Function Documentation

◆ GetListenerThread()

virtual ENamedThreads::Type IBusListener::GetListenerThread ( ) const

pure virtual

Gets the name of the thread on which to receive notifications.

If the listener's Notify[*] methods are thread-safe, return ThreadAny for best performance.

Returns: Name of the listener thread.

Implemented in FMessageEndpoint.

◆ NotifyRegistration()

virtual void IBusListener::NotifyRegistration	(	const FMessageAddress &	Address,
		EMessageBusNotification	Notification
	)

pure virtual

Notify a registration event from the bus This is called when a receiver is registered or unregistered from the bus.

Parameters

Address	The address of the recipient that just un/registered from the bus.
Notification	The even type, either `Registered` or `Unregistered`