rpc

Documentation

Index

• Variables
• type ChangeVppSvc
  • func (svc *ChangeVppSvc) Del(ctx context.Context, data *rpc.DataRequest) (*rpc.DelResponse, error)
  • func (svc *ChangeVppSvc) Put(ctx context.Context, data *rpc.DataRequest) (*rpc.PutResponse, error)
• type Deps
• type GRPCService
• type NotificationSvc
  • func (svc *NotificationSvc) Get(from *rpc.NotificationRequest, server rpc.NotificationService_GetServer) error
• type Option
  • func UseDeps(cb func(*Deps)) Option
• type Plugin
  • func NewPlugin(opts ...Option) *Plugin
  • func (plugin *Plugin) Close() error
  • func (plugin *Plugin) Init() error
  • func (plugin *Plugin) UpdateNotifications(ctx context.Context, notification *interfaces.InterfaceNotification)
• type ResyncVppSvc
  • func (svc *ResyncVppSvc) Resync(ctx context.Context, data *rpc.DataRequest) (*rpc.ResyncResponse, error)

Variables

var DefaultPlugin = *NewPlugin()

DefaultPlugin is default instance of Plugin

Types

type ChangeVppSvc

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

ChangeVppSvc forwards GRPC request to the localclient.

func (*ChangeVppSvc) Del

func (svc *ChangeVppSvc) Del(ctx context.Context, data *rpc.DataRequest) (*rpc.DelResponse, error)

Del removes configuration data present in data request from the VPP/linux

func (*ChangeVppSvc) Put

func (svc *ChangeVppSvc) Put(ctx context.Context, data *rpc.DataRequest) (*rpc.PutResponse, error)

Put adds configuration data present in data request to the VPP/Linux

type Deps

type Deps struct {
	infra.PluginDeps
	GRPCServer grpc.Server
}

Deps - dependencies of Plugin

type GRPCService

type GRPCService interface {

	// updateNotification stores VPP notifications/statistic data. The notification can be read by any client
	// connected to the notification service server
	// todo make type independent
	UpdateNotifications(ctx context.Context, notification *interfaces.InterfaceNotification)
}

GRPCService allows to send VPP notifications to external GRPC endpoints

type NotificationSvc

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

NotificationSvc forwards GRPC messages to external servers.

func (*NotificationSvc) Get

func (svc *NotificationSvc) Get(from *rpc.NotificationRequest, server rpc.NotificationService_GetServer) error

Get returns all required VPP notifications (or those available in the buffer) in the same order as they were received

type Option

type Option func(*Plugin)

Option is a function that acts on a Plugin to inject Dependencies or configuration

func UseDeps

func UseDeps(cb func(*Deps)) Option

UseDeps returns Option that can inject custom dependencies.

type Plugin

type Plugin struct {
	Deps
	// contains filtered or unexported fields
}

Plugin registers VPP GRPC services in *grpc.Server.

func NewPlugin

func NewPlugin(opts ...Option) *Plugin

NewPlugin creates a new Plugin with the provides Options

func (*Plugin) Close

func (plugin *Plugin) Close() error

Close does nothing.

func (*Plugin) Init

func (plugin *Plugin) Init() error

Init sets plugin child loggers for changeVppSvc & resyncVppSvc.

func (*Plugin) UpdateNotifications

func (plugin *Plugin) UpdateNotifications(ctx context.Context, notification *interfaces.InterfaceNotification)

UpdateNotifications stores new notification data

type ResyncVppSvc

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

ResyncVppSvc forwards GRPC request to the localclient.

func (*ResyncVppSvc) Resync

func (svc *ResyncVppSvc) Resync(ctx context.Context, data *rpc.DataRequest) (*rpc.ResyncResponse, error)

Resync creates a resync request which adds data tp the VPP/linux