Class Packet

Packet represents a GN Protocol packet. A GN Protocol packet consists of a header followed by optional payload data.

Index

Constructors

Properties

command data destination header length source subcommand type

Methods

createReply ensurePacketId getBytes headerSize packetId toString createEventPacket createReadPacket createWritePacket read

Constructors

constructor

new Packet(header: PacketHeader, data?: PacketData): Packet
Parameters
- header: PacketHeader
- data: PacketData = PacketData.empty
Returns Packet

Properties

`Readonly`command

command: Command

`Readonly`data

data: PacketData

`Readonly`destination

destination: Address

`Readonly`header

header: PacketHeader

`Readonly`length

length: number

`Readonly`source

source: Address

`Readonly`subcommand

subcommand: Subcommand

`Readonly`type

type: PacketType

Methods

createReply

createReply(data: PacketData): Packet
Parameters
- data: PacketData
Returns Packet

ensurePacketId

ensurePacketId(): void
Returns void

getBytes

getBytes(): Uint8Array
Returns Uint8Array

headerSize

headerSize(): number
Returns number

packetId

packetId(): number
Returns number

toString

toString(): string
Returns string

`Static`createEventPacket

createEventPacket(
    subcommand: Subcommand,
    destination: Address,
    data?: PacketData,
): Packet
Parameters
- subcommand: Subcommand
- destination: Address
- data: PacketData = PacketData.empty
Returns Packet

`Static`createReadPacket

createReadPacket(
    subcommand: Subcommand,
    destination: Address,
    data?: PacketData,
): Packet
Parameters
- subcommand: Subcommand
- destination: Address
- data: PacketData = PacketData.empty
Returns Packet

`Static`createWritePacket

createWritePacket(
    subcommand: Subcommand,
    destination: Address,
    data?: PacketData,
): Packet
Parameters
- subcommand: Subcommand
- destination: Address
- data: PacketData = PacketData.empty
Returns Packet

`Static`read

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