Table of Contents

Class FrameWriter

Namespace
KernLab.Cell
Assembly
KernLab.Cell.dll

帧写器——写路径单点串行(总体设计 §3.6/D5):所有写入进 FIFO 任务链,链上永远只有一环在写, 多写者并发调用一条流在结构上不可能——撕裂长度前缀与载荷的缺陷没有存在的位置。

★ 帧原子性:取消(CancellationToken)只在作业未上链执行时生效;一旦开始写, 该帧写完为止(半帧即分帧已破——宁慢勿撕)。

★ 两形态:消息直写(WriteAsync(CellFrame, CancellationToken)——链内 ComputeLength/EncodeInto 直写管道,零中间拷贝) 与已编码帧体(WriteRawAsync(ReadOnlyMemory<byte>, CancellationToken)——入队时拷入池,调用方缓冲即刻可复用)。

public sealed class FrameWriter : IAsyncDisposable
Inheritance
FrameWriter
Implements
Inherited Members

Constructors

FrameWriter(PipeWriter, int)

构造。

public FrameWriter(PipeWriter output, int maxFrameLength = 4194304)

Parameters

output PipeWriter

载体写半边(Output)。

maxFrameLength int

帧长上限(握手协商上限 ≤ MaxFrameLength)。

Properties

FramesWritten

已写帧数(单调——§9 计数面)。

public long FramesWritten { get; }

Property Value

long

Methods

DisposeAsync()

排空队列后关闭写半边(幂等——再调用为空操作)。

public ValueTask DisposeAsync()

Returns

ValueTask

FlushAsync(CancellationToken)

排空写队列并落到载体(链尾直达——不插队)。

public ValueTask FlushAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Returns

ValueTask

WriteAsync(CellFrame, CancellationToken)

写一帧(帧消息直编码——链内直写管道,零中间拷贝)。

public ValueTask WriteAsync(CellFrame frame, CancellationToken cancellationToken = default)

Parameters

frame CellFrame
cancellationToken CancellationToken

Returns

ValueTask

WriteRawAsync(ReadOnlyMemory<byte>, CancellationToken)

写一帧(已编码帧体——[Tag 1B][字段];入队时拷入池,多写者安全)。

public ValueTask WriteRawAsync(ReadOnlyMemory<byte> frameBody, CancellationToken cancellationToken = default)

Parameters

frameBody ReadOnlyMemory<byte>
cancellationToken CancellationToken

Returns

ValueTask