Class SlipDecoder

Namespace

Pamoja.Serial

Assembly

Pamoja.Serial.dll

Reassembles whole SLIP frames from the chunks a serial port delivers.

public sealed class SlipDecoder : IDisposable

Inheritance

object

SlipDecoder

Implements

IDisposable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Examples

using var decoder = new SlipDecoder();
foreach (byte[] frame in decoder.Feed(chunk)) Handle(frame);

Remarks

A corrupt frame does not throw, because the frames around it are still good; it is dropped and counted on Discarded.

Constructors

SlipDecoder()

Creates an empty decoder, ready for the first chunk.

public SlipDecoder()

Exceptions

PamojaException

The native decoder could not be created.

Properties

Discarded

How many corrupt frames this decoder has discarded.

public ulong Discarded { get; }

Property Value

ulong

Methods

Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

public void Dispose()

Feed(ReadOnlySpan<byte>)

Feeds a chunk of the stream.

public byte[][] Feed(ReadOnlySpan<byte> chunk)

Parameters

chunk ReadOnlySpan<byte>

The bytes just read from the port.

Returns

byte[][]

Every frame this chunk completed, in order, which is often none.

Exceptions

PamojaException

The native call failed.

Reset()

Discards any partly assembled frame.

public void Reset()