Class ZapDatagram

An object that represents the encoded bytes on a single datagram.

ZAPP(Zap Protocol) is network protocol defined on top of UDP datagram, enabling the exchange of 'Zapable' data between client and server. For further details about the protocol, refer to the ZAPP section in the Zap Documentation.

Hierarchy

ZapDatagram

Index

Constructors

Properties

Methods

Constructors

constructor

new ZapDatagram(header, payload): ZapDatagram
Parameters
- header: ZappHeader
- payload: Buffer
Returns ZapDatagram
- Defined in models/ZappObject.ts:17

Properties

header

header: ZappHeader

A header part.

payload

payload: Buffer

A payload part.

Methods

toBuffer

toBuffer(): Buffer
Encode ZappObject to ByteBuffer. The sequence of bytes is MUST encoded as ZAPP Object.

Returns Buffer
- Defined in models/ZappObject.ts:25

`Static` from

from(buf): ZapDatagram
Decode the given ByteBuffer in received datagram to ZappObject.
Parameters
- buf: Buffer
  A ByteBuffer to convert that MUST be encoded as ZAPP Object.
Returns ZapDatagram
- Defined in models/ZappObject.ts:40

Generated using TypeDoc