vintage_net
vintage_net
v0.13.3

View Source VintageNet.Connectivity.CheckLogic (vintage_net v0.13.3)

Core logic for determining internet connectivity based on check results

This module is meant to be used by InternetChecker and others for determining when to run checks and how many failures should change the network interface's state.

It implements a state machine that figures out what the connectivity status is based on internet-connectivity check successes and fails. It also returns how long to wait between checks.

stateDiagram-v2
  direction LR
  [*]-->internet : init

  state connected {
    internet-->lan : max failures
    lan-->internet : check succeeded
  }
  connected-->disconnected : ifdown
  disconnected-->lan : ifup

Link to this section Summary

Types

state()

Functions

check_failed(state)

Call this when an Internet connectivity check fails

check_succeeded(state)

Call this when an Internet connectivity check succeeds

ifdown(state)

Call this when the interface goes down

ifup(state)

Call this when the interface comes up

init(other)

Initialize check state machine

Link to this section Types

Link to this type

state()

View Source 
@type state() :: %{
  connectivity: VintageNet.connection_status(),
  strikes: non_neg_integer(),
  interval: non_neg_integer() | :infinity
}

Link to this section Functions

Link to this function

check_failed(state)

View Source 
@spec check_failed(state()) :: state()

Call this when an Internet connectivity check fails

Depending on how many failures have happened it a row, the connectivity may be degraded to :lan.

Link to this function

check_succeeded(state)

View Source 
@spec check_succeeded(state()) :: state()

Call this when an Internet connectivity check succeeds

Link to this function

ifdown(state)

View Source 
@spec ifdown(state()) :: state()

Call this when the interface goes down

The interface will be categorized as :disconnected until ifup/1 gets called again.

Link to this function

ifup(state)

View Source 
@spec ifup(state()) :: state()

Call this when the interface comes up

It is assumed that the interface has LAN connectivity now and a check will be scheduled to happen shortly.

Link to this function

init(other)

View Source 
@spec init(VintageNet.connection_status()) :: state()

Initialize check state machine

Pass in the assumed connection status. This is a best guess to start things out.