things

Documentation

Index

• Constants
• type UpdateThingsManager
• type UpdateThingsManagerOpt
  • func WithConnectionAcknowledgeTimeout(acknowledgeTimeout time.Duration) UpdateThingsManagerOpt
  • func WithConnectionBroker(broker string) UpdateThingsManagerOpt
  • func WithConnectionClientPassword(password string) UpdateThingsManagerOpt
  • func WithConnectionClientUsername(username string) UpdateThingsManagerOpt
  • func WithConnectionConnectTimeout(connectTimeout time.Duration) UpdateThingsManagerOpt
  • func WithConnectionDisconnectTimeout(disconnectTimeout time.Duration) UpdateThingsManagerOpt
  • func WithConnectionKeepAlive(keepAlive time.Duration) UpdateThingsManagerOpt
  • func WithConnectionSubscribeTimeout(subscribeTimeout time.Duration) UpdateThingsManagerOpt
  • func WithConnectionUnsubscribeTimeout(unsubscribeTimeout time.Duration) UpdateThingsManagerOpt
  • func WithFeatures(featureIds []string) UpdateThingsManagerOpt
  • func WithMetaPath(path string) UpdateThingsManagerOpt

Constants

const (
	SoftwareUpdatableManifestsFeatureID = "SoftwareUpdatable:manifest"
)

Constants the define the respective Ditto feature based on the SU v2 Vorto model

const (
	// ThingsUpdateManagerServiceLocalID is the ID of the things management service in the registry
	ThingsUpdateManagerServiceLocalID = "updatemanagerd.service.local.v1.service-things-update-manager"
)

const (
	UpdateOrchestratorFeatureID = "UpdateOrchestrator"
)

Constants the define the respective Ditto feature based on the UpdateOrchestrator Vorto model

Types

type UpdateThingsManager

type UpdateThingsManager interface {
	Connect() error
	Disconnect()
}

UpdateThingsManager is the things management abstraction

type UpdateThingsManagerOpt

type UpdateThingsManagerOpt func(thingsOptions *thingsOpts) error

UpdateThingsManagerOpt represents the available configuration options for the UpdateThingsManager service

func WithConnectionAcknowledgeTimeout

func WithConnectionAcknowledgeTimeout(acknowledgeTimeout time.Duration) UpdateThingsManagerOpt

WithConnectionAcknowledgeTimeout configures the timeout for the acknowledge receival

func WithConnectionBroker

func WithConnectionBroker(broker string) UpdateThingsManagerOpt

WithConnectionBroker configures the broker, where the connection will be established

func WithConnectionClientPassword

func WithConnectionClientPassword(password string) UpdateThingsManagerOpt

WithConnectionClientPassword configures the client password used when establishing connection to the broker

func WithConnectionClientUsername

func WithConnectionClientUsername(username string) UpdateThingsManagerOpt

WithConnectionClientUsername configures the client username used when establishing connection to the broker

func WithConnectionConnectTimeout

func WithConnectionConnectTimeout(connectTimeout time.Duration) UpdateThingsManagerOpt

WithConnectionConnectTimeout configures the timeout before terminating the connect attempt

func WithConnectionDisconnectTimeout

func WithConnectionDisconnectTimeout(disconnectTimeout time.Duration) UpdateThingsManagerOpt

WithConnectionDisconnectTimeout configures the duration of inactivity before disconnecting from the broker

func WithConnectionKeepAlive

func WithConnectionKeepAlive(keepAlive time.Duration) UpdateThingsManagerOpt

WithConnectionKeepAlive configures the time between between each check for the connection presence

func WithConnectionSubscribeTimeout

func WithConnectionSubscribeTimeout(subscribeTimeout time.Duration) UpdateThingsManagerOpt

WithConnectionSubscribeTimeout configures the timeout before terminating the subscribe attempt

func WithConnectionUnsubscribeTimeout

func WithConnectionUnsubscribeTimeout(unsubscribeTimeout time.Duration) UpdateThingsManagerOpt

WithConnectionUnsubscribeTimeout configures the timeout before terminating the unsubscribe attempt

func WithFeatures

func WithFeatures(featureIds []string) UpdateThingsManagerOpt

WithFeatures configures the update manager runtime's Things representation via providing the desired Ditto Features to be created by ID

func WithMetaPath

func WithMetaPath(path string) UpdateThingsManagerOpt

WithMetaPath configures the directory to be used for storage by the service