IMessageSender

Interface for message senders.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

IMessageSender

FMessageEndpoint

References

Module

Messaging

Header

/Engine/Source/Runtime/Messaging/Public/IMessageSender.h

Include

#include "IMessageSender.h"

Syntax

class IMessageSender

Remarks

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.

Destructors

Name Description

Public function Virtual

~IMessageSender()

Virtual destructor.

Functions

Name Description

Public function

FMessageAddr...

 

GetSenderAddress()

Gets the sender's address.

Public function

void

 

NotifyMessageError

(
    const TSharedRef< IMessageContext, ...,
    const FString& Error
)

Notifies the sender of errors.

See Also