azure-container-networking/cns/common/service.go

// Copyright 2017 Microsoft. All rights reserved.
// MIT License

package common

import (
	"errors"

	"github.com/Azure/azure-container-networking/cns/logger"
	acn "github.com/Azure/azure-container-networking/common"
	"github.com/Azure/azure-container-networking/server/tls"
	"github.com/Azure/azure-container-networking/store"
)

// Service implements behavior common to all services.
type Service struct {
	Name        string
	Version     string
	Options     map[string]interface{}
	ErrChan     chan<- error
	Store       store.KeyValueStore
	ChannelMode string
}

// ServiceAPI defines base interface.
type ServiceAPI interface {
	Init(*ServiceConfig) error
	Start(*ServiceConfig) error
	Stop()
	GetOption(string) interface{}
	SetOption(string, interface{})
}

// ServiceConfig specifies common configuration.
type ServiceConfig struct {
	Name        string
	Version     string
	Listener    *acn.Listener
	ErrChan     chan<- error
	Store       store.KeyValueStore
	Server      server
	ChannelMode string
	TLSSettings tls.TlsSettings
}

// server struct to store primaryInterfaceIP from VM, port where customer provides by -p and temporary flag EnableLocalServer
type server struct {
	PrimaryInterfaceIP string
	Port               string
	EnableLocalServer  bool // TODO: Remove this flag once -c option gets deprecated
}

// NewService creates a new Service object.
func NewService(name, version, channelMode string, store store.KeyValueStore) (*Service, error) {
	logger.Debugf("[Azure CNS] Going to create a service object with name: %v. version: %v.", name, version)

	svc := &Service{
		Name:        name,
		Version:     version,
		ChannelMode: channelMode,
		Options:     make(map[string]interface{}),
		Store:       store,
	}

	logger.Debugf("[Azure CNS] Finished creating service object with name: %v. version: %v. managed: %s", name, version, channelMode)
	return svc, nil
}

// Initialize initializes the service.
func (service *Service) Initialize(config *ServiceConfig) error {
	if config == nil {
		err := "[Azure CNS Errror] Initialize called with nil ServiceConfig."
		logger.Errorf(err)
		return errors.New(err)
	}

	logger.Debugf("[Azure CNS] Going to initialize the service: %+v with config: %+v.", service, config)

	service.ErrChan = config.ErrChan
	service.Store = config.Store
	service.Version = config.Version
	service.ChannelMode = config.ChannelMode

	logger.Debugf("[Azure CNS] nitialized service: %+v with config: %+v.", service, config)

	return nil
}

// Uninitialize cleans up the service.
func (service *Service) Uninitialize() {
}

// GetOption gets the option value for the given key.
func (service *Service) GetOption(key string) interface{} {
	return service.Options[key]
}

// SetOption sets the option value for the given key.
func (service *Service) SetOption(key string, value interface{}) {
	service.Options[key] = value
}