iosignal 1.6.1 → 1.7.0

package/src/client/IOWS.js

@@ -2,16 +2,16 @@ import { IOCore } from "./IOCore.js";
 import { WebSocket } from "ws";
 
 //  Node.js 'ws' websocket
-export class IOWS extends IOCore{
-  constructor(url  ) {
+export class IOWS extends IOCore {
+  constructor(url) {
     super(url);
-    if(url) this.open();
+    if (url) this.open();
   }
 
-  
+
 
   close() {
-    if(this.socket ){
+    if (this.socket) {
       this.socket.onclose = null
       this.socket.onmessage = null
       this.socket.onerror = null
@@ -28,52 +28,51 @@ export class IOWS extends IOCore{
     clearInterval(this.connectionCheckerIntervalID);
     this.connectionCheckerIntervalID = null
   }
-  
+
   keepAlive() {
-    if ( !this.socket || this.socket?.readyState === 3 ) { //closed
+    if (!this.socket || this.socket?.readyState === 3) {
       this.open();
     }
   }
 
 
-  createConnection(url){
+  createConnection(url) {
     // node WebSocket
-    this.socket = new WebSocket ( url );
+    this.socket = new WebSocket(url);
     this.stateChange('opening')
 
     this.socket.onopen = () => {
-      this.socket.on('message', this.onWebSocketMessage.bind(this) );
-      this.emit('open' );
+      this.socket.on('message', this.onWebSocketMessage.bind(this));
+      this.emit('open');
     };
 
-    this.socket.onerror = (e)=>{ 
+    this.socket.onerror = (e) => {
       this.emit('error', e)
     }
 
-    this.socket.onclose = ()=>{ 
-      this.emit('close' );
+    this.socket.onclose = () => {
+      this.emit('close');
     }
   }
 
-  onWebSocketMessage( data  ) {
+  onWebSocketMessage(data) {
     this.rxCounter++;
     this.lastTxRxTime = Date.now();
     this.rxBytes += data.byteLength
-    this.emit('socket_data', data  );
+    this.emit('socket_data', data);
   }
 
-  socket_send(data) {  
-    if( this.socket?.readyState === 1 ){ //open
-      // console.log('websocket send', data)
-      this.socket.send( data )
+  socket_send(data) {
+    if (this.socket?.readyState === 1) {
+      this.socket.send(data)
       this.txCounter++;
       this.txBytes += data.byteLength
       this.lastTxRxTime = Date.now();
-    }else{
-      console.log('')
+    } else {
+      console.log('.')
     }
   }
- 
+
 }
 
 

package/src/client/IOWebSocket.js

@@ -40,7 +40,7 @@ export class IO extends IOCore {
 
 
   keepAlive() {
-    if (!this.socket || this.socket?.readyState === 3) { //closed
+    if (!this.socket || this.socket?.readyState === 3) {
       this.open();
     }
   }
@@ -86,10 +86,10 @@ export class IO extends IOCore {
     this.rxCounter++;
     this.lastTxRxTime = Date.now();
     let buffer;
-    if( event.data instanceof Blob){
+    if (event.data instanceof Blob) {
       let ab = await event.data.arrayBuffer()
       buffer = Buffer.from(ab)
-    }else{
+    } else {
       buffer = Buffer.from(event.data)
     }
     this.rxBytes += buffer.byteLength
@@ -97,8 +97,7 @@ export class IO extends IOCore {
   }
 
   socket_send(data) {
-    if (this.socket?.readyState === 1) { //open
-      // console.log('websocket send', data)
+    if (this.socket?.readyState === 1) {
       this.socket.send(data)
       this.txCounter++;
       this.txBytes += data.byteLength

package/src/common/constants.js

@@ -1,5 +1,5 @@
 
-// IOclient state
+// Client STATES: name and number
 export const STATES = {
   OPENING: 0,
   OPEN: 1,
@@ -45,24 +45,17 @@ export const SIZE_LIMIT = {
 }
 
 export let PAYLOAD_TYPE = {
-  EMPTY: 0, 
+  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.
+  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 }
-// 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. 
+// IO message's one-byte headers.
 export let IOMsg = {
 
   /* 
@@ -71,7 +64,7 @@ export let IOMsg = {
   * 32~126: ascii charactor
   * 127: DEL
   */
-  
+
   // ADMIN_REQ: 0xA0,
 
   // DO NOT USE: 0xB0~ 0xBF
@@ -89,38 +82,38 @@ export let IOMsg = {
 
   // C. IO status contorl.
   SERVER_READY: 0xC0,
-  CID_REQ: 0xC1, 
-  CID_RES: 0xC2,  
+  CID_REQ: 0xC1,
+  CID_RES: 0xC2,
   QUOTA_LEVEL: 0xC3,
-  SERVER_CLEAR_AUTH: 0xC4, 
+  SERVER_CLEAR_AUTH: 0xC4,
   SERVER_REDIRECT: 0xC5,
 
   // ..
   LOOP: 0xCB,
   ECHO: 0xCC,
-  PING: 0xCD,  
+  PING: 0xCD,
   PONG: 0xCE,
   CLOSE: 0xCF,
   // ~CF
 
 
   // D. IO data signaling
-  SIGNAL: 0xD0,  
-  SIGNAL_REQ: 0xD1, 
-  SIGNAL_E2E: 0xD2, 
+  SIGNAL: 0xD0,
+  SIGNAL_REQ: 0xD1,
+  SIGNAL_E2E: 0xD2,
   SUBSCRIBE: 0xD3,
-  SUBSCRIBE_REQ: 0xD4, 
-  UNSUBSCRIBE: 0xD5, 
-  SERVER_SIGNAL: 0xD6, 
+  SUBSCRIBE_REQ: 0xD4,
+  UNSUBSCRIBE: 0xD5,
+  SERVER_SIGNAL: 0xD6,
 
   // ..
   IAM: 0xD9,
   IAM_RES: 0xDA,
-  
+
   //.. 
   SET: 0xDB,   //
-  RESPONSE_CODE: 0xDC,   
-  RESPONSE_MBP: 0xDD,   
+  RESPONSE_CODE: 0xDC,
+  RESPONSE_MBP: 0xDD,
 
   REQUEST: 0xDE, //client public
   RESPONSE: 0xDF,
@@ -139,17 +132,13 @@ export let IOMsg = {
 }
 
 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,

package/src/common/payload.js

@@ -3,81 +3,80 @@ 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 )
+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),
+  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('#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('#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 )
-      )
+      MBP.MB('#payloadType', '8', payload.type),
+      MBP.MB('#payload', payload.buffer)
+    )
   }
   return sigPack
 }
 
 
-export function parsePayload( args){
+export function parsePayload(args) {
   let type, pack;
-  if( args.length == 0){
-    type = PAYLOAD_TYPE.EMPTY 
+  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 (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 ){  //one buffer
+    } 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'){ 
+      pack = MBP.B8(args[0])
+    } else if (typeof args[0] === 'object') {
       type = PAYLOAD_TYPE.OBJECT
-      pack = encoder.encode( JSON.stringify( args[0]) )
-    }else{
+      pack = encoder.encode(JSON.stringify(args[0]))
+    } else {
       throw new Error('unknown payload arguments')
     }
-  }else{ // args 2 and more
+  } else { // two or more arguments.
     let containsBuffer = false
-    args.forEach( item =>{
-      if( ArrayBuffer.isView( item ) || item instanceof ArrayBuffer ) containsBuffer = true;
+    args.forEach(item => {
+      if (ArrayBuffer.isView(item) || item instanceof ArrayBuffer) containsBuffer = true;
     })
 
-    if( containsBuffer ){
+    if (containsBuffer) {
       type = PAYLOAD_TYPE.MBA;
-    }else{
+    } else {
       type = PAYLOAD_TYPE.MJSON;
-        // args is array
-      pack = encoder.encode( JSON.stringify( args ) )
+      pack = encoder.encode(JSON.stringify(args))
     }
-    
+
   }
-  
+
   return { type: type, buffer: pack }
 }
 
-export function getPayloadFromSignalPack( signalPack ){
+export function getPayloadFromSignalPack(signalPack) {
   let tagLen = signalPack.readUint8(1)
   return signalPack.subarray(3 + tagLen)
 }

package/src/common/quotaTable.js

@@ -24,42 +24,42 @@ export let quotaTable = {
 
   // WebSocket (browser and node app)
   3: { // authorized basic.
-    signalSize: 1048576,  
+    signalSize: 1048576,
     publishCounter: 10,
     trafficRate: 1048576 * 20
   },
 
   // WebSocket (browser and node app)
   10: { //  anonymouse
-    signalSize: 1500,  
+    signalSize: 1500,
     publishCounter: 5,
     trafficRate: 1048576 * 20
   },
 
   11: { // authorized basic.
-    signalSize: 65535,  
+    signalSize: 65535,
     publishCounter: 10,
     trafficRate: 1048576 * 20
   },
-  
+
   12: { // authorized power.
-    signalSize: 1048576,  
+    signalSize: 1048576,
     publishCounter: 100,
     trafficRate: 1048576 * 20
   },
-  
-  // you can add your custom quota level.
+
+  // you can add your custom quota levels.
 
   // Remote service node
   // High Quota, No root permission.
-  200: { 
+  200: {
     signalSize: 1048576 * 20,
     publishCounter: 10000,
     trafficRate: 1048576 * 100
   },
   // super admin or root user.
-  // to monitor, metric, sudo command, db acess
-  255: { 
+  // to monitor, metric, sudo command, db access.
+  255: {
     signalSize: 1048576 * 20,
     publishCounter: 10000,
     trafficRate: 1048576 * 100

package/src/common/util.js

@@ -1,61 +1,61 @@
 import { networkInterfaces } from 'os';
 
-export function isPrivateIP(ip){
-  if(ip.indexOf("0.0.0.0") === 0) return  true 
-  if(ip.indexOf("127.0.0.1") === 0) return  true 
-  if(ip.indexOf("192.168.") === 0) return  true 
-  if(ip.indexOf("10.") === 0) return  true 
-  if(ip.indexOf("172.") === 0){
-    if(ip.indexOf("172.16.") === 0) return  true 
-    if(ip.indexOf("172.17.") === 0) return  true 
-    if(ip.indexOf("172.18.") === 0) return  true 
-    if(ip.indexOf("172.19.") === 0) return  true 
-    if(ip.indexOf("172.20.") === 0) return  true 
-    if(ip.indexOf("172.21.") === 0) return  true 
-    if(ip.indexOf("172.22.") === 0) return  true 
-    if(ip.indexOf("172.23.") === 0) return  true 
-    if(ip.indexOf("172.24.") === 0) return  true 
-    if(ip.indexOf("172.25.") === 0) return  true 
-    if(ip.indexOf("172.26.") === 0) return  true 
-    if(ip.indexOf("172.27.") === 0) return  true 
-    if(ip.indexOf("172.28.") === 0) return  true 
-    if(ip.indexOf("172.29.") === 0) return  true 
-    if(ip.indexOf("172.30.") === 0) return  true 
-    if(ip.indexOf("172.31.") === 0) return  true 
+export function isPrivateIP(ip) {
+  if (ip.indexOf("0.0.0.0") === 0) return true
+  if (ip.indexOf("127.0.0.1") === 0) return true
+  if (ip.indexOf("192.168.") === 0) return true
+  if (ip.indexOf("10.") === 0) return true
+  if (ip.indexOf("172.") === 0) {
+    if (ip.indexOf("172.16.") === 0) return true
+    if (ip.indexOf("172.17.") === 0) return true
+    if (ip.indexOf("172.18.") === 0) return true
+    if (ip.indexOf("172.19.") === 0) return true
+    if (ip.indexOf("172.20.") === 0) return true
+    if (ip.indexOf("172.21.") === 0) return true
+    if (ip.indexOf("172.22.") === 0) return true
+    if (ip.indexOf("172.23.") === 0) return true
+    if (ip.indexOf("172.24.") === 0) return true
+    if (ip.indexOf("172.25.") === 0) return true
+    if (ip.indexOf("172.26.") === 0) return true
+    if (ip.indexOf("172.27.") === 0) return true
+    if (ip.indexOf("172.28.") === 0) return true
+    if (ip.indexOf("172.29.") === 0) return true
+    if (ip.indexOf("172.30.") === 0) return true
+    if (ip.indexOf("172.31.") === 0) return true
   }
 
   return false
 }
 
-export function numberWithCommas (x) {
+export function numberWithCommas(x) {
   return x.toString().replace(/\B(?=(\d{3})+(?!\d))/g, ',')
 }
 
-export function getIPv4HexString(ipStr){
+export function getIPv4HexString(ipStr) {
   let ipv4 = ipStr.split('.')
   return Buffer.from(ipv4).toString('hex')
 }
 
-export function getLocalAddress(){
+export function getLocalAddress() {
   const nets = networkInterfaces();
   // console.log(nets)
   const results = Object.create(null); // Or just '{}', an empty object
-  let localAddress =''
+  let localAddress = ''
   for (const name of Object.keys(nets)) {
-      for (const net of nets[name]) {
-          // Skip over non-IPv4 and internal (i.e. 127.0.0.1) addresses
-          // 'IPv4' is in Node <= 17, from 18 it's a number 4 or 6
-          const familyV4Value = typeof net.family === 'string' ? 'IPv4' : 4
-          if (net.family === familyV4Value && !net.internal) {
-              if (!results[name]) {
-                  results[name] = [];
-              }
-              results[name].push(net.address);
-              localAddress = net.address
-          }
+    for (const net of nets[name]) {
+      // Skip over non-IPv4 and internal (i.e. 127.0.0.1) addresses
+      // 'IPv4' is in Node <= 17, from 18 it's a number 4 or 6
+      const familyV4Value = typeof net.family === 'string' ? 'IPv4' : 4
+      if (net.family === familyV4Value && !net.internal) {
+        if (!results[name]) {
+          results[name] = [];
+        }
+        results[name].push(net.address);
+        localAddress = net.address
       }
+    }
   }
-  
+
   // console.log('localAddress:', localAddress)
   return localAddress
 }

package/src/server/FileLogger.js

@@ -6,21 +6,21 @@ const formatter = new Intl.DateTimeFormat('ko-KR', {
   // minute: '2-digit',
   // second: '2-digit'
   year: 'numeric', month: 'numeric', day: 'numeric',
-  hour: 'numeric', minute: 'numeric', 
+  hour: 'numeric', minute: 'numeric',
   hour12: false,
   timeZone: 'Asia/Seoul'
 });
 
 
-export class FileLogger{
-  constructor(path ){
-    this.file = fs.openSync(path ,'a+')
-    console.log('new logFile', path, this.file )
+export class FileLogger {
+  constructor(path) {
+    this.file = fs.openSync(path, 'a+')
+    console.log('new FileLogger logFile: ', path, this.file)
   }
-  
-  log(msg){
-    let format =formatter.format(new Date()) + " "+ msg +'\n';
-    fs.write( this.file, format , (err) => {
+
+  log(msg) {
+    let format = formatter.format(new Date()) + " " + msg + '\n';
+    fs.write(this.file, format, (err) => {
       if (err) throw err;
     })