heal

Documentation

Overview

Package heal provides a client chain element that can be used to enable fast heal of Connections if something goes wrong with the current Connection (as detected by monitor). Do not use heal client chain element in a passthrough NSE

Index

• func NewClient(chainCtx context.Context, opts ...Option) networkservice.NetworkServiceClient
• type LivenessCheck
• type Option
  • func WithLivenessCheck(livenessCheck LivenessCheck) Option
  • func WithLivenessCheckInterval(livenessCheckInterval time.Duration) Option
  • func WithLivenessCheckTimeout(livenessCheckTimeout time.Duration) Option

Functions

func NewClient

func NewClient(chainCtx context.Context, opts ...Option) networkservice.NetworkServiceClient

NewClient - returns a new heal client chain element

Types

type LivenessCheck

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

LivenessCheck - function that returns true of conn is 'live' and false otherwise

type Option

type Option func(o *options)

Option - option for heal.NewClient() chain element

func WithLivenessCheck

func WithLivenessCheck(livenessCheck LivenessCheck) Option

WithLivenessCheck - sets the data plane liveness checker

func WithLivenessCheckInterval

func WithLivenessCheckInterval(livenessCheckInterval time.Duration) Option

WithLivenessCheckInterval - sets livenessCheckInterval

func WithLivenessCheckTimeout

func WithLivenessCheckTimeout(livenessCheckTimeout time.Duration) Option

WithLivenessCheckTimeout - sets livenessCheckTimeout