common

Documentation

Index

• Constants
• type BindingInfo
• type ClientInfo
  • func (c ClientInfo) Url() string
• type ConfigurationStruct
  • func LoadFromFile(profile string, configDir string) (configuration *ConfigurationStruct, err error)
• type EdgeXClients
• type LoggingInfo
• type PipelineFunction
• type PipelineInfo
• type RegistryInfo
• type ServiceInfo
• type StoreAndForwardInfo
• type WritableInfo

Constants

const (
	LoggingClientName       = "Logging"
	CoreCommandClientName   = "Command"
	CoreDataClientName      = "CoreData"
	NotificationsClientName = "Notifications"
)

Types

type BindingInfo

type BindingInfo struct {
	Type           string
	Name           string
	SubscribeTopic string
	PublishTopic   string
}

BindingInfo contains Metadata associated with each binding

type ClientInfo

type ClientInfo struct {
	// Host is the hostname or IP address of a service.
	Host string
	// Port defines the port on which to access a given service
	Port int
	// Protocol indicates the protocol to use when accessing a given service
	Protocol string
}

ClientInfo provides the host and port of another service in the eco-system.

func (ClientInfo) Url

func (c ClientInfo) Url() string

type ConfigurationStruct

type ConfigurationStruct struct {
	Writable            WritableInfo
	Logging             LoggingInfo
	Registry            RegistryInfo
	Service             ServiceInfo
	MessageBus          types.MessageBusConfig
	Binding             BindingInfo
	ApplicationSettings map[string]string
	Clients             map[string]ClientInfo
	Database            db.DatabaseInfo
}

ConfigurationStruct ...

func LoadFromFile

func LoadFromFile(profile string, configDir string) (configuration *ConfigurationStruct, err error)

LoadFromFile loads .toml file for configuration

type EdgeXClients

type EdgeXClients struct {
	LoggingClient         logger.LoggingClient
	EventClient           coredata.EventClient
	CommandClient         command.CommandClient
	ValueDescriptorClient coredata.ValueDescriptorClient
	NotificationsClient   notifications.NotificationsClient
}

type LoggingInfo

type LoggingInfo struct {
	EnableRemote bool
	File         string
}

LoggingInfo ...

type PipelineFunction

type PipelineFunction struct {
	// Name	string
	Parameters  map[string]string
	Addressable models.Addressable
}

type PipelineInfo

type PipelineInfo struct {
	ExecutionOrder           string
	UseTargetTypeOfByteArray bool
	Functions                map[string]PipelineFunction
}

type RegistryInfo

type RegistryInfo struct {
	Host string
	Port int
	Type string
}

RegistryInfo ...

type ServiceInfo

type ServiceInfo struct {
	BootTimeout   int
	CheckInterval string
	ClientMonitor int
	Host          string
	Port          int
	Protocol      string
	StartupMsg    string
	ReadMaxLimit  int
	Timeout       int
}

ServiceInfo ...

type StoreAndForwardInfo

type StoreAndForwardInfo struct {
	Enabled       bool
	RetryInterval int
	MaxRetryCount int
}

type WritableInfo

type WritableInfo struct {
	LogLevel        string
	Pipeline        PipelineInfo
	StoreAndForward StoreAndForwardInfo
}

WritableInfo ...