#include <NodeNotificationBroadcaster.hpp>
Public Member Functions | |
| NodeNotificationBroadcaster (const NodeNotificationBroadcaster &)=delete | |
| NodeNotificationBroadcaster & | operator= (const NodeNotificationBroadcaster &)=delete |
| void | broadcast (FunctionArgs &&... args) |
| size_t | subscribe (const NodeFunction< FunctionReturnType(FunctionArgs...)> &callback) |
| void | unsubscribe (size_t iBindingId) |
| size_t | getSubscriberCount () |
 Public Member Functions inherited from ne::NodeNotificationBroadcasterBase | |
| NodeNotificationBroadcasterBase (const NodeNotificationBroadcasterBase &)=delete | |
| NodeNotificationBroadcasterBase & | operator= (const NodeNotificationBroadcasterBase &)=delete |
Protected Member Functions | |
| virtual void | onOwnerNodeSpawning (Node *pOwnerNode) override |
| virtual void | onOwnerNodeDespawning (Node *pOwnerNode) override |
| virtual void | onOwnerNodeSpawning (Node *pOwnerNode)=0 |
| virtual void | onOwnerNodeDespawning (Node *pOwnerNode)=0 |
Private Member Functions | |
| void | removeAllCallbacks () |
Private Attributes | |
| std::pair< std::recursive_mutex, std::unordered_map< size_t, NodeFunction< FunctionReturnType(FunctionArgs...)> > > | mtxCallbacks |
| std::pair< std::recursive_mutex, std::unordered_map< size_t, NodeFunction< FunctionReturnType(FunctionArgs...)> > > | mtxCallbacksToAdd |
| std::pair< std::recursive_mutex, std::vector< size_t > > | mtxCallbacksToRemove |
| std::pair< std::recursive_mutex, Node * > | mtxSpawnedOwnerNode |
| std::atomic< size_t > | iAvailableBindingId {0} |
| std::atomic_flag | bIsBroadcasting {} |
Friends | |
| class | Node |
Detailed Description
class ne::NodeNotificationBroadcaster< FunctionReturnType(FunctionArgs...)>
Implements publisher-subscriber pattern. Allows nodes to subscribe by specifying their callback functions via NodeFunction and triggers them once the broadcast method is called.
Member Function Documentation
◆ broadcast()
|
inline |
Executes all registered (subscribed) callbacks.
- Remarks
- It's safe to call this function while your node is despawned, in this case the call will be ignored and nothing will be broadcasted.
- Additionally, before running registered callbacks, removes callbacks of despawned nodes.
- Parameters
-
args Arguments to pass to subscribed callbacks.
◆ getSubscriberCount()
|
inline |
Returns the current estimated number of subscribers.
The returned number is called "estimated" because right now we don't know if some nodes that subscribed to this broadcaster have despawned or not, callbacks of despawned nodes are only removed in broadcast calls. The only thing that we can say for sure is that the actual number of spawned subscribers is either equal to the returned value or smaller than it.
- Returns
- Estimated number of spawned subscribers.
◆ onOwnerNodeDespawning()
|
inlineoverrideprotectedvirtual |
Called by the node, that owns this broadcaster, when it's despawning.
- Parameters
-
pOwnerNode Node that owns this broadcaster.
Implements ne::NodeNotificationBroadcasterBase.
◆ onOwnerNodeSpawning()
|
inlineoverrideprotectedvirtual |
Called by the node, that owns this broadcaster, when it's spawning.
- Parameters
-
pOwnerNode Spawned node that owns this broadcaster.
Implements ne::NodeNotificationBroadcasterBase.
◆ removeAllCallbacks()
|
inlineprivate |
Removes all registered callbacks (including callbacks that are pending to be added/removed).
◆ subscribe()
|
inline |
Adds the specified callback to be registered in the broadcaster so that the callback will be triggered on the next broadcast call.
- Parameters
-
callback Callback to register.
- Returns
- Unique ID (only unique relative to this broadcaster) of the registered callback. You can save this ID if you would need to unsubscribe later (see unsubscribe), otherwise just ignore this returned value.
◆ unsubscribe()
|
inline |
Removes a previously added callback (see subscribe) by its binding ID.
- Remarks
- You don't need to unsubscribe when your subscribed node is being despawned/destroyed as this is done automatically. Each broadcast call removes callbacks of despawned nodes.
- Parameters
-
iBindingId ID of the binding to remove.
Member Data Documentation
◆ bIsBroadcasting
|
private |
Determines whether we are currently broadcasting or not.
◆ iAvailableBindingId
|
private |
Stores the next free (available for use) binding ID.
◆ mtxCallbacks
|
private |
Stores map that should be used with the mutex. Map contains pairs of "binding ID" - "callback".
◆ mtxCallbacksToAdd
|
private |
Stores map that should be used with the mutex. Map contains pairs of "binding ID" - "callback" to add to mtxCallbacks.
◆ mtxCallbacksToRemove
|
private |
Stores array that should be used with the mutex. Array contains binding IDs to remove from mtxCallbacks.
◆ mtxSpawnedOwnerNode
|
private |
Information about the owner node.
The documentation for this class was generated from the following file:
- src/engine_lib/public/game/callbacks/NodeNotificationBroadcaster.hpp
