Click or drag to resize

CFXEnvelope Class

The CFXEnvelope class is the outer envelope or container in which all CFX messages are enclosed for transmission. Common properties, such as a globally unique identifier (ID) and the timestamp for the message (TimeStamp), are defined by this container class and are included with all CFX message transmissions.
{
   "MessageName": "CFX.EndpointConnected",
   "Version": "1.7",
   "TimeStamp": "2018-03-26T16:52:25.3769532-04:00",
   "UniqueID": "f3b2c8ec-50b7-4c63-9cb3-2ed57c01880f",
   "Source": null,
   "Target": null,
   "RequestID": null,
   "MessageBody": {
     "CFXHandle": "SMTPlus.Model_21232.SN23123",
     "RequestNetworkUri": "amqp://host33/",
     "RequestTargetAddress": "/queue/SN23123"
    }
}
Inheritance Hierarchy
SystemObject
  CFXCFXEnvelope

Namespace: CFX
Assembly: CFX (in CFX.dll) Version: 1.7.3
Syntax
public class CFXEnvelope

The CFXEnvelope type exposes the following members.

Constructors
Properties
 NameDescription
Public propertyMessageBody The message payload (The CFX message enclosed in this envelope).
Public propertyMessageName The fully qualified name of the CFX message contained within the envelope. For example, "CFX.Production.WorkStarted"
Public propertyRequestID For request/response type messages, this is a globally unique id which identifies a specific request/response pairing. Each request/response pairing will have a unique and matching RequestId.
Public propertySource The CFX Handle of the creator/publisher of this message.
Public propertyTarget For request/response type messages, this is the CFX Handle of the endpoint to which the request is being made.
Public propertyTimeStamp The date and time when the event associated with this CFX message took place, NOT the time when the message was transmitted. The format must include the time zone, whether expressed in local time or UTC.
Public propertyUniqueID A globally unique ID used to identify this particualar message instance. This ID is used to ensure messages are not processed more than once. It is also used in cases where the receiver needs to identify the specific message that is being replied to.
Public propertyVersion The version of the CFX message contained within the payload of this envelope. This is the version number (revision) of the published standard.
Top
Methods
Fields
 NameDescription
Public fieldStatic memberCFXVERSION 
Top
See Also

Reference

CFX Namespace