Struct rsntp::SntpClient

pub struct SntpClient { /* fields omitted */ }

Blocking client instance

This is the main entry point of the blocking API.

Implementations

impl SntpClient

pub fn new() -> SntpClient

Creates a new instance with default parameters

Example

use rsntp::SntpClient;

let client = SntpClient::new();

pub fn synchronize<A: ToServerAddrs>(
    &self,
    server_address: A
) -> Result<SynchronizationResult, SynchroniztationError>

Synchronize with the server

Sends a request to the server, waits for the reply and processes it. 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.

If the supplied server address resolves to multiple addresses then only the first one is used.

Example

use rsntp::SntpClient;

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

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();
client.set_timeout(Duration::from_secs(10));

pub fn set_bind_address(&mut self, address: SocketAddr)

Set UDP bind address

Sets the local address which is used to send/receive UDP packets. By default it is "0.0.0.0:0" which means that an IPv4 address and a port is chosen automatically.

To synchronize with IPv6 servers, you might need to set it to an IPv6 address.

Example

use rsntp::SntpClient;

let mut client = SntpClient::new();
client.set_bind_address("192.168.0.1:0".parse().unwrap());

Trait Implementations

impl Clone for SntpClient

fn clone(&self) -> SntpClient

Returns a copy of the value.

pub 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 Default for SntpClient

fn default() -> Self

Returns the "default value" for a type.

impl Hash for SntpClient

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.