Documentation
¶
Overview ¶
******************************************************************************
- Copyright 2020 Intel Corp. *
- Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
- in compliance with the License. You may obtain a copy of the License at *
- http://www.apache.org/licenses/LICENSE-2.0 *
- Unless required by applicable law or agreed to in writing, software distributed under the License
- is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
- or implied. See the License for the specific language governing permissions and limitations under
- the License. ******************************************************************************
Index ¶
- Constants
- type Processor
- func (cp *Processor) ListenForCustomConfigChanges(configToWatch interface{}, sectionName string, ...)
- func (cp *Processor) LoadCustomConfigSection(config interfaces.UpdatableConfig, sectionName string) error
- func (cp *Processor) Process(serviceKey string, configStem string, serviceConfig interfaces.Configuration, ...) error
- type ProviderInfo
- type UpdatedStream
Constants ¶
const (
ConfigVersion = "2.0"
)
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Processor ¶
type Processor struct {
// contains filtered or unexported fields
}
func NewProcessor ¶
func NewProcessor( flags flags.Common, envVars *environment.Variables, startupTimer startup.Timer, ctx context.Context, wg *sync.WaitGroup, configUpdated UpdatedStream, dic *di.Container, ) *Processor
NewProcessor creates a new configuration Processor
func (*Processor) ListenForCustomConfigChanges ¶
func (cp *Processor) ListenForCustomConfigChanges( configToWatch interface{}, sectionName string, changedCallback func(interface{}))
ListenForCustomConfigChanges listens for changes to the specified custom configuration section. When changes occur it applies the changes to the custom configuration section and signals the the changes have occurred.
func (*Processor) LoadCustomConfigSection ¶
func (cp *Processor) LoadCustomConfigSection(config interfaces.UpdatableConfig, sectionName string) error
LoadCustomConfigSection loads the specified custom configuration section from file or Configuration provider. Section will be seed if Configuration provider does yet have it. This is used for structures custom configuration in App and Device services
func (*Processor) Process ¶
func (cp *Processor) Process( serviceKey string, configStem string, serviceConfig interfaces.Configuration, useSecretProvider bool) error
type ProviderInfo ¶
type ProviderInfo struct {
// contains filtered or unexported fields
}
ProviderInfo encapsulates the usage of the Configuration Provider information
func NewProviderInfo ¶
func NewProviderInfo(envVars *environment.Variables, providerUrl string) (*ProviderInfo, error)
NewProviderInfo creates a new ProviderInfo and initializes it
func (ProviderInfo) ServiceConfig ¶
func (config ProviderInfo) ServiceConfig() types.ServiceConfig
ServiceConfig returns service configuration for the Configuration Provider
func (ProviderInfo) UseProvider ¶
func (config ProviderInfo) UseProvider() bool
UseProvider returns whether the Configuration Provider should be used or not.
type UpdatedStream ¶
type UpdatedStream chan struct{}
UpdatedStream defines the stream type that is notified by ListenForChanges when a configuration update is received.
Source Files