Navigation
API > API/Runtime > API/Runtime/Messaging > API/Runtime/Messaging/IMessageBus
Overloads
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual TSharedPtr< IMessageSubscription, ESPMode::ThreadSafe > Subscribe
(
const TSharedRef< IMessageReceiver, ESPMode::ThreadSafe >& Subscriber, |
Adds a subscription for published messages of the specified type. | IMessageBus.h | |
TSharedPtr< IMessageSubscription, ESPMode::ThreadSafe > Subscribe
(
const TSharedRef< IMessageReceiver, ESPMode::ThreadSafe >& Subscriber, |
Adds a subscription for published messages of the specified type. | IMessageBus.h |
Subscribe(const TSharedRef< IMessageReceiver, ESPMode::ThreadSafe > &, const FName &, const TRange< EMessageScope > &)
Description
Adds a subscription for published messages of the specified type.
Subscriptions allow message consumers to receive published messages from the message bus. The returned interface can be used to query the subscription's details and its enabled state.
| Name | Subscribe |
| Type | function |
| Header File | /Engine/Source/Runtime/Messaging/Public/IMessageBus.h |
| Include Path | #include "IMessageBus.h" |
| Source | /Engine/Source/Runtime/Messaging/Private/Bus/MessageBus.cpp |
virtual TSharedPtr < IMessageSubscription , ESPMode::ThreadSafe > Subscribe
(
const TSharedRef < IMessageReceiver , ESPMode::ThreadSafe > & Subscriber,
const FName & MessageType,
const TRange < EMessageScope > & ScopeRange
)
The added subscription, or nullptr if the subscription failed.
Parameters
| Name | Remarks |
|---|---|
| Subscriber | The subscriber wishing to receive the messages. |
| MessageType | The type of messages to subscribe to (NAME_All = subscribe to all message types). |
| ScopeRange | The range of message scopes to include in the subscription. |
See Also
- Unsubscribe
Subscribe(const TSharedRef< IMessageReceiver, ESPMode::ThreadSafe > &, const FTopLevelAssetPath &, const TRange< EMessageScope > &)
Description
Adds a subscription for published messages of the specified type.
Subscriptions allow message consumers to receive published messages from the message bus. The returned interface can be used to query the subscription's details and its enabled state.
| Name | Subscribe |
| Type | function |
| Header File | /Engine/Source/Runtime/Messaging/Public/IMessageBus.h |
| Include Path | #include "IMessageBus.h" |
TSharedPtr < IMessageSubscription , ESPMode::ThreadSafe > Subscribe
(
const TSharedRef < IMessageReceiver , ESPMode::ThreadSafe > & Subscriber,
const FTopLevelAssetPath & MessageType,
const TRange < EMessageScope > & ScopeRange
)
The added subscription, or nullptr if the subscription failed.
Parameters
| Name | Remarks |
|---|---|
| Subscriber | The subscriber wishing to receive the messages. |
| MessageType | The type of messages to subscribe to (IMessageBus::PATHNAME_All = subscribe to all message types). |
| ScopeRange | The range of message scopes to include in the subscription. |
See Also
- Unsubscribe