Class ProtocolDataHeader

Namespace

SmarterLink.Core.Protocol

Assembly

SmarterLink.Core.dll

The envelope header present on every SmarterLink message. Contains routing metadata, ordering information, and an optional application-defined UserData string.

public record ProtocolDataHeader : IEquatable<ProtocolDataHeader>

Inheritance

object

ProtocolDataHeader

Implements

IEquatable<ProtocolDataHeader>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

ProtocolDataHeader(string, long, int, string?)

The envelope header present on every SmarterLink message. Contains routing metadata, ordering information, and an optional application-defined UserData string.

public ProtocolDataHeader(string PayloadType, long MonotonicCounter, int ProtocolRevision = 0, string? UserData = null)

Parameters

PayloadType string

MonotonicCounter long

ProtocolRevision int

UserData string

Properties

MonotonicCounter

[Description("Can be used to store either a timestamp (eg, milliseconds since Unix epoch) or just an increasing counter.  Used to determine the relative order of messages.")]
public long MonotonicCounter { get; init; }

Property Value

long

PayloadType

[JsonRequired]
public string PayloadType { get; init; }

Property Value

string

ProtocolRevision

[JsonRequired]
public int ProtocolRevision { get; init; }

Property Value

int

UserData

public string? UserData { get; init; }

Property Value

string