SessionOptions
SessionOptions<
In,Out,Key> =object
Defined in: packages/net-core/src/session.ts:29
Construction options for Session.
Type Parameters
Section titled “Type Parameters”In
Out
Key = unknown
Properties
Section titled “Properties”codec:
Codec<In,Out>
Defined in: packages/net-core/src/session.ts:34
Decoder and encoder for this protocol.
initialCapacity?
Section titled “initialCapacity?”
optionalinitialCapacity?:number
Defined in: packages/net-core/src/session.ts:43
Initial receive arena size. Defaults to 8 KiB.
maxBufferSize
Section titled “maxBufferSize”maxBufferSize:
number
Defined in: packages/net-core/src/session.ts:40
Hard ceiling, in bytes, on undecoded received data. Required; see FrameLinkOptions.maxBufferSize.
registry?
Section titled “registry?”
optionalregistry?:ExchangeRegistry<In,Key>
Defined in: packages/net-core/src/session.ts:51
Correlation strategy for inbound frames. Defaults to strict FIFO, which suits ordered text protocols; supply a KeyedRegistry for protocols that answer out of order, or a wider ScanningRegistry for uncorrelated ones.
transport
Section titled “transport”transport:
Transport
Defined in: packages/net-core/src/session.ts:31
Carrier for the framed bytes.