Documentation
¶
Index ¶
- Constants
- type AtomicBool
- type ConfigurationStruct
- func (c *ConfigurationStruct) EmptyWritablePtr() interface{}
- func (c *ConfigurationStruct) GetBootstrap() bootstrapConfig.BootstrapConfiguration
- func (c *ConfigurationStruct) GetInsecureSecrets() bootstrapConfig.InsecureSecrets
- func (c *ConfigurationStruct) GetLogLevel() string
- func (c *ConfigurationStruct) GetRegistryInfo() bootstrapConfig.RegistryInfo
- func (c *ConfigurationStruct) UpdateFromRaw(rawConfig interface{}) bool
- func (c *ConfigurationStruct) UpdateWritableFromRaw(rawWritable interface{}) bool
- type Credentials
- type EdgeXClients
- type ExternalMqttConfig
- type PipelineFunction
- type PipelineInfo
- type ServiceInfo
- type StoreAndForwardInfo
- type TriggerInfo
- type WritableInfo
Constants ¶
const ( CoreCommandClientName = "Command" CoreDataClientName = "CoreData" NotificationsClientName = "Notifications" )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AtomicBool ¶
type AtomicBool struct {
// contains filtered or unexported fields
}
func (*AtomicBool) Set ¶
func (b *AtomicBool) Set(v bool)
func (*AtomicBool) Value ¶
func (b *AtomicBool) Value() bool
type ConfigurationStruct ¶
type ConfigurationStruct struct {
// Writable contains the configuration that change be change on the fly
Writable WritableInfo
// Registry contains the configuration for connecting the Registry service
Registry bootstrapConfig.RegistryInfo
// Service contains the standard 'service' configuration for the Application service
Service ServiceInfo
// Trigger contains the configuration for the Function Pipeline Trigger
Trigger TriggerInfo
// ApplicationSettings contains the custom configuration for the Application service
ApplicationSettings map[string]string
// Clients contains the configuration for connecting to the dependent Edgex clients
Clients map[string]bootstrapConfig.ClientInfo
// Database contains the configuration for connection to the Database
Database db.DatabaseInfo
// SecretStore contains the configuration for connection to the Secret Store when in secure mode
SecretStore bootstrapConfig.SecretStoreInfo
}
ConfigurationStruct swagger:model ConfigurationStruct
func (*ConfigurationStruct) EmptyWritablePtr ¶
func (c *ConfigurationStruct) EmptyWritablePtr() interface{}
EmptyWritablePtr returns a pointer to an empty WritableInfo struct. It is used by the bootstrap to provide the appropriate structure for Config Client's WatchForChanges().
func (*ConfigurationStruct) GetBootstrap ¶
func (c *ConfigurationStruct) GetBootstrap() bootstrapConfig.BootstrapConfiguration
GetBootstrap returns the configuration elements required by the bootstrap.
func (*ConfigurationStruct) GetInsecureSecrets ¶
func (c *ConfigurationStruct) GetInsecureSecrets() bootstrapConfig.InsecureSecrets
GetInsecureSecrets returns the service's InsecureSecrets.
func (*ConfigurationStruct) GetLogLevel ¶
func (c *ConfigurationStruct) GetLogLevel() string
GetLogLevel returns log level from the configuration
func (*ConfigurationStruct) GetRegistryInfo ¶
func (c *ConfigurationStruct) GetRegistryInfo() bootstrapConfig.RegistryInfo
GetRegistryInfo returns the RegistryInfo section from the configuration
func (*ConfigurationStruct) UpdateFromRaw ¶
func (c *ConfigurationStruct) UpdateFromRaw(rawConfig interface{}) bool
UpdateFromRaw converts configuration received from the registry to a service-specific configuration struct which is then used to overwrite the service's existing configuration struct.
func (*ConfigurationStruct) UpdateWritableFromRaw ¶
func (c *ConfigurationStruct) UpdateWritableFromRaw(rawWritable interface{}) bool
UpdateWritableFromRaw updates the Writeable section of configuration from raw update received from Configuration Provider.
type Credentials ¶
Credentials encapsulates username-password attributes.
type EdgeXClients ¶
type EdgeXClients struct {
LoggingClient logger.LoggingClient
EventClient coredata.EventClient
CommandClient command.CommandClient
ValueDescriptorClient coredata.ValueDescriptorClient
NotificationsClient notifications.NotificationsClient
}
type ExternalMqttConfig ¶
type ExternalMqttConfig struct {
// Url contains the fully qualified URL to connect to the MQTT broker
Url string
// ClientId to connect to the broker with.
ClientId string
// ConnectTimeout is a time duration indicating how long to wait timing out on the broker connection
ConnectTimeout string
// AutoReconnect indicated whether or not to retry connection if disconnected
AutoReconnect bool
// KeepAlive is seconds between client ping when no active data flowing to avoid client being disconnected
KeepAlive int64
// QoS for MQTT Connection
QoS byte
// Retain setting for MQTT Connection
Retain bool
// SkipCertVerify indicates if the certificate verification should be skipped
SkipCertVerify bool
// SecretPath is the name of the path in secret provider to retrieve your secrets
SecretPath string
// AuthMode indicates what to use when connecting to the broker. Options are "none", "cacert" , "usernamepassword", "clientcert".
// If a CA Cert exists in the SecretPath then it will be used for all modes except "none".
AuthMode string
}
ExternalMqttConfig contains the MQTT broker configuration for MQTT Trigger
type PipelineFunction ¶
type PipelineInfo ¶
type PipelineInfo struct {
ExecutionOrder string
UseTargetTypeOfByteArray bool
Functions map[string]PipelineFunction
}
type ServiceInfo ¶
type ServiceInfo struct {
BootTimeout string
CheckInterval string
Host string
HTTPSCert string
HTTPSKey string
ServerBindAddr string
Port int
Protocol string
StartupMsg string
ReadMaxLimit int
Timeout string
}
ServiceInfo is used to hold and configure various settings related to the hosting of this service
type StoreAndForwardInfo ¶
type TriggerInfo ¶
type TriggerInfo struct {
// Type of trigger to start pipeline
// enum: http, edgex-messagebus, or external-mqtt
Type string
// SubscribeTopics is a comma separated list of topics
// Used when Type=edgex-messagebus, or Type=external-mqtt
SubscribeTopics string
// PublishTopic is the topic to publish pipeline output (if any) to
// Used when Type=edgex-messagebus, or Type=external-mqtt
PublishTopic string
// Used when Type=edgex-messagebus
EdgexMessageBus types.MessageBusConfig
// Used when Type=external-mqtt
ExternalMqtt ExternalMqttConfig
}
TriggerInfo contains Metadata associated with each Trigger
type WritableInfo ¶
type WritableInfo struct {
// Set level of logging to report
//
// example: TRACE
// required: true
// enum: TRACE,DEBUG,INFO,WARN,ERROR
LogLevel string
Pipeline PipelineInfo
StoreAndForward StoreAndForwardInfo
InsecureSecrets bootstrapConfig.InsecureSecrets
}
WritableInfo is used to hold configuration information that is considered "live" or can be changed on the fly without a restart of the service.