Class Layout

Packet layout class

Hierarchy

Layout

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Layout(layout: IPacketLayoutMember[], bitStride?: number): Layout

- Defined in index.ts:88
The constructor of this packet layout

Parameters
- layout: IPacketLayoutMember[]
  
  The packet layout to use
- bitStride: number = ...
  
  Optional custom bit stride to use
Returns Layout

Properties

Private _bitLength

_bitLength: number = 0

The total bit length of the packet layout

Private _bitStride

_bitStride: number = 0

The bit stride of the packet layout

Private _table

_table: Map<string, IPacketTableMember> = null

Internal layout table

Methods

decode

decode(name: string, buffer: Uint8Array): PacketOutputData

- Defined in index.ts:163
Decodes the layout data

Parameters
- name: string
  
  The name of the layout member to decode
- buffer: Uint8Array
  
  The bit buffer to decode from
Returns PacketOutputData

decodeLayout

decodeLayout(buffer: Uint8Array): Uint8Array

- Defined in index.ts:132
Decodes the provided buffer into a bit buffer

Parameters
- buffer: Uint8Array
  
  The buffer to decode
Returns Uint8Array

encode

encode(name: string, data: PacketInputData, buffer: Uint8Array): void

- Defined in index.ts:140
Encodes the layout data

Parameters
- name: string
  
  The name of the layout member to encode
- data: PacketInputData
  
  The packet data to encode
- buffer: Uint8Array
  
  The bit buffer to encode into
Returns void

encodeLayout

encodeLayout(buffer: Uint8Array): Uint8Array

- Defined in index.ts:126
Encodes the provided bit buffer into a buffer

Parameters
- buffer: Uint8Array
  
  The bit buffer to encode
Returns Uint8Array

getBitLength

getBitLength(): number

- Defined in index.ts:110
Returns the total bit length of the layout

Returns number

getBitStride

getBitStride(): number

- Defined in index.ts:115
Returns the bit stride of the layout

Returns number

getLength

getLength(): number

- Defined in index.ts:120
Returns the total length of the layout

Returns number

Static decodeAt

decodeAt(buffer: Uint8Array, bitOffset: number, bitLength: number, elementCount?: number): PacketOutputData

- Defined in index.ts:188
Manually decodes the layout data

Parameters
- buffer: Uint8Array
  
  The bit buffer to decode from
- bitOffset: number
  
  The bit offset to start decoding at
- bitLength: number
  
  The bit length to decode with
- elementCount: number = 0
  
  Optional element count to decode
Returns PacketOutputData

Static decodeLayout

decodeLayout(buffer: Uint8Array, bitStride?: number): Uint8Array

- Defined in index.ts:215
Decodes the provided buffer into a bit buffer

Parameters
- buffer: Uint8Array
  
  The buffer to decode
- bitStride: number = ...
  
  Optional custom bit stride to use
Returns Uint8Array

Static encodeLayout

encodeLayout(buffer: Uint8Array, bitStride?: number): Uint8Array

- Defined in index.ts:206
Encodes the provided bit buffer into a buffer

Parameters
- buffer: Uint8Array
  
  The bit buffer to encode
- bitStride: number = ...
  
  Optional custom bit stride to use
Returns Uint8Array

Generated using TypeDoc