Class Packet

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

Index

Constructors

Methods

createReply ensurePacketId getBytes headerSize packetId toString createEventPacket createReadPacket createWritePacket read

Properties

command data destination header length source subcommand type

Constructors

constructor

new Packet(header: PacketHeader, data?: PacketData): Packet
Parameters
- header: PacketHeader
- data: PacketData = PacketData.empty
Returns Packet
- Defined in modules/core/src/gnp/Packet.ts:15

Methods

createReply

createReply(data: PacketData): Packet
Parameters
- data: PacketData
Returns Packet
- Defined in modules/core/src/gnp/Packet.ts:138

ensurePacketId

ensurePacketId(): void
Returns void
- Defined in modules/core/src/gnp/Packet.ts:105

getBytes

getBytes(): Uint8Array
Returns Uint8Array
- Defined in modules/core/src/gnp/Packet.ts:113

headerSize

headerSize(): number
Returns number
- Defined in modules/core/src/gnp/Packet.ts:89

packetId

packetId(): number
Returns number
- Defined in modules/core/src/gnp/Packet.ts:109

toString

toString(): string
Returns string
- Defined in modules/core/src/gnp/Packet.ts:134

`Static`createEventPacket

createEventPacket(
    subcommand: Subcommand,
    destination: Address,
    data?: PacketData,
): Packet
Parameters
- subcommand: Subcommand
- destination: Address
- data: PacketData = PacketData.empty
Returns Packet
- Defined in modules/core/src/gnp/Packet.ts:60

`Static`createReadPacket

createReadPacket(
    subcommand: Subcommand,
    destination: Address,
    data?: PacketData,
): Packet
Parameters
- subcommand: Subcommand
- destination: Address
- data: PacketData = PacketData.empty
Returns Packet
- Defined in modules/core/src/gnp/Packet.ts:30

`Static`createWritePacket

createWritePacket(
    subcommand: Subcommand,
    destination: Address,
    data?: PacketData,
): Packet
Parameters
- subcommand: Subcommand
- destination: Address
- data: PacketData = PacketData.empty
Returns Packet
- Defined in modules/core/src/gnp/Packet.ts:45

`Static`read

read(bytes: Uint8Array): Packet
Parameters
- bytes: Uint8Array
Returns Packet
- Defined in modules/core/src/gnp/Packet.ts:75

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