Documentation
¶
Index ¶
- type KeyPair
- type Shadow
- type ShadowError
- type Thing
- func (t *Thing) DeleteThingShadow() error
- func (t *Thing) Disconnect()
- func (t *Thing) GetThingShadow() (Shadow, error)
- func (t *Thing) PublishToCustomTopic(payload Shadow, topic string) error
- func (t *Thing) SubscribeForCustomTopic(topic string) (chan Shadow, error)
- func (t *Thing) SubscribeForThingShadowChanges() (chan Shadow, chan ShadowError, error)
- func (t Thing) UnsubscribeFromCustomTopic(topic string) error
- func (t *Thing) UpdateThingShadow(payload Shadow) error
- func (t *Thing) UpdateThingShadowDocument(payload Shadow) error
- type ThingName
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ShadowError ¶
type ShadowError = Shadow
ShadowError represents the model for handling the errors occurred during updating the device shadow
type Thing ¶
type Thing struct {
// contains filtered or unexported fields
}
Thing a structure for working with the AWS IoT device shadows
func (*Thing) DeleteThingShadow ¶
DeleteThingShadow publishes a message to remove the device's shadow and waits for the result. In case shadow delete was rejected the method will return error
func (*Thing) Disconnect ¶
func (t *Thing) Disconnect()
Disconnect terminates the MQTT connection between the client and the AWS server. Recommended to use in defer to avoid connection leaks.
func (*Thing) GetThingShadow ¶
GetThingShadow returns the current thing shadow
func (*Thing) PublishToCustomTopic ¶
PublishToCustomTopic publishes an async message to the custom topic. The specified topic argument will be prepended by a prefix "$aws/things/<thing_name>"
func (*Thing) SubscribeForCustomTopic ¶
SubscribeForCustomTopic subscribes for the custom topic and returns the channel with the topic messages. The specified topic argument will be prepended by a prefix "$aws/things/<thing_name>"
func (*Thing) SubscribeForThingShadowChanges ¶
func (t *Thing) SubscribeForThingShadowChanges() (chan Shadow, chan ShadowError, error)
SubscribeForThingShadowChanges subscribes for the device shadow update topic and returns two channels: shadow and shadow error. The shadow channel will handle all accepted device shadow updates. The shadow error channel will handle all rejected device shadow updates
func (Thing) UnsubscribeFromCustomTopic ¶
UnsubscribeFromCustomTopic terminates the subscription to the custom topic. The specified topic argument will be prepended by a prefix "$aws/things/<thing_name>"
func (*Thing) UpdateThingShadow ¶
UpdateThingShadow publishes an async message with new thing shadow
func (*Thing) UpdateThingShadowDocument ¶
UpdateThingShadowDocument publishes an async message with new thing shadow document
Source Files