Rust SNTP client to get a timestamp from NTP servers
This crate provides a method for sending requests to NTP servers and process responses, extracting received timestamp.
Supported SNTP protocol versions:
This crate works with Cargo and is on
crates.io. Add it to your Cargo.toml
like so:
[dependencies]
sntpc = "0.3.7"
By calling the get_time()
method and providing a proper NTP pool or server you
should get a valid synchronization timestamp:
use std::net::UdpSocket;
use std::time::Duration;
fn main() {
let socket =
UdpSocket::bind("0.0.0.0:0").expect("Unable to create UDP socket");
socket
.set_read_timeout(Some(Duration::from_secs(2)))
.expect("Unable to set UDP socket read timeout");
let result =
sntpc::simple_get_time("time.google.com:123", socket);
match result {
Ok(time) => {
let microseconds = sntpc::fraction_to_microseconds(time.sec_fraction());
println!("Got time: {}.{}", time.sec(), microseconds);
}
Err(err) => println!("Err: {:?}", err),
}
}
no_std
supportCurrently, there are basic no_std
support available, thanks to no-std-net
crate. There is an example available on how to use smoltcp
stack and that should provide
general idea on how to bootstrap no_std
networking and timestamping tools for sntpc
library usage
async
supportFeature async_tokio
allows to use crate together with tokio.
There is an example: examples/tokio.rs
.
There is also no_std
support with feature async
, but it requires Rust >= 1.75-nightly
version.
The example can be found in separate repository.
You can find several examples that shows how to use the library in details under [examples/] folder. Currently, there are examples that show:
std
environmentsmoltcp
TCP/IP stack. Some std
dependencies
required only due to smoltcp available interfacesContributions are always welcome! If you have an idea, it's best to float it by me before working on it to ensure no effort is wasted. If there's already an open issue for it, knock yourself out. See the contributing section for additional details
NtpResult
structureasync
supportREADME.md
Really appreciate all your efforts! Please let me know if I forgot someone.
This project is licensed under:
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in time by you, as defined in the 3-Clause BSD license, shall be licensed as above, without any additional terms or conditions.