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 LivelinessCheck
• type Option
  • func WithLivelinessCheck(livelinessCheck LivelinessCheck) Option

Functions

func NewClient

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

NewClient - returns a new heal client chain element

Types

type LivelinessCheck

type LivelinessCheck func(conn *networkservice.Connection) bool

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

type Option

type Option func(o *option)

Option - option for heal.NewClient() chain element

func WithLivelinessCheck

func WithLivelinessCheck(livelinessCheck LivelinessCheck) Option

WithLivelinessCheck - sets the LivelinessCheck for the heal chain elemeent