ntp time sync

ntp-time-sync

Module Node.JS pour récupérer l'heure actuelle des serveurs NTP et renvoie les informations de décalage.

NTP nécessite UDP qui n'est pas disponible dans un contexte de navigateur !

Installation

 # using Yarn
$ yarn add ntp-time-sync

# using NPM
$ npm install ntp-time-sync

Usage

Pensez à utiliser la bibliothèque comme singleton, afin que tous les appels à getTime ne déclenchent pas de nouveaux packages NTP. La bibliothèque elle-même gérera les temps d'interrogation minimum/maximum.

Plusieurs requêtes adressées à plusieurs serveurs de temps NTP sont lancées et les réponses seront regroupées.

 // ES6:
import { NtpTimeSync } from "ntp-time-sync" ;
// pre-ES6:
// const NtpTimeSync = require("ntp-time-sync").NtpTimeSync;

const timeSync = NtpTimeSync . getInstance ( ) ;

// request 1
timeSync . getTime ( ) . then ( function ( result ) {
  console . log ( "current system time" , new Date ( ) ) ;
  console . log ( "real time" , result . now ) ;
  console . log ( "offset in milliseconds" , result . offset ) ;
} )

// request 2, will use cached offset from previous request
timeSync . getTime ( ) . then ( function ( result ) {
  console . log ( "current system time" , new Date ( ) ) ;
  console . log ( "real time" , result . now ) ;
  console . log ( "offset in milliseconds" , result . offset ) ;
} )

// ES2017 style
const result = await timeSync . getTime ( ) ;
console . log ( "real time" , result . now ) ;

<ntpTimeSyncInstance>.getTime() renvoie un objet Promise qui sera finalement résolu avec un objet contenant les informations suivantes :

Propriété	Description
now	Heure NTP actuelle (« temps réel »)
offset	Décalage calculé entre l'heure du système local et l'heure NTP

<ntpTimeSyncInstance>.now() renvoie un objet Date contenant l'heure correcte du moment où la fonction a été appelée. Contrairement à getTime() , qui renverra l'heure correcte au moment où la promesse est résolue.

Possibilités

Vous pouvez transmettre des options personnalisées au constructeur de NtpTimeSync ou NtpTimeSync.getInstance(options) . Ceux-ci seront fusionnés avec les valeurs par défaut suivantes :

 const defaultOptions = {
  // list of NTP time servers, optionally including a port (defaults to 123)
  servers : [
    "0.pool.ntp.org" ,
    "1.pool.ntp.org" ,
    "2.pool.ntp.org" ,
    "3.pool.ntp.org"
  ] ,

  // required amount of valid samples in order to calculate the time
  sampleCount : 8 ,

  // amount of time in milliseconds to wait for a single NTP response
  replyTimeout : 3000 ,

  // defaults as of RFC5905
  ntpDefaults : {
    port : 123 ,
    version : 4 ,
    tolerance : 15e-6 ,
    minPoll : 4 ,
    maxPoll : 17 ,
    maxDispersion : 16 ,
    minDispersion : 0.005 ,
    maxDistance : 1 ,
    maxStratum : 16 ,
    precision : - 18 ,
    referenceDate : new Date ( "Jan 01 1900 GMT" )
  }
} ;