Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

client

package

Go to main page

Versions in this module

v1

v1.0.0

May 29, 2024

Changes in this version

+ func NewDefinitionID(namespace string, name string, version string) model.DefinitionID

+ func NewDefinitionIDFromString(full string) model.DefinitionID

+ func NewFeature(name string, opts ...FeatureOpt) model.Feature

+ func NewHeaders(opts ...HeaderOpt) protocol.Headers

+ func NewNamespacedID(namespace string, name string) model.NamespacedID

+ func NewNamespacedIDFromString(full string) model.NamespacedID

+ func NewThing(opts ...ThingOpt) model.Thing

+ type Client struct

+ func NewClient(cfg *Configuration) *Client

+ func (client *Client) Connect() error

+ func (client *Client) Create(id model.NamespacedID, thing model.Thing) error

+ func (client *Client) Disconnect()

+ func (client *Client) Get(id model.NamespacedID) model.Thing

+ func (client *Client) GetThingsRegistryChangedHandler() handlers.ThingsRegistryChangedHandler

+ func (client *Client) Remove(id model.NamespacedID) error

+ func (client *Client) SetThingsRegistryChangedHandler(handler handlers.ThingsRegistryChangedHandler)

+ func (client *Client) Update(id model.NamespacedID) error

+ type Configuration struct

+ func NewConfiguration() *Configuration

+ func (cfg *Configuration) AcknowledgeTimeout() time.Duration

+ func (cfg *Configuration) Broker() string

+ func (cfg *Configuration) ClientPassword() string

+ func (cfg *Configuration) ClientUsername() string

+ func (cfg *Configuration) ConnectTimeout() time.Duration

+ func (cfg *Configuration) DeviceAuthID() string

+ func (cfg *Configuration) DeviceName() string

+ func (cfg *Configuration) DevicePassword() string

+ func (cfg *Configuration) DeviceTenantID() string

+ func (cfg *Configuration) DisconnectTimeout() time.Duration

+ func (cfg *Configuration) GatewayDeviceID() string

+ func (cfg *Configuration) InitHook() InitializedHook

+ func (cfg *Configuration) KeepAlive() time.Duration

+ func (cfg *Configuration) RegistryChangedHandler() handlers.ThingsRegistryChangedHandler

+ func (cfg *Configuration) SubscribeTimeout() time.Duration

+ func (cfg *Configuration) TLSConfig() (rootCA, clientCert, clientKey string)

+ func (cfg *Configuration) UnsubscribeTimeout() time.Duration

+ func (cfg *Configuration) WithAcknowledgeTimeout(acknowledgeTimeout time.Duration) *Configuration

+ func (cfg *Configuration) WithBroker(broker string) *Configuration

+ func (cfg *Configuration) WithClientPassword(password string) *Configuration

+ func (cfg *Configuration) WithClientUsername(username string) *Configuration

+ func (cfg *Configuration) WithConnectTimeout(connectTimeout time.Duration) *Configuration

+ func (cfg *Configuration) WithDeviceAuthID(deviceAuthID string) *Configuration

+ func (cfg *Configuration) WithDeviceName(name string) *Configuration

+ func (cfg *Configuration) WithDevicePassword(devicePassword string) *Configuration

+ func (cfg *Configuration) WithDeviceTenantID(deviceTenantID string) *Configuration

+ func (cfg *Configuration) WithDisconnectTimeout(disconnectTimeout time.Duration) *Configuration

+ func (cfg *Configuration) WithGatewayDeviceID(deviceID string) *Configuration

+ func (cfg *Configuration) WithInitHook(hook InitializedHook) *Configuration

+ func (cfg *Configuration) WithKeepAlive(keepAlive time.Duration) *Configuration

+ func (cfg *Configuration) WithSubscribeTimeout(subscribeTimeout time.Duration) *Configuration

+ func (cfg *Configuration) WithTLSConfig(rootCA, clientCert, clientKey string) *Configuration

+ func (cfg *Configuration) WithThingsRegistryChangedHandler(handler handlers.ThingsRegistryChangedHandler) *Configuration

+ func (cfg *Configuration) WithUnsubscribeTimeout(unsubscribeTimeout time.Duration) *Configuration

+ type Device interface

+ GetConnection func() DeviceConnection

+ GetCredentials func() DeviceCredentials

+ GetID func() model.NamespacedID

+ GetTenantID func() string

+ GetViaGateway func() model.NamespacedID

+ type DeviceConnection interface

+ SendEvent func(envelope protocol.Envelope) error

+ SendTelemetry func(envelope protocol.Envelope) error

+ type DeviceCredentials interface

+ GetAuthID func() string

+ GetPassword func() string

+ type DeviceOpt func(devOpt *devOpts) error

+ func WithDeviceCredentials(authID string, pass string) DeviceOpt

+ func WithDeviceID(id string) DeviceOpt

+ func WithDeviceTenantID(tenantID string) DeviceOpt

+ func WithViaGateway(id string) DeviceOpt

+ type FeatureOpt func(feature *feature) error

+ func WithFeatureDefinition(definitions ...model.DefinitionID) FeatureOpt

+ func WithFeatureDefinitionChangedHandler(handler handlers.FeatureDefinitionChangedHandler) FeatureOpt

+ func WithFeatureDefinitionFromString(definitions ...string) FeatureOpt

+ func WithFeatureOperationsHandler(handler handlers.FeatureOperationsHandler) FeatureOpt

+ func WithFeatureProperties(properties map[string]interface{}) FeatureOpt

+ func WithFeatureProperty(id string, value interface{}) FeatureOpt

+ func WithFeaturePropertyChangedHandler(handler handlers.FeaturePropertyChangedHandler) FeatureOpt

+ type HeaderOpt func(hdrs *headers) error

+ func WithContentType(contentType string) HeaderOpt

+ func WithCorrelationID(correlationID string) HeaderOpt

+ func WithReplyTo(replyTo string) HeaderOpt

+ func WithResponseRequired(isResponseRequired bool) HeaderOpt

+ type InitializedHook func(client *Client, configuration *Configuration, err error)

+ type ThingError struct

+ ErrorCode dittoError

+ Message string

+ Status int

+ func NewMessagesInternalError(messageFormat string, args ...interface{}) *ThingError

+ func NewMessagesParameterInvalidError(messageFormat string, args ...interface{}) *ThingError

+ func NewMessagesSubjectNotFound(messageFormat string, args ...interface{}) *ThingError

+ func (thErr *ThingError) Error() string

+ type ThingOpt func(thing *thing) error

+ func WithThingAttribute(id string, value interface{}) ThingOpt

+ func WithThingAttributeChangedHandler(handler handlers.ThingAttributeChangedHandler) ThingOpt

+ func WithThingAttributes(attrs map[string]interface{}) ThingOpt

+ func WithThingDefinition(namespace string, name string, version string) ThingOpt

+ func WithThingDefinitionChangedHandler(handler handlers.ThingDefinitionChangedHandler) ThingOpt

+ func WithThingFeature(id string, value model.Feature) ThingOpt

+ func WithThingFeatureChangedHandler(handler handlers.ThingFeatureChangedHandler) ThingOpt

+ func WithThingFeatureFrom(id string, featureOpts ...FeatureOpt) ThingOpt

+ func WithThingFeatures(features map[string]model.Feature) ThingOpt

+ func WithThingID(namespace string, name string) ThingOpt

+ func WithThingOperationsHandler(handler handlers.ThingOperationsHandler) ThingOpt

+ func WithThingPolicy(namespace string, name string) ThingOpt

v0

v0.1.0-M4

Aug 24, 2023

v0.1.0-M3

May 23, 2023

v0.1.0-M2

Sep 26, 2022

v0.1.0-M1

Mar 2, 2022