gnmi

Documentation

Overview

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

Index

• Constants
• type Extensions
• 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(topo topo.Store, transactions transaction.Store, ...) Service
  • func (s Service) Register(r *grpc.Server)

Constants

const (
	// ExtensionTransactionID transaction ID extension
	ExtensionTransactionID = 100

	// ExtensionTransactionIndex transaction index extension
	ExtensionTransactionIndex = 102
)

const OIDCServerURL = "OIDC_SERVER_URL"

OIDCServerURL - the ENV var that signified security is turned on - no groups will be extracted from request without this

Types

type Extensions

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

Extensions list of gNMI extensions

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(topo topo.Store,
	transactions transaction.Store, configurations configuration.Store, pluginRegistry *pluginregistry.PluginRegistry) 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