Navigation
API > API/Plugins > API/Plugins/DisplayCluster
Public cluster manager interface
| Name | IDisplayClusterClusterManager |
| Type | class |
| Header File | /Engine/Plugins/Runtime/nDisplay/Source/DisplayCluster/Public/Cluster/IDisplayClusterClusterManager.h |
| Include Path | #include "Cluster/IDisplayClusterClusterManager.h" |
Syntax
class IDisplayClusterClusterManager
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~IDisplayClusterClusterManager() |
Cluster/IDisplayClusterClusterManager.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void AddClusterEventBinaryListener
(
const FOnClusterEventBinaryListener& Listener |
Registers binary cluster event listener. | Cluster/IDisplayClusterClusterManager.h | |
void AddClusterEventJsonListener
(
const FOnClusterEventJsonListener& Listener |
Registers json cluster event listener. | Cluster/IDisplayClusterClusterManager.h | |
void AddClusterEventListener
(
TScriptInterface< IDisplayClusterClusterEventListener > Listener |
Cluster events. | Cluster/IDisplayClusterClusterManager.h | |
virtual TUniquePtr< IDisplayClusterGenericBarriersClient > CreateGenericBarriersClient
(
const FString& ClientName |
Cluster/IDisplayClusterClusterManager.h | ||
| Creates a general purpose barriers interface. | Cluster/IDisplayClusterClusterManager.h | ||
bool DropClusterNode
(
const FString& NodeId |
Drop specific cluster node | Cluster/IDisplayClusterClusterManager.h | |
void EmitClusterEventBinary
(
const FDisplayClusterClusterEventBinary& Event, |
Emits binary cluster event. | Cluster/IDisplayClusterClusterManager.h | |
void EmitClusterEventJson
(
const FDisplayClusterClusterEventJson& Event, |
Emits JSON cluster event. | Cluster/IDisplayClusterClusterManager.h | |
EDisplayClusterNodeRole GetClusterRole() |
Returns cluster node role. | Cluster/IDisplayClusterClusterManager.h | |
FString GetNodeId() |
Returns current cluster node ID. | Cluster/IDisplayClusterClusterManager.h | |
void GetNodeIds
(
TSet< FString >& OutNodeIds |
Returns IDs of available cluster nodes. | Cluster/IDisplayClusterClusterManager.h | |
void GetNodeIds
(
TArray< FString >& OutNodeIds |
Returns IDs of available cluster nodes. | Cluster/IDisplayClusterClusterManager.h | |
uint32 GetNodesAmount() |
Returns amount of cluster nodes in the cluster. | Cluster/IDisplayClusterClusterManager.h | |
FString GetPrimaryNodeId() |
Returns current primary node ID. | Cluster/IDisplayClusterClusterManager.h | |
bool HasClusterRole
(
EDisplayClusterNodeRole Role |
Checks if the node has a specific role. | Cluster/IDisplayClusterClusterManager.h | |
bool IsBackup() |
Returns true if current node has backup role. | Cluster/IDisplayClusterClusterManager.h | |
bool IsPrimary() |
Returns true if current node has primary role. | Cluster/IDisplayClusterClusterManager.h | |
bool IsSecondary() |
Returns true if current node has secondary role. | Cluster/IDisplayClusterClusterManager.h | |
void RegisterSyncObject
(
IDisplayClusterClusterSyncObject* SyncObj, |
Registers object to synchronize. | Cluster/IDisplayClusterClusterManager.h | |
void RemoveClusterEventBinaryListener
(
const FOnClusterEventBinaryListener& Listener |
Unregisters binary cluster event listener. | Cluster/IDisplayClusterClusterManager.h | |
void RemoveClusterEventJsonListener
(
const FOnClusterEventJsonListener& Listener |
Unregisters json cluster event listener. | Cluster/IDisplayClusterClusterManager.h | |
void RemoveClusterEventListener
(
TScriptInterface< IDisplayClusterClusterEventListener > Listener |
Unregisters cluster event listener. | Cluster/IDisplayClusterClusterManager.h | |
void SendClusterEventTo
(
const FString& Address, |
Sends JSON cluster event to a specific target (outside of the cluster). | Cluster/IDisplayClusterClusterManager.h | |
void SendClusterEventTo
(
const FString& Address, |
Sends binary cluster event to a specific target (outside of the cluster). | Cluster/IDisplayClusterClusterManager.h | |
void UnregisterSyncObject
(
IDisplayClusterClusterSyncObject* SyncObj |
Unregisters synchronization object. | Cluster/IDisplayClusterClusterManager.h |