Struct surge_ping::Pinger

pub struct Pinger { /* fields omitted */ }

A Ping struct represents the state of one particular ping instance.

Examples

use std::time::Duration;

use surge_ping::Pinger;

#[tokio::main]
async fn main() {
    let mut pinger = Pinger::new("114.114.114.114".parse().unwrap()).unwrap();
    pinger.size(56).timeout(Duration::from_secs(1));
    let result = pinger.ping(0).await;
    println!("{:?}", result);
}

Implementations

impl Pinger

pub fn new(host: IpAddr) -> Result<Pinger, SurgeError>

Creates a new Ping instance from IpAddr.

pub fn bind_device(
    &mut self,
    interface: Option<&[u8]>
) -> Result<&mut Pinger, SurgeError>

Sets the value for the SO_BINDTODEVICE option on this socket.

If a socket is bound to an interface, only packets received from that particular interface are processed by the socket. Note that this only works for some socket types, particularly AF_INET sockets.

If interface is None or an empty string it removes the binding.

This function is only available on Fuchsia and Linux.

pub fn bind_addr(&mut self, addr: IpAddr) -> Result<&mut Pinger, SurgeError>

Binds this socket to the specified address. This function directly corresponds to the bind(2) function on Windows and Unix.

pub fn set_ttl(&mut self, ttl: u8) -> Result<&mut Pinger, SurgeError>

Set the value of the IP_TTL option for this socket. This value sets the time-to-live field that is used in every packet sent from this socket.

pub fn ident(&mut self, val: u16) -> &mut Pinger

Set the identification of ICMP.

pub fn size(&mut self, size: usize) -> &mut Pinger

Set the packet size.(default: 56)

pub fn timeout(&mut self, timeout: Duration) -> &mut Pinger

The timeout of each Ping, in seconds. (default: 2s)

pub async fn ping(
    &self,
    seq_cnt: u16
) -> Result<(IcmpPacket, Duration), SurgeError>

Send Ping request with sequence number.

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.

impl Debug for Pinger

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

Formats the value using the given formatter.