EMessageScope

Enumerates scopes for published messages.

Windows
MacOS
Linux

References

Module

Messaging

Header

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

Include

#include "IMessageContext.h"

Syntax

enum EMessageScope
{
    Thread,
    Process,
    Network,
    All,
}

Values

Name

Description

Thread

Deliver to subscribers in the same thread.

Process

Deliver to subscribers in the same process.

Network

Deliver to subscribers on the network.

All

Deliver to all subscribers.

This must be the last value in this enumeration.

Remarks

Enumerates scopes for published messages.

The scope determines to which endpoints a published message will be delivered. By default, messages will be published to everyone on the local network (Subnet), but it is often useful to restrict the group of recipients to more local scopes, or to widen it to a larger audience outside the local network.

For example, if a message is to be handled only by subscribers in the same application, the scope should be set to Process. If messages need to be published between different networks (i.e. between LAN and WLAN), it should be set to Network instead.

Scopes only apply to published messages. Messages that are being sent to specific recipients will always be delivered, regardless of the endpoint locations.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss