FrameLinkOptions
FrameLinkOptions<
In,Out> =object
Defined in: packages/net-core/src/frame-link.ts:65
Type Parameters
Section titled “Type Parameters”In
Out
Properties
Section titled “Properties”codec:
Codec<In,Out>
Defined in: packages/net-core/src/frame-link.ts:70
Decoder and encoder for this protocol.
initialCapacity?
Section titled “initialCapacity?”
optionalinitialCapacity?:number
Defined in: packages/net-core/src/frame-link.ts:85
Initial receive arena size. Defaults to 8 KiB.
maxBufferSize
Section titled “maxBufferSize”maxBufferSize:
number
Defined in: packages/net-core/src/frame-link.ts:82
Hard ceiling, in bytes, on undecoded received data.
Required and deliberately without a default: this is the boundary that stops a peer driving unbounded allocation, and every call site must state it explicitly. Exceeding it is fatal.
sink:
FrameSink<In>
Defined in: packages/net-core/src/frame-link.ts:73
Destination for decoded values.
transport
Section titled “transport”transport:
Transport
Defined in: packages/net-core/src/frame-link.ts:67
Carrier for the framed bytes.