Options
All
  • Public
  • Public/Protected
  • All
Menu

Module structs

This module implements parsing / formatting routines for Netlink and Generic Netlink structures.

Important: These structures use the host endianness. This module will serialize messages differently depending on that.

Index

Classes

Interfaces

Type aliases

Variables

Functions

Type aliases

GetArrayOptions

GetArrayOptions: { zero?: boolean }

Type declaration

  • Optional zero?: boolean

ParseResult

ParseResult<T>: { consumed: number; x: T }

Type parameters

  • T

Type declaration

  • consumed: number
  • x: T

StreamData

StreamData: Uint8Array | Uint8Array[] | ((out: AttrStream) => any)

Object allowing efficient construction of an attribute stream.

Variables

Const GENL_HEADER_LENGTH

GENL_HEADER_LENGTH: 4 = 4

Length of generic netlink headers

Const HEADER_LENGTH

HEADER_LENGTH: 16 = 16

Length of netlink headers

Functions

align

  • align(x: number): number

  • Round the passed length up to align it

    Parameters

    • x: number

    Returns number

countLength

  • countLength(x: Uint8Array | Uint8Array[]): number

  • Parameters

    • x: Uint8Array | Uint8Array[]

    Returns number

ensureArray

  • ensureArray(x: Uint8Array | Uint8Array[]): Uint8Array[]

  • Parameters

    • x: Uint8Array | Uint8Array[]

    Returns Uint8Array[]

formatAttribute

formatGenlHeader

formatHeader

formatMessage

getArray

  • getArray<T>(x: Buffer, fn: (item: Buffer) => T, options?: GetArrayOptions): T[]

  • Type parameters

    • T

    Parameters

    • x: Buffer
    • fn: (item: Buffer) => T
        • (item: Buffer): T

        • Parameters

          • item: Buffer

          Returns T

    • Optional options: GetArrayOptions

    Returns T[]

getBool

  • getBool(x: Buffer): boolean

getEnum

  • getEnum<R>(mapping: {}, x: number): number | keyof R

  • Type parameters

    • R

    Parameters

    • mapping: {}
      • [key: number]: string
    • x: number

    Returns number | keyof R

getF32

  • getF32(x: Buffer): number

getF64

  • getF64(x: Buffer): number

getFlag

  • getFlag(x: Buffer): true

getMap

  • getMap<T>(x: Buffer, fn: (item: Buffer) => T): Map<number, T>

  • Type parameters

    • T

    Parameters

    • x: Buffer
    • fn: (item: Buffer) => T
        • (item: Buffer): T

        • Parameters

          • item: Buffer

          Returns T

    Returns Map<number, T>

getObject

  • getObject<T>(x: Buffer, fns: {}): T

  • Type parameters

    Parameters

    • x: Buffer
    • fns: {}
      • [key: number]: (data: Buffer, obj: T) => any
          • (data: Buffer, obj: T): any

          • Parameters

            • data: Buffer
            • obj: T

            Returns any

    Returns T

getPadding

  • getPadding(x: number): Buffer

  • Like padding but returns a zero-filled buffer of that length

    Parameters

    • x: number

    Returns Buffer

getS16

  • getS16(x: Buffer): number

getS32

  • getS32(x: Buffer): number

getS64

  • getS64(x: Buffer): bigint

getS8

  • getS8(x: Buffer): number

getString

  • getString(x: Buffer, options?: { encoding?: BufferEncoding; maxLength: number }): string

  • Parameters

    • x: Buffer
    • Optional options: { encoding?: BufferEncoding; maxLength: number }
      • Optional encoding?: BufferEncoding
      • maxLength: number

    Returns string

getU16

  • getU16(x: Buffer): number

getU16be

  • getU16be(x: Buffer): number

getU32

  • getU32(x: Buffer): number

getU32be

  • getU32be(x: Buffer): number

getU64

  • getU64(x: Buffer): bigint

getU8

  • getU8(x: Buffer): number

pad

  • pad(x: Uint8Array[]): Uint8Array[]

  • Append necessary padding to data. THIS MODIFIES THE ORIGINAL ARRAY

    Parameters

    • x: Uint8Array[]

    Returns Uint8Array[]

padding

  • padding(x: number): number

  • Get the amount of padding (in bytes) to add after length

    Parameters

    • x: number

    Returns number

parseAttribute

parseAttributes

parseError

parseGenlHeader

parseHeader

parseMessage

parseMessages

  • Calls parseMessage repeatedly, ignoring padding between messages, until there's no data left (other than padding).

    retrns

    Array of parsed messages

    Parameters

    • r: Buffer

    Returns NetlinkMessage[]

putArray

putBool

  • putBool(x: boolean): Buffer

putEnum

  • putEnum<R>(mapping: { [ key in string | number | symbol]: number }, x: number | keyof R): number

  • Type parameters

    • R

    Parameters

    • mapping: { [ key in string | number | symbol]: number }
    • x: number | keyof R

    Returns number

putF32

  • putF32(x: number): Buffer

putF64

  • putF64(x: number): Buffer

putFlag

  • putFlag(x: true): Buffer

putMap

putObject

putS16

  • putS16(x: number): Buffer

putS32

  • putS32(x: number): Buffer

putS64

  • putS64(x: bigint): Buffer

putS8

  • putS8(x: number): Buffer

putString

  • putString(x: string, options?: { encoding?: BufferEncoding; maxLength: number }): Buffer

  • Parameters

    • x: string
    • Optional options: { encoding?: BufferEncoding; maxLength: number }
      • Optional encoding?: BufferEncoding
      • maxLength: number

    Returns Buffer

putU16

  • putU16(x: number): Buffer

putU16be

  • putU16be(x: number): Buffer

putU32

  • putU32(x: number): Buffer

putU32be

  • putU32be(x: number): Buffer

putU64

  • putU64(x: bigint): Buffer

putU8

  • putU8(x: number): Buffer

readF32

  • readF32(offset?: number): number

  • Parameters

    • Optional offset: number

    Returns number

readF64

  • readF64(offset?: number): number

  • Parameters

    • Optional offset: number

    Returns number

readS16

  • readS16(offset?: number): number

  • Parameters

    • Optional offset: number

    Returns number

readS32

  • readS32(offset?: number): number

  • Parameters

    • Optional offset: number

    Returns number

readS64

  • readS64(offset?: number): bigint

  • Parameters

    • Optional offset: number

    Returns bigint

readS8

  • readS8(offset?: number): number

  • Parameters

    • Optional offset: number

    Returns number

readU16

  • readU16(offset?: number): number

  • Parameters

    • Optional offset: number

    Returns number

readU16be

  • readU16be(offset?: number): number

  • Parameters

    • Optional offset: number

    Returns number

readU32

  • readU32(offset?: number): number

  • Parameters

    • Optional offset: number

    Returns number

readU32be

  • readU32be(offset?: number): number

  • Parameters

    • Optional offset: number

    Returns number

readU64

  • readU64(offset?: number): bigint

  • Parameters

    • Optional offset: number

    Returns bigint

readU8

  • readU8(offset?: number): number

  • Parameters

    • Optional offset: number

    Returns number

writeF32

  • writeF32(value: number, offset?: number): number

  • Parameters

    • value: number
    • Optional offset: number

    Returns number

writeF64

  • writeF64(value: number, offset?: number): number

  • Parameters

    • value: number
    • Optional offset: number

    Returns number

writeS16

  • writeS16(value: number, offset?: number): number

  • Parameters

    • value: number
    • Optional offset: number

    Returns number

writeS32

  • writeS32(value: number, offset?: number): number

  • Parameters

    • value: number
    • Optional offset: number

    Returns number

writeS64

  • writeS64(value: bigint, offset?: number): number

  • Parameters

    • value: bigint
    • Optional offset: number

    Returns number

writeS8

  • writeS8(value: number, offset?: number): number

  • Parameters

    • value: number
    • Optional offset: number

    Returns number

writeU16

  • writeU16(value: number, offset?: number): number

  • Parameters

    • value: number
    • Optional offset: number

    Returns number

writeU16be

  • writeU16be(value: number, offset?: number): number

  • Parameters

    • value: number
    • Optional offset: number

    Returns number

writeU32

  • writeU32(value: number, offset?: number): number

  • Parameters

    • value: number
    • Optional offset: number

    Returns number

writeU32be

  • writeU32be(value: number, offset?: number): number

  • Parameters

    • value: number
    • Optional offset: number

    Returns number

writeU64

  • writeU64(value: bigint, offset?: number): number

  • Parameters

    • value: bigint
    • Optional offset: number

    Returns number

writeU8

  • writeU8(value: number, offset?: number): number

  • Parameters

    • value: number
    • Optional offset: number

    Returns number

Generated using TypeDoc