Class TickReader

Namespace: Typhon.Protocol

Assembly: Typhon.Protocol.dll

Decodes a TICK message into an ITickSink: the header, then every block, each isolated by its length so a block can neither read past its end nor leave bytes unread.

public static class TickReader

Inheritance: object

TickReader

Inherited Members: object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Methods

Read<TSink>(ReadOnlySpan<byte>, CatalogPlan, ref TSink, TickBlocks)

Decodes one TICK message, type byte included.

public static void Read<TSink>(ReadOnlySpan<byte> message, CatalogPlan plan, ref TSink sink, TickBlocks blocks = TickBlocks.All) where TSink : ITickSink, allows ref struct

Parameters

message ReadOnlySpan<byte>: The whole message.
plan CatalogPlan: The session's compiled catalog.
sink TSink: Receives the frame.
blocks TickBlocks: Which blocks reach the sink; the others are skipped by their length, unread. A store reads a frame twice — every block but EVENTS, then EVENTS alone — to apply § 5's order whatever order the blocks travel in.

Type Parameters

TSink: The sink type; a struct keeps the calls inlined.

Exceptions