#include <IMessageSender.h>

Inheritance diagram for IMessageSender:

Public Member Functions
virtual FMessageAddress	GetSenderAddress ()=0

virtual void	NotifyMessageError (const TSharedRef< IMessageContext, ESPMode::ThreadSafe > &Context, const FString &Error)=0

virtual	~IMessageSender ()

Detailed Description

Interface for message senders.

Classes that implement this interface are able to send messages on a message bus. Each message sender must be uniquely identifiable with a message address that is returned by the IMessageSender.GetSenderAddress method. It is recommended that implementors of this interface generate a GUID for each instance, which must not change throughout the lifetime of the instance.

The sending of messages is accomplished with the IMessageBus.Forward, IMessageBus.Publish and IMessageBus.Send methods. In case an error occurs during the sending of a message, the IMessageSender.NotifyMessageError method will be called.

This interface provides a rather low-level mechanism for receiving messages. Instead of implementing it, Most users will want to use an instance of FMessageEndpoint, which provides a much more convenient way of sending and receiving messages.

See also: FMessageEndpoint, IMessageBus, IMessageReceiver

Constructor & Destructor Documentation

◆ ~IMessageSender()

virtual IMessageSender::~IMessageSender ( )

inlinevirtual

Virtual destructor.

Member Function Documentation

◆ GetSenderAddress()

virtual FMessageAddress IMessageSender::GetSenderAddress ( )

pure virtual

Gets the sender's address.

Returns: The message address.

Implemented in FMessageBridge, and FMessageEndpoint.

◆ NotifyMessageError()

virtual void IMessageSender::NotifyMessageError	(	const TSharedRef< IMessageContext, ESPMode::ThreadSafe > &	Context,
		const FString &	Error
	)

pure virtual

Notifies the sender of errors.

Parameters

Context	The context of the message that generated the error.
Error	The error string.