gnmi

Documentation

Overview

Package gnmi implements the northbound gNMI service for the configuration subsystem.

Index

• Constants
• type Server
  • func (s *Server) Capabilities(ctx context.Context, req *gnmi.CapabilityRequest) (*gnmi.CapabilityResponse, error)
  • func (s *Server) Get(ctx context.Context, req *gnmi.GetRequest) (*gnmi.GetResponse, error)
  • func (s *Server) Set(ctx context.Context, req *gnmi.SetRequest) (*gnmi.SetResponse, error)
  • func (s *Server) Subscribe(stream gnmi.GNMI_SubscribeServer) error
• type Service
  • func NewService(modelRegistry *modelregistry.ModelRegistry, ...) Service
  • func (s Service) Register(r *grpc.Server)

Constants

const (
	// GnmiExtensionNetwkChangeID is the extension number used in SetRequest and SetResponse
	GnmiExtensionNetwkChangeID = 100

	// GnmiExtensionVersion is used in Set, Get and Subscribe
	GnmiExtensionVersion = 101

	// GnmiExtensionDeviceType is used in Set only when creating a device the first time
	// It can be used as a discriminator on Get when wildcard target is given
	GnmiExtensionDeviceType = 102

	// GnmiExtensionDevicesNotConnected is returned by onos-config in the Set response when the configuration
	// was requested for one or more device which is currently not connected.
	// Not Connected devices are included in the message.
	GnmiExtensionDevicesNotConnected = 103
)

Types

type Server

type Server struct {
	// contains filtered or unexported fields
}

Server implements the grpc GNMI service

func (*Server) Capabilities

func (s *Server) Capabilities(ctx context.Context, req *gnmi.CapabilityRequest) (*gnmi.CapabilityResponse, error)

Capabilities implements gNMI Capabilities

func (*Server) Get

func (s *Server) Get(ctx context.Context, req *gnmi.GetRequest) (*gnmi.GetResponse, error)

Get implements gNMI Get

func (*Server) Set

func (s *Server) Set(ctx context.Context, req *gnmi.SetRequest) (*gnmi.SetResponse, error)

Set implements gNMI Set

func (*Server) Subscribe

func (s *Server) Subscribe(stream gnmi.GNMI_SubscribeServer) error

Subscribe implements gNMI Subscribe

type Service

type Service struct {
	northbound.Service
	// contains filtered or unexported fields
}

Service implements Service for GNMI

func NewService

func NewService(modelRegistry *modelregistry.ModelRegistry,
	pluginRegistry *pluginregistry.PluginRegistry,
	deviceChangesStore device.Store,
	deviceCache cache.Cache,
	networkChangesStore network.Store,
	dispatcher *dispatcher.Dispatcher,
	deviceStore devicestore.Store,
	deviceStateStore state.Store,
	operationalStateCache *map[topodevice.ID]devicechange.TypedValueMap,
	operationalStateCacheLock *sync.RWMutex,
	allowUnvalidatedConfig bool,
	usePluginRegistry bool) Service

NewService allocates a Service struct with the given parameters

func (Service) Register

func (s Service) Register(r *grpc.Server)

Register registers the GNMI server with grpc