FDCMessenger

Cluster monitor messenger

API > API/Plugins > API/Plugins/DisplayClusterMonitor

Cluster monitor messenger

It's a wrapper around the Message Bus message endpoint that encapsulates some basic functionality like disovery, timeout monitor, callbacks. etc.

   
Name FDCMessenger
Type class
Header File /Engine/Plugins/Runtime/nDisplay/Source/DisplayClusterMonitor/Public/DisplayClusterMonitorMessenger.h
Include Path #include "DisplayClusterMonitorMessenger.h"

Syntax

class FDCMessenger

Constructors

Name Remarks Include Path Unreal Specifiers

FDCMessenger()

   DisplayClusterMonitorMessenger.h  

Destructors

Name Remarks Include Path Unreal Specifiers

~FDCMessenger()

   DisplayClusterMonitorMessenger.h  

Structs

Name Remarks
FCustomMessageEvent Universal user delegates wrapper
FCustomMessageEventBase Auxiliary non-templated class to generalize user delegates

Typedefs

Name Type Remarks Include Path
FOnConsoleCommand TBaseDelegate_ThreeParams< void, const FDCEndpoint &, const FString &, const FString & > Called every time a cluster monitor requests local execution of a console command DisplayClusterMonitorMessenger.h
FOnEndpointJoined TMulticastDelegate_OneParam< void, const FDCEndpoint & > Called every time a new endpoint is discovered DisplayClusterMonitorMessenger.h
FOnEndpointLeft TMulticastDelegate_TwoParams< void, const FDCEndpoint &, const FString & > Called every time a known endpoint reports it's leaving DisplayClusterMonitorMessenger.h
FOnEndpointTimeout TMulticastDelegate_OneParam< void, const FDCEndpoint & > Called every time a known endpoint is considered unresponsive DisplayClusterMonitorMessenger.h

Constants

Name Type Remarks Include Path
ThisResidence TOptional< FDCMData_ResidenceDescriptor > Residence of this UE process DisplayClusterMonitorMessenger.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
OnConsoleCommand FOnConsoleCommand   DisplayClusterMonitorMessenger.h  
OnEndpointJoined FOnEndpointJoined   DisplayClusterMonitorMessenger.h  
OnEndpointLeft FOnEndpointLeft   DisplayClusterMonitorMessenger.h  
OnEndpointTimeout FOnEndpointTimeout   DisplayClusterMonitorMessenger.h  

Protected

Name Type Remarks Include Path Unreal Specifiers
bIsRunning bool Whether this messenenger is currently active DisplayClusterMonitorMessenger.h  
DiscoveredEndpoints TArray< FDCEndpoint > All discovered and currently online endpoints DisplayClusterMonitorMessenger.h  
HeartbeatPulseCounter uint32 Heartbeat pulse counter. Increments every time with the pulse. DisplayClusterMonitorMessenger.h  
LastHeartbeatPulseTime double Last time we sent hearbeat pulse DisplayClusterMonitorMessenger.h  
MessageEndpoint TSharedPtr< FMessageEndpoint > MessageBus message endpoint DisplayClusterMonitorMessenger.h  
ThisEndpoint FDCEndpoint Endpoint information of this messenger instance DisplayClusterMonitorMessenger.h  
TickerHandle FTSTicker::FDelegateHandle Custom Tick() delegate handle DisplayClusterMonitorMessenger.h  
UserMessageEvents TMap< UScriptStruct *, TSharedPtr< FCustomMessageEventBase > > Message type bound user delegates DisplayClusterMonitorMessenger.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void Broadcast ( MessageType&& InMessage
)

 Broadcast messageEvery cluster monitor messenger will receive it. DisplayClusterMonitorMessenger.h  

FMessageAddress GetAddress ( const FGuid& InClusterId,
const FGuid& InNodeId
) const

 Returns MessageBus address of a spcific residence DisplayClusterMonitorMessenger.h  
Returns MessageBus address of this messenger DisplayClusterMonitorMessenger.h  

TConstArrayView< FDCEndpoint > GetDiscoveredEndpoints()

 Returns a list of endpoints that have been discovered DisplayClusterMonitorMessenger.h  

const FDCEndpoint & GetEndpointInfo()

 Returns this messenger's endpoint info DisplayClusterMonitorMessenger.h  

bool IsRunning()

 Whether the messenger is currently runing DisplayClusterMonitorMessenger.h  

FCustomMessageEvent< MessageType >::FDelegate & OnMessage ()

 Generic access to the user delegates DisplayClusterMonitorMessenger.h  

void Send ( const TArray< FMessageAddress >& InRecipients,
const MessageType& InMessage
)

 Send message to a list of recipients DisplayClusterMonitorMessenger.h  

void Send ( const TArray< FMessageAddress >& InRecipients,
MessageType&& InMessage
)

 Send message to a list of recipients (move semantics) DisplayClusterMonitorMessenger.h  

void SendToRoles ( const TSet< EDCMessengerRole >& InEndpointTypes,
MessageType&& InMessage
)

 Send message to everyone who has any of specified messenger roles DisplayClusterMonitorMessenger.h  

bool Start ( const FString& InEndpointName,
const TSet< EDCMessengerRole >& InEndpointRoles
)

 Start messenger with given name and roles DisplayClusterMonitorMessenger.h  

void Stop ( const FString& InReason
)

 Stop messenger DisplayClusterMonitorMessenger.h  

Static

Name Remarks Include Path Unreal Specifiers

static double GetLastActivityTime()

 Activity time provider DisplayClusterMonitorMessenger.h  

static FGuid MakeDeterministicClusterGuid ( const FString& InPrimaryNodeId,
const FString& InPrimaryNodeAddr,
uint16 InPrimaryExclusiveCommPort
)

 Auxiliary function that generates the cluster GUID deterministically. DisplayClusterMonitorMessenger.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page