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