Struct NetworkManager 

pub struct NetworkManager<A: PtpAddressFamily>(/* private fields */);

The primary management struct for the PTP/CSPTP network sockets.

Root of the hierarchy for opening sockets. Allows opening of specific interfaces and configuring the clock sources used for those interface. These interfaces can then be used to create sockets, which can be used to handle the actual network traffic.

Implementations

impl<A: PtpAddressFamily> NetworkManager<A>

pub fn new() -> Result<Self>

Create a new network manager

Immediately opens a general socket on port 319/320 not bound to a specific interface, as creating that socket later can be problematic.

Errors

Returns any IO errors that occurred in setting up the general socket.

impl<A: PtpAddressFamily> NetworkManager<A>

pub fn open_general(&self) -> Interface<A>

Get a reference to the general interface.

This interface can be used to create sockets which don’t care about which network interface their messages actually transit through. Timestamping of their messages will always be done with the system clock, as that is the only clock guaranteed to be available for timestamping on all network interfaces.

pub fn open_interface( &self, interface: InterfaceName, clock: TimestampingClock, ) -> Result<Interface<A>>

Open a specific network interface.

This opens the specified network interface, configuring it such that the requested clock can be used for timestamping. If the interface was already previously opened, it will return a reference to it.

Errors

Returns any IO errors that occured when trying to create a socket for the specified interface.

Will also error when the interface is already open, but was created with a different clock for timestamping than currently requested, unless the currently requested clock is the system clock.

Trait Implementations

impl<A: Clone + PtpAddressFamily> Clone for NetworkManager<A>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.