cvclient

Documentation

Overview

Package cvclient defines an interface for connecting to and communicating with CloudVision.

Index

• type CVClient

Types

type CVClient

type CVClient interface {
	// Clients will usually communicate with CloudVision using gNMI
	// but can use some other protocol as well, all they need to do
	// is to implement the GNMIClient interface.
	gnmi.GNMIClient
	// SendDeviceMetadata sends metadata for the device to CV.
	SendDeviceMetadata(ctx context.Context) error
	// SendPeriodicUpdate sends information about device liveness to CV.
	SendHeartbeat(ctx context.Context, alive bool) error
	// ForProvider returns a new client instance for the same device but
	// customized for a specific provider.
	ForProvider(p provider.GNMIProvider) CVClient
	// SetManagedDevices sets the current list of managed device IDs. The list
	// is pushed in the next heartbeat cycle.
	SetManagedDevices([]string)
}

CVClient defines the interface that needs to be implemented for communicating with CloudVision.