VintageNet.OSEventDispatcher.UdhcpcHandler behaviour (vintage_net v0.11.3) View Source

A behaviour for handling notifications from udhcpc

Example

defmodule MyApp.UdhcpcHandler do
  @behaviour VintageNet.OSEventDispatcher.UdhcpcHandler

  @impl VintageNet.OSEventDispatcher.UdhcpcHandler
  def deconfig(ifname, data) do
    ...
  end
end

To have VintageNet invoke it, add the following to your config.exs:

config :vintage_net, udhcpc_handler: MyApp.UdhcpcHandler

Link to this section Summary

Types

update_data()

Update data is the unmodified environment variable strings from udhcpc

Callbacks

bound(ifname, update_data)

Handle an assignment from the DHCP server

deconfig(ifname, update_data)

Deconfigure the specified interface

leasefail(ifname, update_data)

Handle a failure to get a lease

nak(ifname, update_data)

Handle a DHCP NAK

renew(ifname, update_data)

Handle the renewal of a DHCP lease

Link to this section Types

update_data()

Specs

update_data() :: %{required(String.t()) => String.t()}

Update data is the unmodified environment variable strings from udhcpc

The following is an example of update data, but it really depends on what udhcpc wants to send:

%{
  "broadcast" => "192.168.7.255",
  "dns" => "192.168.7.1",
  "domain" => "hunleth.lan",
  "hostname" => "nerves-9780",
  "interface" => "eth0",
  "ip" => "192.168.7.190",
  "lease" => "86400",
  "mask" => "24",
  "opt53" => "05",
  "opt58" => "0000a8c0",
  "opt59" => "00012750",
  "router" => "192.168.7.1",
  "serverid" => "192.168.7.1",
  "siaddr" => "192.168.7.1",
  "subnet" => "255.255.255.0"
}

Link to this section Callbacks

bound(ifname, update_data)

Specs

bound(VintageNet.ifname(), update_data()) :: :ok

Handle an assignment from the DHCP server

deconfig(ifname, update_data)

Specs

deconfig(VintageNet.ifname(), update_data()) :: :ok

Deconfigure the specified interface

leasefail(ifname, update_data)

Specs

leasefail(VintageNet.ifname(), update_data()) :: :ok

Handle a failure to get a lease

nak(ifname, update_data)

Specs

nak(VintageNet.ifname(), update_data()) :: :ok

Handle a DHCP NAK

renew(ifname, update_data)

Specs

renew(VintageNet.ifname(), update_data()) :: :ok

Handle the renewal of a DHCP lease