iosignal 1.6.1 → 1.7.1

package/src/common/constants.js

@@ -1,159 +1,148 @@
-
-// IOclient state
-export const STATES = {
-  OPENING: 0,
-  OPEN: 1,
-  CLOSING: 2,
-  CLOSED: 3,
-  SERVER_READY: 4,
-  AUTH_FAIL: 5,
-  AUTH_READY: 6,
-  READY: 7,
-  REDIRECTING: 8
-}
-for (let c in STATES) { STATES[STATES[c]] = c }
-
-// server side client state
-export const CLIENT_STATE = {
-  INIT: 0,
-  SENT_SERVER_READY: 1,
-  RECV_AUTH_REQ: 2,
-  SENT_SERVER_NONCE: 3,
-  RECV_AUTH_HMAC: 4,
-  AUTH_FAIL: 5,
-  AUTH_READY: 6,
-  CID_READY: 7
-}
-for (let c in CLIENT_STATE) { CLIENT_STATE[CLIENT_STATE[c]] = c }
-
-export let ENC_MODE = {
-  NO: 0,
-  YES: 1,
-  AUTO: 2
-}
-
-for (let c in ENC_MODE) { ENC_MODE[ENC_MODE[c]] = c }
-
-
-export const SIZE_LIMIT = {
-  TAG_LEN1: 255,
-  TAG_LEN2: 65535,
-  CONNECTION_CHECKER_PERIOD: 3000,
-  PROMISE_TIMEOUT: 5000,
-  DID: 8,
-  CID: 12
-}
-
-export let PAYLOAD_TYPE = {
-  EMPTY: 0, 
-  TEXT: 1,
-  BINARY: 2, 
-  OBJECT: 3, // one stringify able object. no buffer.
-  MJSON: 4, // multiple stringify able obejct.  JSON string. with top levle array , no buffer
-  MBA: 5  // "meta_buffer_arguments" arbitary types.  buffer included.
-}
-for (let c in PAYLOAD_TYPE) { PAYLOAD_TYPE[PAYLOAD_TYPE[c]] = c }
-// console.log( PAYLOAD_TYPE )
-
-// MJSON: multiple arguments 
-// accepet only string, number, root depth js primittive object, 
-// unpack and will send to receiver handler with multiple params.
-
-// MBA: buffer pack of multiple arguments.  check "meta-buffer-pack" module. 
-// MBA: when armuents includes raw Buffer( TypedArray )
-
-// IO message pack one byte header. 
-export let IOMsg = {
-
-  /* 
-  * 0~127dec.  reserved. for text stream.
-  * 0~31: control code
-  * 32~126: ascii charactor
-  * 127: DEL
-  */
-  
-  // ADMIN_REQ: 0xA0,
-
-  // DO NOT USE: 0xB0~ 0xBF
-  // Boho module using this numbers.
-  // AUTH_REQ : 0xB0,  
-  // AUTH_NONCE: 0xB1,
-  // AUTH_HMAC: 0xB2,
-  // AUTH_ACK: 0xB3,
-  // AUTH_FAIL: 0xB4,
-  // AUTH_EXT: 0xB5,
-  // ENC_PACK : 0xB6,  
-  // ENC_E2E : 0xB7,  
-  // ENC_488 : 0xB8
-  // reserved ~0xBF
-
-  // C. IO status contorl.
-  SERVER_READY: 0xC0,
-  CID_REQ: 0xC1, 
-  CID_RES: 0xC2,  
-  QUOTA_LEVEL: 0xC3,
-  SERVER_CLEAR_AUTH: 0xC4, 
-  SERVER_REDIRECT: 0xC5,
-
-  // ..
-  LOOP: 0xCB,
-  ECHO: 0xCC,
-  PING: 0xCD,  
-  PONG: 0xCE,
-  CLOSE: 0xCF,
-  // ~CF
-
-
-  // D. IO data signaling
-  SIGNAL: 0xD0,  
-  SIGNAL_REQ: 0xD1, 
-  SIGNAL_E2E: 0xD2, 
-  SUBSCRIBE: 0xD3,
-  SUBSCRIBE_REQ: 0xD4, 
-  UNSUBSCRIBE: 0xD5, 
-  SERVER_SIGNAL: 0xD6, 
-
-  // ..
-  IAM: 0xD9,
-  IAM_RES: 0xDA,
-  
-  //.. 
-  SET: 0xDB,   //
-  RESPONSE_CODE: 0xDC,   
-  RESPONSE_MBP: 0xDD,   
-
-  REQUEST: 0xDE, //client public
-  RESPONSE: 0xDF,
-  // ~DF
-
-
-  // F. Framing Flow control related framing protocol.(CongPacket)
-  FLOW_MODE: 0xF0,
-  WAIT: 0xF1,
-  RESUME: 0xF2,
-  //..
-  TIME_OUT: 0xFD,
-  OVER_SIZE: 0xFE,
-  OVER_FLOW: 0xFF
-
-}
-
-for (let c in IOMsg) { IOMsg[IOMsg[c]] = c }
-
-// console.log( IOMsg );
-
-
-export const API_TYPE = {
-  'REQUEST_RESPONSE': 'requet_response',
-  'ONE_WAY': 'one_way'
-}
-
-
-
-// api response status code
-export const STATUS = {
-  OK: 0,
-  //0~127: success
-  //128~255: fail
-  ERROR: 255
-}
+
+// Client STATES: name and number
+export const STATES = {
+  OPENING: 0,
+  OPEN: 1,
+  CLOSING: 2,
+  CLOSED: 3,
+  SERVER_READY: 4,
+  AUTH_FAIL: 5,
+  AUTH_READY: 6,
+  READY: 7,
+  REDIRECTING: 8
+}
+for (let c in STATES) { STATES[STATES[c]] = c }
+
+// server side client state
+export const CLIENT_STATE = {
+  INIT: 0,
+  SENT_SERVER_READY: 1,
+  RECV_AUTH_REQ: 2,
+  SENT_SERVER_NONCE: 3,
+  RECV_AUTH_HMAC: 4,
+  AUTH_FAIL: 5,
+  AUTH_READY: 6,
+  CID_READY: 7
+}
+for (let c in CLIENT_STATE) { CLIENT_STATE[CLIENT_STATE[c]] = c }
+
+export let ENC_MODE = {
+  NO: 0,
+  YES: 1,
+  AUTO: 2
+}
+
+for (let c in ENC_MODE) { ENC_MODE[ENC_MODE[c]] = c }
+
+
+export const SIZE_LIMIT = {
+  TAG_LEN1: 255,
+  TAG_LEN2: 65535,
+  CONNECTION_CHECKER_PERIOD: 3000,
+  PROMISE_TIMEOUT: 5000,
+  DID: 8,
+  CID: 12
+}
+
+export let PAYLOAD_TYPE = {
+  EMPTY: 0,
+  TEXT: 1,
+  BINARY: 2,
+  OBJECT: 3, // one stringifiable object. it's string.
+  MJSON: 4, // multiple stringifiable obejct. it's top-level array JSON string.
+  MBA: 5  // "meta_buffer_arguments" arbitary types.  it's meta-buffer-pack.
+}
+for (let c in PAYLOAD_TYPE) { PAYLOAD_TYPE[PAYLOAD_TYPE[c]] = c }
+
+
+// IO message's one-byte headers.
+export let IOMsg = {
+
+  /* 
+  * 0~127dec.  reserved. for text stream.
+  * 0~31: control code
+  * 32~126: ascii charactor
+  * 127: DEL
+  */
+
+  // ADMIN_REQ: 0xA0,
+
+  // DO NOT USE: 0xB0~ 0xBF
+  // Boho module using this numbers.
+  // AUTH_REQ : 0xB0,  
+  // AUTH_NONCE: 0xB1,
+  // AUTH_HMAC: 0xB2,
+  // AUTH_ACK: 0xB3,
+  // AUTH_FAIL: 0xB4,
+  // AUTH_EXT: 0xB5,
+  // ENC_PACK : 0xB6,  
+  // ENC_E2E : 0xB7,  
+  // ENC_488 : 0xB8
+  // reserved ~0xBF
+
+  // C. IO status contorl.
+  SERVER_READY: 0xC0,
+  CID_REQ: 0xC1,
+  CID_RES: 0xC2,
+  QUOTA_LEVEL: 0xC3,
+  SERVER_CLEAR_AUTH: 0xC4,
+  SERVER_REDIRECT: 0xC5,
+
+  // ..
+  LOOP: 0xCB,
+  ECHO: 0xCC,
+  PING: 0xCD,
+  PONG: 0xCE,
+  CLOSE: 0xCF,
+  // ~CF
+
+
+  // D. IO data signaling
+  SIGNAL: 0xD0,
+  SIGNAL_REQ: 0xD1,
+  SIGNAL_E2E: 0xD2,
+  SUBSCRIBE: 0xD3,
+  SUBSCRIBE_REQ: 0xD4,
+  UNSUBSCRIBE: 0xD5,
+  SERVER_SIGNAL: 0xD6,
+
+  // ..
+  IAM: 0xD9,
+  IAM_RES: 0xDA,
+
+  //.. 
+  SET: 0xDB,   //
+  RESPONSE_CODE: 0xDC,
+  RESPONSE_MBP: 0xDD,
+
+  REQUEST: 0xDE, //client public
+  RESPONSE: 0xDF,
+  // ~DF
+
+
+  // F. Framing Flow control related framing protocol.(CongPacket)
+  FLOW_MODE: 0xF0,
+  WAIT: 0xF1,
+  RESUME: 0xF2,
+  //..
+  TIME_OUT: 0xFD,
+  OVER_SIZE: 0xFE,
+  OVER_FLOW: 0xFF
+
+}
+
+for (let c in IOMsg) { IOMsg[IOMsg[c]] = c }
+// console.log( IOMsg );
+
+export const API_TYPE = {
+  'REQUEST_RESPONSE': 'requet_response',
+  'ONE_WAY': 'one_way'
+}
+
+// api response status code
+export const STATUS = {
+  OK: 0,
+  //0~127: success
+  //128~255: fail
+  ERROR: 255
+}

package/src/common/payload.js

@@ -1,83 +1,82 @@
-import { MBP } from 'meta-buffer-pack'
-import { PAYLOAD_TYPE, IOMsg } from "./constants.js";
-const encoder = new TextEncoder()
-
-
-export function getSignalPack( tag, ...args ){
-  if( typeof tag !== 'string') throw TypeError('tag should be string.')
-  let tagEncoded = encoder.encode( tag)
-  let payload = parsePayload( args )
-
-  let sigPack;
-  if( payload.type == PAYLOAD_TYPE.EMPTY ){
-    sigPack = MBP.pack( 
-      MBP.MB('#MsgType','8', IOMsg.SIGNAL) , 
-      MBP.MB('#tagLen','8', tagEncoded.byteLength),
-      MBP.MB('#tag', tagEncoded),
-      MBP.MB('#payloadType', '8', payload.type )
-      )
-  }else if( payload.type == PAYLOAD_TYPE.MBA ){
-    let mbaBuffer = MBP.pack( MBP.MBA(...args))
-    sigPack = MBP.pack( 
-      MBP.MB('#MsgType','8', IOMsg.SIGNAL) , 
-      MBP.MB('#tagLen','8', tagEncoded.byteLength),
-      MBP.MB('#tag', tagEncoded),
-      MBP.MB('#payloadType', '8', payload.type ),
-      MBP.MB('#mbaBuffer', mbaBuffer )
-      )
-  }else { 
-    sigPack = MBP.pack( 
-      MBP.MB('#MsgType','8', IOMsg.SIGNAL) , 
-      MBP.MB('#tagLen','8', tagEncoded.byteLength),
-      MBP.MB('#tag', tagEncoded),
-      MBP.MB('#payloadType', '8', payload.type ),
-      MBP.MB('#payload', payload.buffer )
-      )
-  }
-  return sigPack
-}
-
-
-export function parsePayload( args){
-  let type, pack;
-  if( args.length == 0){
-    type = PAYLOAD_TYPE.EMPTY 
-    pack = null
-  }else if( args.length == 1){
-    if( typeof args[0] === 'string' || typeof args[0] === 'number'){
-     type = PAYLOAD_TYPE.TEXT
-     pack = encoder.encode( args[0] + ".") // add null area.
-     pack[pack.byteLength - 1 ] = 0 // set null.
-
-    }else if( ArrayBuffer.isView( args[0]) || args[0] instanceof ArrayBuffer ){  //one buffer
-      type = PAYLOAD_TYPE.BINARY
-      pack = MBP.B8( args[0 ] )
-    }else if(typeof args[0] === 'object'){ 
-      type = PAYLOAD_TYPE.OBJECT
-      pack = encoder.encode( JSON.stringify( args[0]) )
-    }else{
-      throw new Error('unknown payload arguments')
-    }
-  }else{ // args 2 and more
-    let containsBuffer = false
-    args.forEach( item =>{
-      if( ArrayBuffer.isView( item ) || item instanceof ArrayBuffer ) containsBuffer = true;
-    })
-
-    if( containsBuffer ){
-      type = PAYLOAD_TYPE.MBA;
-    }else{
-      type = PAYLOAD_TYPE.MJSON;
-        // args is array
-      pack = encoder.encode( JSON.stringify( args ) )
-    }
-    
-  }
-  
-  return { type: type, buffer: pack }
-}
-
-export function getPayloadFromSignalPack( signalPack ){
-  let tagLen = signalPack.readUint8(1)
-  return signalPack.subarray(3 + tagLen)
+import { MBP } from 'meta-buffer-pack'
+import { PAYLOAD_TYPE, IOMsg } from "./constants.js";
+const encoder = new TextEncoder()
+
+
+export function getSignalPack(tag, ...args) {
+  if (typeof tag !== 'string') throw TypeError('tag should be string.')
+  let tagEncoded = encoder.encode(tag)
+  let payload = parsePayload(args)
+
+  let sigPack;
+  if (payload.type == PAYLOAD_TYPE.EMPTY) {
+    sigPack = MBP.pack(
+      MBP.MB('#MsgType', '8', IOMsg.SIGNAL),
+      MBP.MB('#tagLen', '8', tagEncoded.byteLength),
+      MBP.MB('#tag', tagEncoded),
+      MBP.MB('#payloadType', '8', payload.type)
+    )
+  } else if (payload.type == PAYLOAD_TYPE.MBA) {
+    let mbaBuffer = MBP.pack(MBP.MBA(...args))
+    sigPack = MBP.pack(
+      MBP.MB('#MsgType', '8', IOMsg.SIGNAL),
+      MBP.MB('#tagLen', '8', tagEncoded.byteLength),
+      MBP.MB('#tag', tagEncoded),
+      MBP.MB('#payloadType', '8', payload.type),
+      MBP.MB('#mbaBuffer', mbaBuffer)
+    )
+  } else {
+    sigPack = MBP.pack(
+      MBP.MB('#MsgType', '8', IOMsg.SIGNAL),
+      MBP.MB('#tagLen', '8', tagEncoded.byteLength),
+      MBP.MB('#tag', tagEncoded),
+      MBP.MB('#payloadType', '8', payload.type),
+      MBP.MB('#payload', payload.buffer)
+    )
+  }
+  return sigPack
+}
+
+
+export function parsePayload(args) {
+  let type, pack;
+  if (args.length == 0) {
+    type = PAYLOAD_TYPE.EMPTY
+    pack = null
+  } else if (args.length == 1) {
+    if (typeof args[0] === 'string' || typeof args[0] === 'number') {
+      type = PAYLOAD_TYPE.TEXT
+      pack = encoder.encode(args[0] + ".") // add null byte area.
+      pack[pack.byteLength - 1] = 0 // set byte-zero : '\0'  in C/C++
+
+    } else if (ArrayBuffer.isView(args[0]) || args[0] instanceof ArrayBuffer) {
+      type = PAYLOAD_TYPE.BINARY
+      pack = MBP.B8(args[0])
+    } else if (typeof args[0] === 'object') {
+      type = PAYLOAD_TYPE.OBJECT
+      pack = encoder.encode(JSON.stringify(args[0]))
+    } else {
+      throw new Error('unknown payload arguments')
+    }
+  } else { // two or more arguments.
+    let containsBuffer = false
+    args.forEach(item => {
+      if (ArrayBuffer.isView(item) || item instanceof ArrayBuffer) containsBuffer = true;
+    })
+
+    if (containsBuffer) {
+      type = PAYLOAD_TYPE.MBA;
+    } else {
+      type = PAYLOAD_TYPE.MJSON;
+      pack = encoder.encode(JSON.stringify(args))
+    }
+
+  }
+
+  return { type: type, buffer: pack }
+}
+
+export function getPayloadFromSignalPack(signalPack) {
+  let tagLen = signalPack.readUint8(1)
+  return signalPack.subarray(3 + tagLen)
 }

package/src/common/quotaTable.js

@@ -1,68 +1,68 @@
-// table index related with:
-// - AUTH database level
-// - serverOption.defaultQuotaIndex
-
-// quota example
-// index range: 0~255.
-export let quotaTable = {
-  // CongSocket
-  0: { // default. anonymouse:
-    signalSize: 1500,
-    publishCounter: 10,
-    trafficRate: 10000
-  },
-  1: { // auth_ultralight:  eg. Arduino Uno.
-    signalSize: 255,
-    publishCounter: 10,
-    trafficRate: 100000
-  },
-  2: { // auth_light:  eg. authorized ESP.
-    signalSize: 65535,
-    publishCounter: 10,
-    trafficRate: 1048576
-  },
-
-  // WebSocket (browser and node app)
-  3: { // authorized basic.
-    signalSize: 1048576,  
-    publishCounter: 10,
-    trafficRate: 1048576 * 20
-  },
-
-  // WebSocket (browser and node app)
-  10: { //  anonymouse
-    signalSize: 1500,  
-    publishCounter: 5,
-    trafficRate: 1048576 * 20
-  },
-
-  11: { // authorized basic.
-    signalSize: 65535,  
-    publishCounter: 10,
-    trafficRate: 1048576 * 20
-  },
-  
-  12: { // authorized power.
-    signalSize: 1048576,  
-    publishCounter: 100,
-    trafficRate: 1048576 * 20
-  },
-  
-  // you can add your custom quota level.
-
-  // Remote service node
-  // High Quota, No root permission.
-  200: { 
-    signalSize: 1048576 * 20,
-    publishCounter: 10000,
-    trafficRate: 1048576 * 100
-  },
-  // super admin or root user.
-  // to monitor, metric, sudo command, db acess
-  255: { 
-    signalSize: 1048576 * 20,
-    publishCounter: 10000,
-    trafficRate: 1048576 * 100
-  }
-}
-
+// table index related with:
+// - AUTH database level
+// - serverOption.defaultQuotaIndex
+
+// quota example
+// index range: 0~255.
+export let quotaTable = {
+  // CongSocket
+  0: { // default. anonymouse:
+    signalSize: 1500,
+    publishCounter: 10,
+    trafficRate: 10000
+  },
+  1: { // auth_ultralight:  eg. Arduino Uno.
+    signalSize: 255,
+    publishCounter: 10,
+    trafficRate: 100000
+  },
+  2: { // auth_light:  eg. authorized ESP.
+    signalSize: 65535,
+    publishCounter: 10,
+    trafficRate: 1048576
+  },
+
+  // WebSocket (browser and node app)
+  3: { // authorized basic.
+    signalSize: 1048576,
+    publishCounter: 10,
+    trafficRate: 1048576 * 20
+  },
+
+  // WebSocket (browser and node app)
+  10: { //  anonymouse
+    signalSize: 1500,
+    publishCounter: 5,
+    trafficRate: 1048576 * 20
+  },
+
+  11: { // authorized basic.
+    signalSize: 65535,
+    publishCounter: 10,
+    trafficRate: 1048576 * 20
+  },
+
+  12: { // authorized power.
+    signalSize: 1048576,
+    publishCounter: 100,
+    trafficRate: 1048576 * 20
+  },
+
+  // you can add your custom quota levels.
+
+  // Remote service node
+  // High Quota, No root permission.
+  200: {
+    signalSize: 1048576 * 20,
+    publishCounter: 10000,
+    trafficRate: 1048576 * 100
+  },
+  // super admin or root user.
+  // to monitor, metric, sudo command, db access.
+  255: {
+    signalSize: 1048576 * 20,
+    publishCounter: 10000,
+    trafficRate: 1048576 * 100
+  }
+}
+