tcp ping sync

TCP-Ping-sincronización

Utilidad de ping TCP con una API sincrónica
⌛⇄

Instalar

npm i tcp-ping-sync

Uso

La biblioteca expone dos métodos, ping y probe :

 const { ping , probe } = require ( 'tcp-ping-sync' ) ;

const response = ping ( { host : 'google.com' , port : 443 } ) ;
console . log ( response ) ;
// {
//   results: [
//     { seq: 0, time: 126.462211 },
//     { seq: 1, time: 113.164184 },
//     { seq: 2, time: 132.048925 },
//     { seq: 3, time: 148.315887 },
//     { seq: 4, time: 137.088763 },
//     { seq: 5, time: 105.050291 },
//     { seq: 6, time: 105.028794 },
//     { seq: 7, time: 109.297229 },
//     { seq: 8, time: 102.262321 },
//     { seq: 9, time: 112.281641 }
//   ],
//   stats: {
//     min: 102.26232,
//     avg: 119.10002450000002,
//     max: 148.315887,
//     stddev: 15.019185518208955
//   },
//   settings: {
//     host: 'google.com',
//     port: 443,
//     attempts: 10
//   }
// }

const isGoogleReachable = probe ( 'google.com' ) ;
console . log ( isGoogleReachable ) ;
// true

API

 const { ping , probe } = require ( 'tcp-ping-sync' ) ;

// Probe (does a single ping attempt succeed?)

const isRemoteReachable = probe (
  ( host = String ) , //   (default: 'localhost')
  ( port = Number ) //    (default: 80)
) ;

const isLocalReachable = probe (
  ( port = Number ) //    (default: 80)
) ;

// Ping

const {
  results = [
    {
      seq : Number , //   Sequence [0...attempts-1]
      time : Number //   Response time
    }
    // ...
  ] ,
  stats = {
    min : Number , //     Fastest response time
    max : Number , //     Slowest response time
    avg : Number , //     Average response time
    stddev : Number //   Standard deviation
  } ,
  settings : Object //   Resolved arguments (host, port & attempts)
} = ping ( {
  host : String , //      Hostname/IP address   (default: 'localhost')
  port : Number , //      Port number           (default: 80)
  attempts : Number //   Number of attempts   (default: 10)
} ) ;

Se pueden encontrar más ejemplos de uso en las pruebas ( test.js ), que se pueden ejecutar con npm test . Para ejecutar las pruebas con la salida de depuración, ejecute npm run test:debug .

Advertencia

Esta biblioteca tiene una dependencia opcional (NetLinkWrapper) que necesita compilar módulos nativos. Si su plataforma no puede compilarla, se utilizará una dependencia alternativa (pero más lenta). En este caso, solo debe considerar usar esta biblioteca si realmente necesita una respuesta sincrónica. Si Async es aceptable, probablemente querrá usar tcp-ping en su lugar.

Créditos

Este trabajo está inspirado en tcp-ping de Adam Paszke (MIT; © 2014). Gracias también a Jacob Fischer por resolver cómo simular los enchufes de red sincrónicos en el nodo e implementar la solución como Sync-Socket.