Class PacketHeader

Holds the header information of a GNP packet.

Index

Constructors

Properties

command dataLength destination packetLength size source subcommand type

Methods

createReplyHeader getPacketId isEmpty createEventPacketHeader createReadPacketHeader createWritePacketHeader emptyPacket read

Constructors

constructor

new PacketHeader(
    destination: Address,
    source: Address,
    packetId: number | undefined,
    type: PacketType,
    subcommand: Subcommand,
    dataLength: number,
): PacketHeader
Parameters
- destination: Address
- source: Address
- packetId: number | undefined
- type: PacketType
- subcommand: Subcommand
- dataLength: number
Returns PacketHeader

Properties

`Readonly`command

command: Command

`Readonly`dataLength

dataLength: number

`Readonly`destination

destination: Address

`Readonly`packetLength

packetLength: number

`Readonly`size

size: number

`Readonly`source

source: Address

`Readonly`subcommand

subcommand: Subcommand

`Readonly`type

type: PacketType

Methods

createReplyHeader

createReplyHeader(dataLength: number): PacketHeader
Parameters
- dataLength: number
Returns PacketHeader

getPacketId

getPacketId(): number
Returns number

isEmpty

isEmpty(): boolean
Returns boolean

`Static`createEventPacketHeader

createEventPacketHeader(
    subcommand: Subcommand,
    destination: Address,
    dataLength: number,
): PacketHeader
Parameters
- subcommand: Subcommand
- destination: Address
- dataLength: number
Returns PacketHeader

`Static`createReadPacketHeader

createReadPacketHeader(
    subcommand: Subcommand,
    destination: Address,
    dataLength?: number,
): PacketHeader
Parameters
- subcommand: Subcommand
- destination: Address
- dataLength: number = 0
Returns PacketHeader

`Static`createWritePacketHeader

createWritePacketHeader(
    subcommand: Subcommand,
    destination: Address,
    dataLength: number,
): PacketHeader
Parameters
- subcommand: Subcommand
- destination: Address
- dataLength: number
Returns PacketHeader

`Static`emptyPacket

emptyPacket(
    destination: Address,
    source: Address,
    packetId: number,
    type: PacketType,
    subcommand: Subcommand,
): PacketHeader
Parameters
- destination: Address
- source: Address
- packetId: number
- type: PacketType
- subcommand: Subcommand
Returns PacketHeader

`Static`read

read(bytes: Uint8Array): PacketHeader
Parameters
- bytes: Uint8Array
Returns PacketHeader