Struct IcmpSocket

Source

pub struct IcmpSocket { /* private fields */ }

Expand description

An Internet Control Message Protocol socket.

This is an implementation of a bound ICMP socket. This supports both IPv4 and IPv6 addresses, and there is no corresponding notion of a server because ICMP is a datagram protocol.

use icmp;
use std::net::{IpAddr, Ipv4Addr};

let localhost_v4 = IpAddr::V4(Ipv4Addr::new(127, 0, 0, 1));
let ping = icmp::IcmpSocket::connect(localhost_v4);
let mut ping = ping.unwrap();

let payload: &[u8] = &[1, 2];

let result = ping.send(payload);
assert_eq!(result.unwrap(), 2);

In case you received an error message, you need to enable the correct capabilites:

cargo build
sudo setcap cap_net_raw+ep ./target/debug/PROJECT_NAME
cargo run

Implementations§

Source §

impl IcmpSocket

Source

pub fn connect(addr: IpAddr) -> Result<IcmpSocket>

Connect socket to addr

Source

pub fn recv(&self, buf: &mut [u8]) -> Result<usize>

Receives data from the socket. On success, returns the number of bytes read.

Source

pub fn recv_from(&self, buf: &mut [u8]) -> Result<(usize, IpAddr)>

Receives data from the socket. On success, returns the number of bytes read and the address from whence the data came.

Source

pub fn send(&mut self, buf: &[u8]) -> Result<usize>

Sends data on the socket to the remote address to which it is connected.

The connect method will connect this socket to a remote address. This method will fail if the socket is not connected.

Source

pub fn set_read_timeout(&self, dur: Option<Duration>) -> Result<()>

Sets the read timeout to the timeout specified.

If the value specified is None, then read calls will block indefinitely. It is an error to pass the zero Duration to this method.

§Note

Platforms may return a different error code whenever a read times out as a result of setting this option. For example Unix typically returns an error of the kind WouldBlock, but Windows may return TimedOut.

Source

pub fn set_write_timeout(&self, dur: Option<Duration>) -> Result<()>

Sets the write timeout to the timeout specified.

If the value specified is None, then write calls will block indefinitely. It is an error to pass the zero Duration to this method.

§Note

Platforms may return a different error code whenever a write times out as a result of setting this option. For example Unix typically returns an error of the kind WouldBlock, but Windows may return TimedOut.

Source