uplinkprober

type Config struct {
	// MaxContFailCnt : maximum number of continuous failures that is allowed to happen
	// before the next hop or remote network reachability is declared as DOWN.
	MaxContFailCnt uint8
	// MaxContSuccessCnt : maximum number of continuous successes that is allowed to happen
	// before the next hop or remote network reachability is declared as UP.
	MaxContSuccessCnt uint8
	// MinContPrevStateCnt : how many continuous confirmations of the previous UP/DOWN state
	// are needed for a sudden change to be applied immediately. This avoids frequent
	// uplink selection changes with a flapping connectivity, but also ensures that
	// an occasional change is reflected as soon as possible.
	// Currently only applied for Next Hop probing, not for remote probing.
	MinContPrevStateCnt uint8
	// NextHopProbeTimeout : timeout for a single next hop probe.
	NextHopProbeTimeout time.Duration
	// RemoteProbeTimeout : timeout for a single remote probe.
	RemoteProbeTimeout time.Duration
	// NHToRemoteProbeRatio : How many NH probes must be run first before a single remote
	// probe is executed.
	// Minimum allowed value is 5.
	NHToRemoteProbeRatio uint8
	// NHProbeInterval : how often to execute NH probe.
	// Remote probe interval is NHProbeInterval * NHToRemoteProbeRatio
	NHProbeInterval time.Duration
}

type ControllerReachProber struct {
	// contains filtered or unexported fields
}

type MockReachProber struct {
	sync.Mutex
	// contains filtered or unexported fields
}

type NIProbeStatus struct {
	NetworkInstance uuid.UUID
	// SelectedUplinkLL is a logical label of the uplink interface selected as having
	// the best working connectivity at the moment.
	SelectedUplinkLL string
	SelectedAt       time.Time
}

type ReachabilityProber interface {
	// ProbeNextHopReach : test reachability of the uplink's closest router(s).
	// Return non-nil error if the next hop is not reachable.
	// Additionally, return a list of all next hops that were used for probing.
	// It is preferred for the method to be fast as it will be called quite often.
	ProbeNextHopReach(ctx context.Context, uplinkLL string, dns *types.DeviceNetworkStatus) (
		probedNHs []net.IP, err error)
	// ProbeRemoteReach : test reachability of remote network(s), such as the Internet
	// (or whatever remote networks are expected to be reachable via this uplink).
	// Return non-nil error if remote networks are not reachable.
	// Additionally, return a list of all remote endpoints that were used for probing.
	// This method is not called as often as ProbeNextHopReach and can therefore
	// take a little longer to execute if needed.
	ProbeRemoteReach(ctx context.Context, uplinkLL string, dns *types.DeviceNetworkStatus) (
		probedEps []url.URL, err error)
}

type UplinkProber struct {
	sync.Mutex
	// contains filtered or unexported fields
}