Struct winping::Pinger

pub struct Pinger { /* fields omitted */ }

A pinger that blocks when sending.

Implementations

impl Pinger

pub fn new() -> Result<Self, CreateError>

Creates a new Pinger. If one ICMP handle (v4 or v6) fails to initialize, this will return the Pinger embedded in an error. The Pinger is still usable in this state, but sending on the failed version will return an Error. If both v4 and v6 fail, the pinger is not embedded in the error.

pub fn new_v4() -> Option<Self>

Creates a new Pinger, ignoring v6 failures. If you want to use both v4 and v6, use new() instead.

pub fn new_v6() -> Option<Self>

Creates a new Pinger, ignoring v4 failures. If you want to use both v4 and v6, use new() instead.

pub fn set_ttl(&mut self, ttl: u8)

Sets the IP TTL for future requets.

pub fn ttl(&self) -> u8

Gets the current IP TTL value.

pub fn set_df(&mut self, df: bool)

Sets the IP Don't Fragment bit for future requests.

pub fn df(&self) -> bool

Gets the current IP Don't Fragment bit.

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

Sets the timeout, in milliseconds, for future requests.

pub fn timeout(&self) -> u32

Gets the current timeout in milliseconds.

pub fn send4(&self, dst: Ipv4Addr, buf: &mut Buffer) -> Result<u32, Error>

Send an ICMPv4 request to the destination address. On success, returns the round trip time in milliseconds.

pub fn send4_from(
    &self,
    src: Ipv4Addr,
    dst: Ipv4Addr,
    buf: &mut Buffer
) -> Result<u32, Error>

Sends an ICMPv4 request from the source address to the destination address. On success, returns the round trip time in milliseconds.

pub fn send6(&self, dst: Ipv6Addr, buf: &mut Buffer) -> Result<u32, Error>

Sends an ICMPv6 request to the destination address. On success, returns the round trip time in milliseconds.

pub fn send6_from(
    &self,
    src: Ipv6Addr,
    dst: Ipv6Addr,
    buf: &mut Buffer
) -> Result<u32, Error>

Sends an ICMPv6 request from the source address to the destination address. On success, returns the round trip time in milliseconds.

pub fn send(&self, dst: IpAddr, buf: &mut Buffer) -> Result<u32, Error>

Sends an ICMP request to the destination address. Supports both v4 and v6. On success, returns the round trip time in milliseconds.

pub fn send_from(
    &mut self,
    src_dst_pair: IpPair,
    buf: &mut Buffer
) -> Result<u32, Error>

Sends an ICMP request from the source address to the destination address. Supports both v4 and v6. On success, returns the round trip time in milliseconds.

Trait Implementations

impl Clone for Pinger

fn clone(&self) -> Pinger

Returns a copy of the value.

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

Performs copy-assignment from source.