Class CatalogCommand

Namespace

Typhon.Protocol

Assembly

Typhon.Protocol.dll

A typed command a client may send. Commands enter the tick and are validated by ordinary application systems; a client never transacts directly.

public sealed class CatalogCommand

Inheritance

object

CatalogCommand

Inherited Members

object.GetType()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

CatalogCommand()

public CatalogCommand()

Fields

LatestDelivery

The Delivery that coalesces to the newest command per session.

public const string LatestDelivery = "latest"

Field Value

string

QueuedDelivery

The Delivery that keeps every command, in order.

public const string QueuedDelivery = "queued"

Field Value

string

Properties

Delivery

Delivery discipline: QueuedDelivery or LatestDelivery.

public string Delivery { get; init; }

Property Value

string

Fields

The command's payload fields, in wire order once canonical.

public CatalogField[] Fields { get; init; }

Property Value

CatalogField[]

Idx

The wire index: built-in commands keep their reserved index (ClientRegion 0, SubscribeRequest 1); application commands are numbered from 16 in ordinal name order (W27).

public int Idx { get; init; }

Property Value

int

Name

The declared wire name.

public string Name { get; init; }

Property Value

string

Rate

The rate limit for this command type. Absent when the type is not rate-limited.

[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public CatalogCommandRate Rate { get; init; }

Property Value

CatalogCommandRate