Navigation
API > API/Plugins > API/Plugins/DisplayCluster
Helper for DisplayCluster synchronous replication
| Name | FDisplayClusterNetDriverHelper |
| Type | struct |
| Header File | /Engine/Plugins/Runtime/nDisplay/Source/DisplayCluster/Public/Cluster/DisplayClusterNetDriverHelper.h |
| Include Path | #include "Cluster/DisplayClusterNetDriverHelper.h" |
Syntax
USTRUCT ()
struct FDisplayClusterNetDriverHelper
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| ClusterEventsBinaryClients | TMap< uint32, TSharedPtr< FDisplayClusterClusterEventsBinaryClient > > | NDisplay primary node events clients for sending control messages to clusters | Cluster/DisplayClusterNetDriverHelper.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
int32 GetNumberOfClusterNodes() |
Returns number of nodes in current cluster | Cluster/DisplayClusterNetDriverHelper.h | |
FString GetPrimaryNodeAddress() |
Returns primary node IP address of current cluster | Cluster/DisplayClusterNetDriverHelper.h | |
bool HasClient
(
uint32 ClusterId |
Checks if nDisplay cluster events client registered for specified cluster | Cluster/DisplayClusterNetDriverHelper.h | |
bool RegisterClusterEventsBinaryClient
(
uint32 СlusterId, |
Creates and stores nDisplay cluster events client using cluster id and primary node parameters | Cluster/DisplayClusterNetDriverHelper.h | |
bool RemoveClusterEventsBinaryClient
(
uint32 СlusterId |
Removes cluster event client for ClusterId | Cluster/DisplayClusterNetDriverHelper.h | |
void SendCommandToAllClusters
(
const FDisplayClusterClusterEventBinary& NetworkDriverSyncEvent |
Sends command to all nDisplay clusters stored by RegisterClusterEventsBinaryClient | Cluster/DisplayClusterNetDriverHelper.h | |
bool SendCommandToCluster
(
uint32 СlusterId, |
Sends command to nDisplay cluster specified by id | Cluster/DisplayClusterNetDriverHelper.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static bool GetRequiredArguments
(
const FURL& URL, |
Checks if URL has all required arguments for DisplayClusterNetDriver | Cluster/DisplayClusterNetDriverHelper.h |