nerves_network v0.3.7-rc0 Nerves.Network.Udhcpc
This module interacts with udhcpc
to interact with DHCP servers.
Link to this section Summary
Types
Event from the udhcpc server to be sent via SystemRegistry
State of the GenServer
Instance of this server
Message from the udhcpc port
Functions
Invoked when the server is started. start_link/3
or start/3
will
block until it returns
Notify the DHCP server to release the IP address currently assigned to this interface. After calling this, be sure to disassociate the IP address from the interface so that packets don’t accidentally get sent or processed
Renew the lease on the IP address with the DHCP server
Start and link a Udhcpc process for the specified interface (i.e., eth0, wlan0)
Stop the dhcp client
Link to this section Types
Event from the udhcpc server to be sent via SystemRegistry.
State of the GenServer.
Instance of this server.
Message from the udhcpc port.
Link to this section Functions
Invoked when the server is started. start_link/3
or start/3
will
block until it returns.
args
is the argument term (second argument) passed to start_link/3
.
Returning {:ok, state}
will cause start_link/3
to return
{:ok, pid}
and the process to enter its loop.
Returning {:ok, state, timeout}
is similar to {:ok, state}
except handle_info(:timeout, state)
will be called after timeout
milliseconds if no messages are received within the timeout.
Returning {:ok, state, :hibernate}
is similar to
{:ok, state}
except the process is hibernated before entering the loop. See
c:handle_call/3
for more information on hibernation.
Returning :ignore
will cause start_link/3
to return :ignore
and the
process will exit normally without entering the loop or calling c:terminate/2
.
If used when part of a supervision tree the parent supervisor will not fail
to start nor immediately try to restart the GenServer
. The remainder of the
supervision tree will be (re)started and so the GenServer
should not be
required by other processes. It can be started later with
Supervisor.restart_child/2
as the child specification is saved in the parent
supervisor. The main use cases for this are:
- The
GenServer
is disabled by configuration but might be enabled later. - An error occurred and it will be handled by a different mechanism than the
Supervisor
. Likely this approach involves callingSupervisor.restart_child/2
after a delay to attempt a restart.
Returning {:stop, reason}
will cause start_link/3
to return
{:error, reason}
and the process to exit with reason reason
without
entering the loop or calling c:terminate/2
.
Callback implementation for GenServer.init/1
.
Notify the DHCP server to release the IP address currently assigned to this interface. After calling this, be sure to disassociate the IP address from the interface so that packets don’t accidentally get sent or processed.
Renew the lease on the IP address with the DHCP server.
start_link(Nerves.Network.Types.ifname()) :: GenServer.on_start()
Start and link a Udhcpc process for the specified interface (i.e., eth0, wlan0).
Stop the dhcp client