northbound

Documentation

Overview

Package northbound implements the northbound API of the device provisioner

Index

• type Server
  • func (s *Server) Add(ctx context.Context, request *api.AddConfigRequest) (*api.AddConfigResponse, error)
  • func (s *Server) Delete(ctx context.Context, request *api.DeleteConfigRequest) (*api.DeleteConfigResponse, error)
  • func (s *Server) Get(ctx context.Context, request *api.GetConfigRequest) (*api.GetConfigResponse, error)
  • func (s *Server) List(request *api.ListConfigsRequest, server api.ProvisionerService_ListServer) error
• type Service
  • func NewService(configStore configs.ConfigStore) Service
  • func (s Service) Register(r *grpc.Server)

Types

type Server

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

Server implements the grpc device provisioner service

func (*Server) Add

func (s *Server) Add(ctx context.Context, request *api.AddConfigRequest) (*api.AddConfigResponse, error)

Add registers new pipeline configuration

func (*Server) Delete

func (s *Server) Delete(ctx context.Context, request *api.DeleteConfigRequest) (*api.DeleteConfigResponse, error)

Delete removes a pipeline configuration

func (*Server) Get

func (s *Server) Get(ctx context.Context, request *api.GetConfigRequest) (*api.GetConfigResponse, error)

Get returns pipeline configuration based on a given ID

func (*Server) List

func (s *Server) List(request *api.ListConfigsRequest, server api.ProvisionerService_ListServer) error

List returns all registered pipelines

type Service

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

Service implements the device provisioner NB gRPC

func NewService

func NewService(configStore configs.ConfigStore) Service

NewService allocates a Service struct with the given parameters

func (Service) Register

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

Register registers the server with grpc