C-DEngine 5.105

TSM..::..FLG Field

16 Flags for the message each bit has impact on how the message is transported or interpreted The default is zero (Off) on all flags.

  • Bit 1(1) = Do not Relay this message - it wil only be sent to the next node (use SetDoNotRelay(true/false) and DoNotRelay())
  • Bit 2(2) = Unsubscribe the topics this message was sent with after the message was published (use SetUnsubscribeAfterPublish() and UnsubscribeAfterPublish())
  • Bit 3(4) = Send the Message only to the Cloud and devices connected to the cloud but not inside to any on-premise services (use SetToCloudOnly() and ToCloudOnly())
  • Bit 4(8) = Send this message to the Services (Data Provider) only. Messages with this flag are not sent to Client Nodes (Use SetToServiceOnly() and ToServiceOnly())
  • Bit 5(16) = Invers of Bit 4: Send this message to Client Nodes only. Messages with this flag are not sent to Service Nodes (use SetToNodesOnly() and ToNodesOnly())
  • Bit 6(32) = A message can be processed by multiple nodes. You can set this flag to tell later nodes that this message has been processed already (Use SetWasProcessed() and WasProcessed())
  • Bit 7(64) = Similar to Bit6, this bit can be used by plug-ins for any custom use, recommendation is to use it for reply-messages to ack signaling (use SetAcknowledged() and Acknowledged())
  • Bit 8(128) = Messages with this Flag set are only sent to the first Relay and not beyond. In most cases this is the FirstNode the current node is connected to (use SetToRelayOnly() and ToRelayOnly)
  • Bit 9(256) = Messages are placed in a Queue to be sent to the next nodes. If this flag is set, the message will NOT be placed in the Queue if it is already in the queue. Only the FIRST message found will be sent and later ones are discarded. The Message Hash is used to check if a message was found in the Queue. See GetHash() - (use SetNotToSendAgain() and NotToSendAgain())
  • Bit 10(512) = Similar to bit 9 a message this flag is used to only send one message. In opposite to Bit9, this flag ensures that only the LATEST message is sent (use SetNoDuplicates() and NoDuplicates())
  • Bit 11(1024) = Enable Pulse Mode. If this bit is enabled, the Sender and Receiver switch to Adrenalin mode and try to speed up communication. Active Nodes immediately initiate another request to the connected node (Use SetSendPulse and SendPulse)
  • Bit 12(2048) = If is set if a Message was relayed over a cloud node. Only ready this bit, it wil be set by the C-DEngine automatically on the Cloud Node
  • Bit 13(4096) = WRITE-ONLY: This Flag tells the C-DEngine to Encrypt the PLS when the message is sent and automatically decrypted when it is received and before its sent to the "ProcessIncomingMessage" handler (use EncryptPLS())
  • Bit 14(8192) = READ-ONLY: This flag can be read to determine if the PLS is encrypted (Use IsPLSEncrypted())
  • Bit 15 and 16 are reserved for future use

Namespace:  nsCDEngine.BaseClasses
Assembly:  C-DEngine (in C-DEngine.dll)

Syntax


public ushort FLG
Public FLG As UShort
public:
unsigned short^ FLG