Returns a specification to start this module under a supervisor.

See Supervisor.

@spec configure(VintageNet.ifname(), map(), VintageNet.configure_options()) ::
  :ok | {:error, any()}

Set a configuration on an interface

Configurations with invalid parameters raise exceptions. It's still possible that network configurations won't work even if they don't raise, but it should be due to something in the environment. For example, a network cable isn't plugged in or a WiFi access point is out of range.

@spec deconfigure(VintageNet.ifname(), VintageNet.configure_options()) ::
  :ok | {:error, any()}

Deconfigure the interface

This doesn't exit this GenServer, but the interface won't be usable in any real way until it's configured again.

This function is not normally called.

@spec ioctl(VintageNet.ifname(), atom(), any()) ::
  :ok | {:ok, any()} | {:error, any()}

Run an I/O command on the specified interface

@spec start_link(VintageNet.ifname()) :: GenServer.on_start()

Start up an interface

Parameters:

• ifname - which interface

@spec stop(VintageNet.ifname()) :: :ok

Stop the interface

Note that this doesn't deconfigure it.

@spec to_raw_config(VintageNet.ifname(), map()) ::
  {:ok, VintageNet.Interface.RawConfig.t()} | {:error, any()}

Convert a configuration to a raw one

This can be used to validate a configuration without applying it.

@spec wait_until_configured(VintageNet.ifname()) :: :ok

Wait for the interface to be configured