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.1.2

Dec 9, 2020

v1.1.1

Dec 4, 2020

v1.1.0

Dec 3, 2020

Changes in this version

type Client

+ func (c *Client) DeleteResource(ctx context.Context, deviceID string, href string, response interface{}, ...) error

+ type DeleteOption = interface

+ type GeneralMessageCodec struct

+ func (GeneralMessageCodec) ContentFormat() message.MediaType

+ func (GeneralMessageCodec) Decode(m *message.Message, v interface{}) error

+ func (GeneralMessageCodec) Encode(v interface{}) ([]byte, error)

+ type ResourceDeletePendingHandler = interface

+ HandleResourceDeletePending func(ctx context.Context, val *pb.Event_ResourceDeletePending) error

+ type ResourceDeletedHandler = interface

+ HandleResourceDeleted func(ctx context.Context, val *pb.Event_ResourceDeleted) error

v1.0.3

Nov 27, 2020

v1.0.2

Nov 26, 2020

v1.0.1

Oct 1, 2020

v1.0.0

Sep 29, 2020

Changes in this version

+ func ContentTypeToMediaType(contentType string) (message.MediaType, error)

+ func DecodeContentWithCodec(codec coap.Codec, contentType string, data []byte, response interface{}) error

+ type ApplicationCallback interface

+ GetRootCertificateAuthorities func() ([]*x509.Certificate, error)

+ type Client struct

+ func NewClient(accessTokenURL string, client pb.GrpcGatewayClient) (*Client, error)

+ func NewClientFromConfig(cfg *Config, tlsCfg *tls.Config) (*Client, error)

+ func (c *Client) Close(ctx context.Context) error

+ func (c *Client) FactoryReset(ctx context.Context, deviceID string) error

+ func (c *Client) GetAccessTokenURL(ctx context.Context) (string, error)

+ func (c *Client) GetDevice(ctx context.Context, deviceID string) (DeviceDetails, error)

+ func (c *Client) GetDevices(ctx context.Context, opts ...GetDevicesOption) (map[string]DeviceDetails, error)

+ func (c *Client) GetDevicesIterator(ctx context.Context, deviceIDs []string, resourceTypes ...string) *kitNetGrpc.Iterator

+ func (c *Client) GetDevicesViaCallback(ctx context.Context, deviceIDs, resourceTypes []string, ...) error

+ func (c *Client) GetResource(ctx context.Context, deviceID string, href string, response interface{}, ...) error

+ func (c *Client) GetResourceLinksIterator(ctx context.Context, deviceIDs []string, resourceTypes ...string) *kitNetGrpc.Iterator

+ func (c *Client) GetResourceLinksViaCallback(ctx context.Context, deviceIDs, resourceTypes []string, ...) error

+ func (c *Client) GrpcGatewayClient() pb.GrpcGatewayClient

+ func (c *Client) NewDeviceSubscription(ctx context.Context, deviceID string, handle SubscriptionHandler) (*DeviceSubscription, error)

+ func (c *Client) NewDevicesSubscription(ctx context.Context, handle SubscriptionHandler) (*DevicesSubscription, error)

+ func (c *Client) NewResourceSubscription(ctx context.Context, resourceID pb.ResourceId, handle SubscriptionHandler) (*ResourceSubscription, error)

+ func (c *Client) ObserveDeviceResources(ctx context.Context, deviceID string, ...) (string, error)

+ func (c *Client) ObserveDevices(ctx context.Context, handler DevicesObservationHandler) (string, error)

+ func (c *Client) ObserveResource(ctx context.Context, deviceID string, href string, ...) (observationID string, _ error)

+ func (c *Client) Reboot(ctx context.Context, deviceID string) error

+ func (c *Client) RetrieveResourcesByResourceIDs(ctx context.Context, resourceIDsCallbacks ...ResourceIDCallback) error

+ func (c *Client) RetrieveResourcesByType(ctx context.Context, deviceIDs []string, typeCallbacks ...TypeCallback) error

+ func (c *Client) RetrieveResourcesIterator(ctx context.Context, resourceIDs []*pb.ResourceId, deviceIDs []string, ...) *kitNetGrpc.Iterator

+ func (c *Client) StopObservingDeviceResources(ctx context.Context, observationID string) error

+ func (c *Client) StopObservingDevices(ctx context.Context, observationID string) error

+ func (c *Client) StopObservingResource(ctx context.Context, observationID string) error

+ func (c *Client) UpdateResource(ctx context.Context, deviceID string, href string, request interface{}, ...) error

+ type CloseErrorHandler struct

+ func NewCloseErrorHandler(onClose func(), onError func(err error)) *CloseErrorHandler

+ func (s *CloseErrorHandler) Error(err error)

+ func (s *CloseErrorHandler) OnClose()

+ type CodecOption struct

+ func WithCodec(codec kitNetCoap.Codec) CodecOption

+ type Config struct

+ AccessTokenURL string

+ GatewayAddress string

+ type DeviceDetails struct

+ Device pb.Device

+ ID string

+ Resources []*pb.ResourceLink

+ type DeviceIDsOption struct

+ func WithDeviceIDs(deviceIDs ...string) DeviceIDsOption

+ type DeviceOfflineHandler = interface

+ HandleDeviceOffline func(ctx context.Context, val *pb.Event_DeviceOffline) error

+ type DeviceOnlineHandler = interface

+ HandleDeviceOnline func(ctx context.Context, val *pb.Event_DeviceOnline) error

+ type DeviceRegisteredHandler = interface

+ HandleDeviceRegistered func(ctx context.Context, val *pb.Event_DeviceRegistered) error

+ type DeviceResourcesObservationEvent struct

+ Event DeviceResourcesObservationEvent_type

+ Links []*pb.ResourceLink

+ type DeviceResourcesObservationEvent_type uint8

+ const DeviceResourcesObservationEvent_ADDED

+ const DeviceResourcesObservationEvent_REMOVED

+ type DeviceResourcesObservationHandler = interface

+ Error func(err error)

+ Handle func(ctx context.Context, event DeviceResourcesObservationEvent) error

+ OnClose func()

+ type DeviceSubscription struct

+ func NewDeviceSubscription(ctx context.Context, deviceID string, closeErrorHandler SubscriptionHandler, ...) (*DeviceSubscription, error)

+ func ToDeviceSubscription(v interface{}, ok bool) (*DeviceSubscription, bool)

+ func (s *DeviceSubscription) Cancel() (wait func(), err error)

+ func (s *DeviceSubscription) ID() string

+ type DeviceUnregisteredHandler = interface

+ HandleDeviceUnregistered func(ctx context.Context, val *pb.Event_DeviceUnregistered) error

+ type DevicesObservationEvent struct

+ DeviceIDs []string

+ Event DevicesObservationEvent_type

+ type DevicesObservationEvent_type uint8

+ const DevicesObservationEvent_OFFLINE

+ const DevicesObservationEvent_ONLINE

+ const DevicesObservationEvent_REGISTERED

+ const DevicesObservationEvent_UNREGISTERED

+ type DevicesObservationHandler = interface

+ Error func(err error)

+ Handle func(ctx context.Context, event DevicesObservationEvent) error

+ OnClose func()

+ type DevicesSubscription struct

+ func NewDevicesSubscription(ctx context.Context, closeErrorHandler SubscriptionHandler, handle interface{}, ...) (*DevicesSubscription, error)

+ func (s *DevicesSubscription) Cancel() (wait func(), err error)

+ func (s *DevicesSubscription) ID() string

+ type GetDevicesOption = interface

+ type GetOption = interface

+ type ObserveOption = interface

+ type OnboardOption = func() interface

+ type ResourceContentChangedHandler = interface

+ HandleResourceContentChanged func(ctx context.Context, val *pb.Event_ResourceChanged) error

+ type ResourceIDCallback struct

+ Callback func(pb.ResourceValue)

+ ResourceID *pb.ResourceId

+ func MakeResourceIDCallback(deviceID, href string, callback func(pb.ResourceValue)) ResourceIDCallback

+ type ResourceInterfaceOption struct

+ func WithInterface(resourceInterface string) ResourceInterfaceOption

+ type ResourcePublishedHandler = interface

+ HandleResourcePublished func(ctx context.Context, val *pb.Event_ResourcePublished) error

+ type ResourceRetrievePendingHandler = interface

+ HandleResourceRetrievePending func(ctx context.Context, val *pb.Event_ResourceRetrievePending) error

+ type ResourceRetrievedHandler = interface

+ HandleResourceRetrieved func(ctx context.Context, val *pb.Event_ResourceRetrieved) error

+ type ResourceSubscription struct

+ func NewResourceSubscription(ctx context.Context, resourceID pb.ResourceId, ...) (*ResourceSubscription, error)

+ func ToResourceSubscription(v interface{}, ok bool) (*ResourceSubscription, bool)

+ func (s *ResourceSubscription) Cancel() (wait func(), err error)

+ func (s *ResourceSubscription) ID() string

+ type ResourceTypesOption struct

+ func WithResourceTypes(resourceTypes ...string) ResourceTypesOption

+ type ResourceUnpublishedHandler = interface

+ HandleResourceUnpublished func(ctx context.Context, val *pb.Event_ResourceUnpublished) error

+ type ResourceUpdatePendingHandler = interface

+ HandleResourceUpdatePending func(ctx context.Context, val *pb.Event_ResourceUpdatePending) error

+ type ResourceUpdatedHandler = interface

+ HandleResourceUpdated func(ctx context.Context, val *pb.Event_ResourceUpdated) error

+ type SkipShadowOption struct

+ func WithSkipShadow() SkipShadowOption

+ type SubscriptionHandler = interface

+ Error func(err error)

+ OnClose func()

+ type TypeCallback struct

+ Callback func(pb.ResourceValue)

+ Type string

+ func MakeTypeCallback(resourceType string, callback func(pb.ResourceValue)) TypeCallback

+ type UpdateOption = interface

v1.0.0-rc.12

Sep 29, 2020

v1.0.0-rc.11

Sep 28, 2020

v1.0.0-rc.10

Sep 24, 2020

v1.0.0-rc.9

Sep 24, 2020

v1.0.0-rc.8

Sep 23, 2020

v1.0.0-rc.7

Sep 22, 2020

v1.0.0-rc.6

Sep 21, 2020

v1.0.0-rc.5

Sep 21, 2020

v1.0.0-rc.4

Sep 18, 2020

v1.0.0-rc.3

Sep 15, 2020

v1.0.0-rc.2

Sep 11, 2020

v1.0.0-rc.1

Sep 9, 2020