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 28, 2024

Changes in this version

+ const InfoPrefix

+ const ModeLax

+ const ModeNA

+ const ModeNameLax

+ const ModeNameScoped

+ const ModeNameStrict

+ const ModeScoped

+ const ModeStrict

+ const StateCanceled

+ const StateFailed

+ const StatePaused

+ const StatePending

+ const StateSuccess

+ const StateUploading

+ const StorageProvider

+ type AccessMode int

+ func (m *AccessMode) Set(v string) error

+ func (m *AccessMode) UnmarshalJSON(b []byte) error

+ func (m AccessMode) MarshalJSON() ([]byte, error)

+ func (m AccessMode) String() string

+ type AutoUploadable struct

+ func NewAutoUploadable(uploadableCfg *UploadableConfig, handler UploadCustomizer, ...) (*AutoUploadable, error)

+ func (u *AutoUploadable) Connect(mqttClient MQTT.Client, edgeCfg *EdgeConfiguration)

+ func (u *AutoUploadable) Disconnect()

+ func (u *AutoUploadable) UpdateProperty(featureID string, value interface{})

+ func (u *AutoUploadable) UploadFiles(correlationID string, files []string, options map[string]string)

+ type AutoUploadableState struct

+ Active bool

+ EndTime *time.Time

+ StartTime *time.Time

+ type BrokerConfig struct

+ Broker string

+ CaCert string

+ Cert string

+ Key string

+ Password string

+ Username string

+ type Duration time.Duration

+ func (d *Duration) Set(s string) error

+ func (d *Duration) UnmarshalJSON(b []byte) error

+ func (d Duration) String() string

+ type EdgeClient interface

+ Connect func(client MQTT.Client, cfg *EdgeConfiguration)

+ Disconnect func()

+ type EdgeConfiguration struct

+ DeviceID string

+ PolicyID string

+ TenantID string

+ type EdgeConnector struct

+ func NewEdgeConnector(cfg *BrokerConfig, ecl EdgeClient) (*EdgeConnector, error)

+ func (p *EdgeConnector) Close()

+ type ErrorCode string

+ const ErrorCodeExecutionFailed

+ const ErrorCodeParameterInvalid

+ type ErrorResponse struct

+ ErrorCode ErrorCode

+ Message string

+ Status int

+ func (e *ErrorResponse) Error() string

+ type FileUpload struct

+ func NewFileUpload(filesGlob string, mode AccessMode, uploadableCfg *UploadableConfig) (*FileUpload, error)

+ func (fu *FileUpload) Connect(client MQTT.Client, edgeCfg *EdgeConfiguration)

+ func (fu *FileUpload) Disconnect()

+ func (fu *FileUpload) DoTrigger(correlationID string, options map[string]string) error

+ func (fu *FileUpload) HandleOperation(operation string, payload []byte) *ErrorResponse

+ func (fu *FileUpload) OnTick()

+ type MultiUpload struct

+ type PeriodicExecutor struct

+ func NewPeriodicExecutor(from *time.Time, to *time.Time, period time.Duration, task func()) *PeriodicExecutor

+ func (e *PeriodicExecutor) Stop()

+ type SingleUpload struct

+ func (u *SingleUpload) String() string

+ type StatusEventsConsumer struct

+ func NewStatusEventsConsumer(size int) *StatusEventsConsumer

+ func (q *StatusEventsConsumer) Add(e interface{})

+ func (q *StatusEventsConsumer) Start(consume func(e interface{}))

+ func (q *StatusEventsConsumer) Stop()

+ type Upload interface

+ type UploadCustomizer interface

+ DoTrigger func(correlationID string, options map[string]string) error

+ HandleOperation func(operation string, payload []byte) *ErrorResponse

+ OnTick func()

+ type UploadStatus struct

+ CorrelationID string

+ EndTime time.Time

+ Info map[string]string

+ Message string

+ Progress int

+ StartTime time.Time

+ State string

+ StatusCode string

+ type UploadStatusListener interface

+ type UploadableConfig struct

+ Active bool

+ ActiveFrom Xtime

+ ActiveTill Xtime

+ Checksum bool

+ Context string

+ Delete bool

+ FeatureID string

+ Period Duration

+ ServerCert string

+ SingleUpload bool

+ StopTimeout Duration

+ Type string

+ func (cfg *UploadableConfig) Validate()

+ type Uploads struct

+ func NewUploads() *Uploads

+ func (us *Uploads) AddMulti(correlationID string, paths []string, deleteUploaded bool, useChecksum bool, ...) []string

+ func (us *Uploads) AddSingle(parent *MultiUpload, correlationID string, filePath string)

+ func (us *Uploads) Get(correlationID string) Upload

+ func (us *Uploads) Remove(correlationID string)

+ func (us *Uploads) Stop(timeout time.Duration)

+ type Xtime struct

+ Time *time.Time

+ func (t *Xtime) Set(s string) error

+ func (t *Xtime) UnmarshalJSON(b []byte) error

+ func (t Xtime) String() string

v0

v0.1.0-M4

Aug 10, 2023

v0.1.0-M3

Feb 27, 2023

v0.1.0-M2

Sep 9, 2022

v0.1.0-M1

Feb 11, 2022