ntp time sync

NTP 時間同期

NTP サーバーから現在時刻を取得し、オフセット情報を返す Node.JS モジュール。

NTP には UDP が必要ですが、ブラウザのコンテキストでは使用できません。

インストール

 # using Yarn
$ yarn add ntp-time-sync

# using NPM
$ npm install ntp-time-sync

使用法

getTimeを呼び出すたびに新しい NTP パッケージが起動されないように、ライブラリをシングルトンとして使用することを検討してください。ライブラリ自体が最小/最大ポーリング時間を管理します。

複数の NTP タイム サーバーに対するいくつかの要求が発行され、応答が集約されます。

 // 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() Promiseオブジェクトを返します。このオブジェクトは最終的に次の情報を含むオブジェクトで解決されます。

財産	説明
now	現在の NTP 時間 (「リアルタイム」)
offset	ローカル システム時間と NTP 時間の間の計算されたオフセット

<ntpTimeSyncInstance>.now()関数が呼び出された時点の正しい時刻を含むDateオブジェクトを返します。 getTime()とは対照的に、 Promise が解決された瞬間の正しい時刻を返します。

オプション

カスタム オプションをNtpTimeSyncまたはNtpTimeSync.getInstance(options)のコンストラクターに渡すことができます。これらは次のデフォルトとマージされます。

 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" )
  }
} ;