upstreamrefresh

Documentation

Overview

Package upstreamrefresh provides a client chain element that receives monitor connectionEvents and processes those that have refresh_requested state

Index

• func NewClient(chainCtx context.Context, opts ...Option) networkservice.NetworkServiceClient
• type Notifier
  • func LoadLocalNotifier(ctx context.Context, isClient bool) (value Notifier, ok bool)
• type Option
  • func WithLocalNotifications() Option

Functions

func NewClient

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

NewClient - returns a new upstreamrefresh chain element

Types

type Notifier

type Notifier interface {
	Notify(ctx context.Context, initiatorID string)
}

Notifier - interface for local notifications sending

func LoadLocalNotifier

func LoadLocalNotifier(ctx context.Context, isClient bool) (value Notifier, ok bool)

LoadLocalNotifier loads Notifier stored in per Connection.Id metadata. The loaded result reports whether the key was present.

type Option

type Option func(o *options)

Option - option for upstreamrefresh chain element

func WithLocalNotifications

func WithLocalNotifications() Option

WithLocalNotifications - allows all connections to receive events, if at least one of them received an event from upstream.