Heartbeat Class

All endpoints are obligated to publish a Heartbeast message on all Publish type no less than once every 5 minutes. The AmqpCFXEndpoint class automatically performs this function for you when using the CFX SDK. You can adjust the frequency of the Heartbeat using the HeartbeatFrequency to any value between 1 second and 5 minutes. By default, the CFX SDK sends a Heartbeat once every 1 minute.

Copy

{
    "CFXHandle": "SMTPlus.Model_21232.SN23123",
    "HeartbeatFrequency": "00:01:00"
}

Inheritance Hierarchy

SystemObject
CFXCFXMessage
CFXHeartbeat

Namespace: CFX
Assembly: CFX (in CFX.dll) Version: 1.7.3

Syntax

Copy

public class Heartbeat : CFXMessage

Public Class Heartbeat
	Inherits CFXMessage

The Heartbeat type exposes the following members.

Constructors

	Name	Description
	Heartbeat

Top

Properties

	Name	Description
	ActiveFaults	NOTE: ADDED in CFX 1.7 Any faults currently active on this endpoint. Faults should be repeated here until cleared. Leaving this parameter as null means that active faults are not known. Setting it to an empty List implies positive knowledge that there are no active faults.
	ActiveRecipes	NOTE: ADDED in CFX 1.7 Any recipes currently active on this endpoint. Recipes may be specified either using their identifiers or by including recipe details such as expected cycle times depending on what information the endpoing is able to communicate. Leaving this parameter as null means that active recipes are not known. Setting it to an empty List implies positive knowledge that there are no active recipes. Multiple recipes may be active at once on a given endpoint.
	CFXHandle	The handle of the endpoint that is publishing the Heartbeat.
	HeartbeatFrequency	The amount of time to expect between Heartbeast messasges for this endpoint

Top

Reference

CFX Namespace