Safe Haskell	Safe-Inferred
Language	Haskell2010

Network.NTP.Client.Packet

Synopsis

data NtpPacket = NtpPacket {
- ntpParams ∷ Word8
- ntpPoll ∷ Int8
- ntpOriginTime ∷ Microsecond
- ntpReceivedTime ∷ Microsecond
- ntpTransmitTime ∷ Microsecond
}
ntpPacketSize ∷ Int
mkNtpPacket ∷ IO NtpPacket
newtype NtpOffset = NtpOffset {
- getNtpOffset ∷ Microsecond
}
getCurrentTime ∷ IO Microsecond
clockOffsetPure ∷ NtpPacket → Microsecond → NtpOffset
clockOffset ∷ Microsecond → NtpPacket → IO (Maybe NtpOffset)
realMcsToNtp ∷ Microsecond → (Word32, Word32)
ntpToRealMcs ∷ Word32 → Word32 → Microsecond
newtype Microsecond = Microsecond Integer

Documentation

data NtpPacket Source #

Constructors

NtpPacket
Fields ntpParams ∷ Word8 some magic parameters ntpPoll ∷ Int8 poll delay between requests ntpOriginTime ∷ Microsecond when server sent reply ntpReceivedTime ∷ Microsecond when server got request ntpTransmitTime ∷ Microsecond when client sent request

Instances

Instances details

Show NtpPacket Source #
Instance details Defined in Network.NTP.Client.Packet Methods showsPrec ∷ Int → NtpPacket → ShowS # show ∷ NtpPacket → String # showList ∷ [NtpPacket] → ShowS #
Binary NtpPacket Source #
Instance details Defined in Network.NTP.Client.Packet Methods put ∷ NtpPacket → Put # get ∷ Get NtpPacket # putList ∷ [NtpPacket] → Put #
Eq NtpPacket Source #
Instance details Defined in Network.NTP.Client.Packet Methods (==) ∷ NtpPacket → NtpPacket → Bool # (/=) ∷ NtpPacket → NtpPacket → Bool #

ntpPacketSize ∷ Int Source #

We only need first 48 bytes of a packet: reference: https://tools.ietf.org/html/rfc5905#section-7.3

mkNtpPacket ∷ IO NtpPacket Source #

Smart constructor for NtpPacket.

newtype NtpOffset Source #

NtpOffset is the difference between NTP time and local time.

Constructors

NtpOffset
Fields getNtpOffset ∷ Microsecond

Instances

Instances details

Enum NtpOffset Source #
Instance details Defined in Network.NTP.Client.Packet Methods succ ∷ NtpOffset → NtpOffset # pred ∷ NtpOffset → NtpOffset # toEnum ∷ Int → NtpOffset # fromEnum ∷ NtpOffset → Int # enumFrom ∷ NtpOffset → [NtpOffset] # enumFromThen ∷ NtpOffset → NtpOffset → [NtpOffset] # enumFromTo ∷ NtpOffset → NtpOffset → [NtpOffset] # enumFromThenTo ∷ NtpOffset → NtpOffset → NtpOffset → [NtpOffset] #
Num NtpOffset Source #
Instance details Defined in Network.NTP.Client.Packet Methods (+) ∷ NtpOffset → NtpOffset → NtpOffset # (-) ∷ NtpOffset → NtpOffset → NtpOffset # (*) ∷ NtpOffset → NtpOffset → NtpOffset # negate ∷ NtpOffset → NtpOffset # abs ∷ NtpOffset → NtpOffset # signum ∷ NtpOffset → NtpOffset # fromInteger ∷ Integer → NtpOffset #
Integral NtpOffset Source #
Instance details Defined in Network.NTP.Client.Packet Methods quot ∷ NtpOffset → NtpOffset → NtpOffset # rem ∷ NtpOffset → NtpOffset → NtpOffset # div ∷ NtpOffset → NtpOffset → NtpOffset # mod ∷ NtpOffset → NtpOffset → NtpOffset # quotRem ∷ NtpOffset → NtpOffset → (NtpOffset, NtpOffset) # divMod ∷ NtpOffset → NtpOffset → (NtpOffset, NtpOffset) # toInteger ∷ NtpOffset → Integer #
Real NtpOffset Source #
Instance details Defined in Network.NTP.Client.Packet Methods toRational ∷ NtpOffset → Rational #
Show NtpOffset Source #
Instance details Defined in Network.NTP.Client.Packet Methods showsPrec ∷ Int → NtpOffset → ShowS # show ∷ NtpOffset → String # showList ∷ [NtpOffset] → ShowS #
Eq NtpOffset Source #
Instance details Defined in Network.NTP.Client.Packet Methods (==) ∷ NtpOffset → NtpOffset → Bool # (/=) ∷ NtpOffset → NtpOffset → Bool #
Ord NtpOffset Source #
Instance details Defined in Network.NTP.Client.Packet Methods compare ∷ NtpOffset → NtpOffset → Ordering # (<) ∷ NtpOffset → NtpOffset → Bool # (<=) ∷ NtpOffset → NtpOffset → Bool # (>) ∷ NtpOffset → NtpOffset → Bool # (>=) ∷ NtpOffset → NtpOffset → Bool # max ∷ NtpOffset → NtpOffset → NtpOffset # min ∷ NtpOffset → NtpOffset → NtpOffset #

getCurrentTime ∷ IO Microsecond Source #

Helper function to get current time in Microsecond.

clockOffsetPure ∷ NtpPacket → Microsecond → NtpOffset Source #

clockOffset Source #

Arguments

∷ Microsecond	`ntpResponseTimeout`, ignore responses which come after it passed.
→ NtpPacket
→ IO (Maybe NtpOffset)

Compute clock offset unless the NTP packet was requested more than the given timeout.

realMcsToNtp ∷ Microsecond → (Word32, Word32) Source #

It is a partial function, since Microsecond ~ Integer; it is well defined for: x < 2085978496 = (maxBoundWord32 * 1000000) - ntpTimestampDelta + 1` @ (in microseconds; this is roughly 66 years, so we're fine untill 2036).

ntpToRealMcs ∷ Word32 → Word32 → Microsecond Source #

For pairs (x, y) :: (Word32, Word32) with y `mod` 4294 == 0 it is be right inverse of realMsgToNtp. In general it is not injective (for that we'd need to use Picosecond instead of Microsecond).

newtype Microsecond Source #

Constructors

Microsecond Integer

Instances

Instances details

Enum Microsecond Source #
Instance details Defined in Network.NTP.Client.Packet Methods succ ∷ Microsecond → Microsecond # pred ∷ Microsecond → Microsecond # toEnum ∷ Int → Microsecond # fromEnum ∷ Microsecond → Int # enumFrom ∷ Microsecond → [Microsecond] # enumFromThen ∷ Microsecond → Microsecond → [Microsecond] # enumFromTo ∷ Microsecond → Microsecond → [Microsecond] # enumFromThenTo ∷ Microsecond → Microsecond → Microsecond → [Microsecond] #
Num Microsecond Source #
Instance details Defined in Network.NTP.Client.Packet Methods (+) ∷ Microsecond → Microsecond → Microsecond # (-) ∷ Microsecond → Microsecond → Microsecond # (*) ∷ Microsecond → Microsecond → Microsecond # negate ∷ Microsecond → Microsecond # abs ∷ Microsecond → Microsecond # signum ∷ Microsecond → Microsecond # fromInteger ∷ Integer → Microsecond #
Integral Microsecond Source #
Instance details Defined in Network.NTP.Client.Packet Methods quot ∷ Microsecond → Microsecond → Microsecond # rem ∷ Microsecond → Microsecond → Microsecond # div ∷ Microsecond → Microsecond → Microsecond # mod ∷ Microsecond → Microsecond → Microsecond # quotRem ∷ Microsecond → Microsecond → (Microsecond, Microsecond) # divMod ∷ Microsecond → Microsecond → (Microsecond, Microsecond) # toInteger ∷ Microsecond → Integer #
Real Microsecond Source #
Instance details Defined in Network.NTP.Client.Packet Methods toRational ∷ Microsecond → Rational #
Show Microsecond Source #
Instance details Defined in Network.NTP.Client.Packet Methods showsPrec ∷ Int → Microsecond → ShowS # show ∷ Microsecond → String # showList ∷ [Microsecond] → ShowS #
Eq Microsecond Source #
Instance details Defined in Network.NTP.Client.Packet Methods (==) ∷ Microsecond → Microsecond → Bool # (/=) ∷ Microsecond → Microsecond → Bool #
Ord Microsecond Source #
Instance details Defined in Network.NTP.Client.Packet Methods compare ∷ Microsecond → Microsecond → Ordering # (<) ∷ Microsecond → Microsecond → Bool # (<=) ∷ Microsecond → Microsecond → Bool # (>) ∷ Microsecond → Microsecond → Bool # (>=) ∷ Microsecond → Microsecond → Bool # max ∷ Microsecond → Microsecond → Microsecond # min ∷ Microsecond → Microsecond → Microsecond #