Struct rsntp::SntpClient

pub struct SntpClient { /* fields omitted */ }

Blocking SNTP client instance

This is the main entry point of the blocking API. It is an association between the local host and the remote server and can be reused, i.e. multiple synchronization can be executed with a single instance.

Methods

impl SntpClient

pub fn new(server_address: &str) -> Result<SntpClient, Error>

Creates a new instance.

The parameter is the server DNS name or IP addresss. It uses the default SNTP UDP port (123)

Example

use rsntp::SntpClient;

let client = SntpClient::new("pool.ntp.org").unwrap();

pub fn with_socket_addr<T: ToSocketAddrs>(
    socket_addr: T
) -> Result<SntpClient, Error>

Creates a new instance for the given socket addres.

Example

use rsntp::SntpClient;

let socket_addr = ("pool.ntp.org", 123);
let client = SntpClient::with_socket_addr(socket_addr).unwrap();

pub fn synchronize(
    &self
) -> Result<SynchronizationResult, SynchroniztationError>

Synchronize with the server

It sends a request to the server, waits for the reply and processes that reply. This is a blocking call and can block for quite long time. After sending the request it waits for a timeout and if no reply is received then an error is returned.

Example

use rsntp::SntpClient;

let socket_addr = ("pool.ntp.org", 123);
let client = SntpClient::with_socket_addr(socket_addr).unwrap();
let result = client.synchronize();

pub fn set_timeout(&mut self, timeout: Duration)

Sets synchronization timeout

This sets the amount of time which the client waits for reply after the request has been sent. Default is 3 seconds.

Example

use rsntp::SntpClient;
use std::time::Duration;

let mut client = SntpClient::new("pool.ntp.org").unwrap();
client.set_timeout(Duration::from_secs(10));

Trait Implementations

impl Clone for SntpClient

fn clone(&self) -> SntpClient

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SntpClient

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Hash for SntpClient

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].