@genie-networks/gcl_gsonjs v0.1.32

gcl_gsonjs

Genie Common Library - GSON js

changeLog

• 0.1.32 sync with company Library
• 0.1.7 Chaneg Readme.md syntax
• 0.1.6 remove Oper.Reg

Install

npm install @genie-networks/gcl_gsonjs

Usage

/* Require gclGson */
const gclGson = require('gcl_gsonjs')

/* Construct value for each type */
let myNum = 3

let myStr = 'hello'

let myBool = true

let myNull = null

let myUndefine

let myIndex = new gclGson.Index(true, false, 100, 1)

let myDate = new Date()

let myPair = new gclGson.Pair('null', 2)

let myOper = new gclGson.Oper(0x10)

let myBin = new gclGson.Bin([1, 2, 3, 4, 5])

let myUuid = new gclGson.Uuid()

let myMac = new gclGson.Mac('0f:ff:03:04:05:06')

let myDerive = new gclGson.Derive(100)

let myIp = new gclGson.Ip([192, 168, 0, 1])

let myIpv6 = new gclGson.Ip('FE00:1234::1')

let myCidr = new gclGson.Cidr('192.168.0.0/16')

let myTag = new gclGson.Tag(0x12345678123456781, false)

let myArr = [1, "s", myTag]

let myPair = new gclGson.Pair('null', 2)

let myDoc = {x:1, y:"str"}

// Get size for serialize buffer
let bufferSize = gclGson.calcSize(myDoc)

// serialize value
let buf = Buffer.alloc(gclGson.calcSize(myDoc), 0x00)
gclGson.serialize(myDoc, buf, 0)

// deserialize
let desDoc = gclGson.deserialize(buf)

// toJSON
let jsonObj = myDoc.toJSON()

// construct a GSON value from a JSON value
let gsonDoc = gclGson.fromJSON(jsonObj)

// Print as GSON format
console.log(gclGson.print(myDoc))

// Print as GSON format without quotation marks
console.log(gclGson.toString(myDoc))

// serialize GSON and import to a file
gclGson.exportFile(myDoc, 'somewhere')

// Import and deserialize GSON from a file
let importDoc = gclGson.importFile('somewhere')

Class

• gclGsonOper - Operator
• gclGsonBin - Binary
• gclGsonTag - Tag
• gclGsonIndex - Index
• gclGsonPair - Pair
• gclGsonUuid - uuid
• gclGsonMac - MAC
• gclGsonIp - IPv4/IPv6
• gclGsonDerive - Derive

Method

• toJSON(gson_obj)
• fromJSON(json_obj)
• calcSize(gson_obj)
• print(gson_obj)
• deserialize(buffer)
• serialize(gson_obj, buffer, offset)
• exportFile(gson_obj, filePath) - retrun a promise
• importFile(filePath) - return a promise and resolve gson_obj

SPEC

Type System

• Simple
  • Undefined represents the unexpected absence of value.
  • Null represents the intentional absence of value.
  • Boolean represents a logical data that can have only the values true or false.
  • Date represents the number of milliseconds since 1 January, 1970 UTC.
  • Number represents a double-precision floating point number.
  • Oper represents a software defined operator.
  • Index represents an 64-bit database index with 2-bit direction flag.
  • String represents a null-terminated UTF-8 string.
  • Bin represents a byte array.
  • Uuid represents universally unique identifier defined by RFC-4122.
  • Mac represents MAC address.
  • Derive represents a derive function ID.
  • Ip represents IPv4 or IPv6 address.
  • Cidr represents IPv4 or IPv6 CIDR.
  • Tag represents tagged id with 1-bit boundary flag.
• Complex
  • Array represents a sequence of elements, each is a GSON value.
  • Doc represents a sequence of fields, each is a key-value pair.
    • The type of key must be a Number or String.
    • The type of value could be any GSON value.
  • Pair represents a pair of values.

Value Format

• 1{uint} is 8-bits unsigned integer in host order.
• 2{uint} is 16-bits unsigned integer in host order.
• 4{uint} is 32-bits unsigned integer in host order.
• 8{uint} is 64-bits unsigned integer in host order.
• 8{double} is 64-bits double precision floating number in host order.
• 1{code} is 8-bits unsigned integer in host order.
• 1{len}: is 8-bits unsigned integer indicates number of values.
• 2{len}: is 16-bits unsigned integer indicates number of values.
• 4{len}: is 32-bits unsigned integer indicates number of values.
• 1{size}: is 8-bits unsigned integer indicates number of bytes.
• 2{size}: is 16-bits unsigned integer indicates number of bytes.
• 4{size}: is 32-bits unsigned integer indicates number of bytes.
• *{char} is null-terminated string.
• *{data} is variable size byte array
• 16{uuid}: is 128-bits UUID in RFC-4122 format.
• 6{mac} is 48-bits mac address
• 4{ip} is 32-bits ipv4 address
• 16{ip} is 128-bits ipv6 address
• {value} is a serialized GSON value.
• *{value} is zero or more serialized GSON values.

Type String

Text Format

JSON Format

JavaScript Implement

• simple
  • Undefined is mapped to the standard value undefined.
  • Null is mapped to the standard value null.
  • Boolean is mapped to the standard class Boolean.
  • Date is mapped to the standard class Date.
  • Number is mapped to the standard class Number.
  • Oper is mapped to the proprietry class gclGsonOper.
  • Index is mapped to the proprietry class gclGsonIndex.
  • String is mapped to the standard class String.
  • Bin is mapped to the proprietry class gclGsonBin.
  • Uuid is mapped to the proprietry class gclGsonUuid.
  • Mac is mapped to the proprietry class gclGsonMac.
  • Ip is mapped to the proprietry class gclGsonIp.
  • Cidr is mapped to the proprietry class gclGsonCidr.
  • Tag is mapped to the proprietry class gclGsonTag.
  • Derive is mapped to the proprietry class gclGsonDerive.

• complex

  • Array is map to the standard class Array.
  • Doc is map to the standard class Object.
  • Pair is map to the proprietry class gclGsonPair.