nsmgr

Documentation

Overview

Package nsmgr provides a Network Service Manager (nsmgrServer), but interface and implementation

Index

• type Nsmgr
  • func NewServer(ctx context.Context, tokenGenerator token.GeneratorFunc, options ...Option) Nsmgr
• type Option
  • func WithAuthorizeServer(authorizeServer networkservice.NetworkServiceServer) Option
  • func WithDialOptions(dialOptions ...grpc.DialOption) Option
  • func WithDialTimeout(dialTimeout time.Duration) Option
  • func WithForwarderServiceName(forwarderServiceName string) Option
  • func WithName(name string) Option
  • func WithRegistry(regURL *url.URL, regDialOptions ...grpc.DialOption) Option
  • func WithURL(u string) Option

Types

type Nsmgr

type Nsmgr interface {
	networkservice.NetworkServiceServer
	networkservice.MonitorConnectionServer
	registry.Registry
}

Nsmgr - A simple combination of the Endpoint, registry.NetworkServiceRegistryServer, and registry.NetworkServiceDiscoveryServer interfaces

func NewServer

func NewServer(ctx context.Context, tokenGenerator token.GeneratorFunc, options ...Option) Nsmgr

NewServer - Creates a new Nsmgr

          tokenGenerator - authorization token generator
			 options - a set of Nsmgr options.

type Option

type Option func(o *serverOptions)

Option modifies server option value

func WithAuthorizeServer

func WithAuthorizeServer(authorizeServer networkservice.NetworkServiceServer) Option

WithAuthorizeServer sets authorization server chain element

func WithDialOptions

func WithDialOptions(dialOptions ...grpc.DialOption) Option

WithDialOptions sets grpc.DialOptions for the client

func WithDialTimeout

func WithDialTimeout(dialTimeout time.Duration) Option

WithDialTimeout sets dial timeout for the client

func WithForwarderServiceName

func WithForwarderServiceName(forwarderServiceName string) Option

WithForwarderServiceName overrides default forwarder service name By default "forwarder"

func WithName

func WithName(name string) Option

WithName - set a nsmgr name, a default name is `Nsmgr`.

func WithRegistry

func WithRegistry(regURL *url.URL, regDialOptions ...grpc.DialOption) Option

WithRegistry sets URL and dial options to reach the upstream registry, if not passed memory storage will be used.

func WithURL

func WithURL(u string) Option

WithURL - set a public URL address for NetworkServiceManager, it is used to access endpoints within this NSMgr from remote clients. Default value is not set, and endpoints address will not be changed.