heal

Documentation

Overview

Package heal contains an implementation of LivenessChecker.

Index

• func KernelLivenessCheck(deadlineCtx context.Context, conn *networkservice.Connection) bool
• func KernelLivenessCheckWithOptions(deadlineCtx context.Context, conn *networkservice.Connection, opts ...Option) bool
• type Option
  • func WithPingerFactory(pf PingerFactory) Option
• type Pinger
• type PingerFactory

Functions

func KernelLivenessCheck

func KernelLivenessCheck(deadlineCtx context.Context, conn *networkservice.Connection) bool

KernelLivenessCheck is an implementation of heal.LivenessCheck

func KernelLivenessCheckWithOptions

func KernelLivenessCheckWithOptions(deadlineCtx context.Context, conn *networkservice.Connection, opts ...Option) bool

KernelLivenessCheckWithOptions is an implementation with options of heal.LivenessCheck. It sends ICMP ping and checks reply. Returns false if didn't get reply.

Types

type Option

type Option func(o *options)

Option is an option pattern for LivelinessChecker

func WithPingerFactory

func WithPingerFactory(pf PingerFactory) Option

WithPingerFactory - sets any custom pinger factory

type Pinger

type Pinger interface {
	Run() error
	GetReceivedPackets() int
}

Pinger - pinger interface

type PingerFactory

type PingerFactory interface {
	CreatePinger(srcIP, dstIP string, timeout time.Duration, count int) Pinger
}

PingerFactory - factory interface for creating pingers