Class LpPacket

NDNLPv2 packet.

Hierarchy (View Summary)

LpL3
- LpPacket

Index

Constructors

Properties

congestionMark? fragCount fragIndex fragSeqNum? nack? payload? pitToken?

Accessors

Methods

encodeL3Headers encodeTo hasL3Headers decodeFrom

Constructors

constructor

new LpPacket(): LpPacket
Returns LpPacket

Properties

`Optional`congestionMark

congestionMark?: number

fragCount

fragCount: number = 1

fragIndex

fragIndex: number = 0

`Optional`fragSeqNum

fragSeqNum?: bigint

`Optional`nack

nack?: NackHeader

`Optional`payload

payload?: Uint8Array<ArrayBufferLike>

L3 payload.

Remarks

This field may contain either a whole L3 packet or fragment of one. This is also known as fragment in other libraries.

`Optional`pitToken

pitToken?: Uint8Array<ArrayBufferLike>

Accessors

l3

get l3(): LpL3
Extract L3 fields only.

Returns LpL3
Remarks
They may be copied to another LpPacket via Object.assign().
- Defined in packet.ts:46

Methods

encodeL3Headers

encodeL3Headers(): Encodable[]
Encode L3 headers.

Returns Encodable[]
See
LpL3
- Defined in packet.ts:96

encodeTo

encodeTo(encoder: Encoder): void
Prepend LpPacket to encoder.
Parameters
- encoder: Encoder
Returns void
Throws
Error Thrown if fragmentation headers violate invariants:
- .fragIndex >= .fragCount
- .fragSeqNum is unset but .fragCount > 1
- Defined in packet.ts:62

hasL3Headers

hasL3Headers(): boolean
Determine whether any L3 header is present.

Returns boolean
See
LpL3
- Defined in packet.ts:87

`Static`decodeFrom

decodeFrom(decoder: Decoder): LpPacket
Parameters
- decoder: Decoder
Returns LpPacket
- Defined in packet.ts:23