Class ObfuscatedPacketCodec

Interface declaring handling of received packets. When receiving a packet, its content is sent to feed(), and codec is supposed to emit packet or error event when packet is parsed.

Implements

Constructors

constructor

Methods

decode encode reset setup tag

Constructors

constructor

Methods

decode

  • decode(reader: Bytes, eof: boolean): Promise<null | Uint8Array>

  • Decode a frame from a buffer

    Important implementation notice: When returning byte arrays, make sure that the returned array is not a view into the original buffer, as the underlying buffer may get invalidated

    Parameters

    • reader: Bytes
    • eof: boolean

    Returns Promise<null | Uint8Array>

encode

  • encode(packet: Uint8Array, into: ISyncWritable): Promise<void>

  • Encode a frame into a writable stream

    Parameters

    • packet: Uint8Array
    • into: ISyncWritable

    Returns Promise<void>

reset

  • reset(): void

  • Reset the encoder, should it have any internal state

    Returns void

setup

  • setup(crypto: ICryptoProvider, log: Logger): void

  • For codecs that use crypto functions and/or logging. This method is called before any other.

    Parameters

    Returns void

tag

  • tag(): Promise<Uint8Array>

  • Initial tag of the codec. Will be sent immediately once connected.

    Returns Promise<Uint8Array>

Settings

Member Visibility

On This Page

Constructors
Methods