northbound

Documentation

Overview

Package northbound houses implementations of various application-oriented interfaces for the ONOS configuration subsystem.

Index

• type SecurityConfig
• type Server
  • func NewServer(cfg *ServerConfig) *Server
  • func (s *Server) AddService(r Service)
  • func (s *Server) GracefulStop()
  • func (s *Server) Serve(started func(string)) error
  • func (s *Server) Stop()
• type ServerConfig
  • func NewServerCfg(caPath string, keyPath string, certPath string, port int16, insecure bool, ...) *ServerConfig
  • func NewServerConfig(caPath string, keyPath string, certPath string, port int16, insecure bool) *ServerConfig
• type Service

Types

type SecurityConfig

type SecurityConfig struct {
	AuthenticationEnabled bool
	AuthorizationEnabled  bool
}

SecurityConfig security configuration

type Server

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

Server provides NB gNMI server for onos-config.

func NewServer

func NewServer(cfg *ServerConfig) *Server

NewServer initializes gNMI server using the supplied configuration.

func (*Server) AddService

func (s *Server) AddService(r Service)

AddService adds a Service to the server to be registered on Serve.

func (*Server) GracefulStop

func (s *Server) GracefulStop()

GracefulStop stops the server gracefully.

func (*Server) Serve

func (s *Server) Serve(started func(string)) error

Serve starts the NB gNMI server.

func (*Server) Stop

func (s *Server) Stop()

Stop stops the server.

type ServerConfig

type ServerConfig struct {
	CaPath      *string
	KeyPath     *string
	CertPath    *string
	Port        int16
	Insecure    bool
	SecurityCfg *SecurityConfig
}

ServerConfig comprises a set of server configuration options.

func NewServerCfg

func NewServerCfg(caPath string, keyPath string, certPath string, port int16, insecure bool, secCfg SecurityConfig) *ServerConfig

NewServerCfg creates a server config created with the specified end-point security details.

func NewServerConfig

func NewServerConfig(caPath string, keyPath string, certPath string, port int16, insecure bool) *ServerConfig

NewServerConfig creates a server config created with the specified end-point security details. Deprecated: Use NewServerCfg instead

type Service

type Service interface {
	Register(s *grpc.Server)
}

Service provides service-specific registration for grpc services.