iotdevice

May 2, 2023

Changes in this version

type Client

+ func (c *Client) CreateModule(ctx context.Context, m *iotservice.Module) (*iotservice.Module, error)

+ func (c *Client) DeleteModule(ctx context.Context, m *iotservice.Module) error

+ func (c *Client) GetModule(ctx context.Context, moduleID string) (*iotservice.Module, error)

+ func (c *Client) ListModules(ctx context.Context) ([]*iotservice.Module, error)

+ func (c *Client) UpdateModule(ctx context.Context, m *iotservice.Module) (*iotservice.Module, error)

type ModuleClient

+ func (c *ModuleClient) SubscribeTwinUpdates(ctx context.Context) (*TwinStateSub, error)

+ func (c *ModuleClient) UnsubscribeTwinUpdates(sub *TwinStateSub)

Dec 14, 2021

Changes in this version

type Client

+ func (c *Client) UploadFile(ctx context.Context, blobName string, file io.Reader, size int64) error

Oct 21, 2021

Changes in this version

type SendOption

+ func WithSendCreationTime(t time.Time) SendOption

+ func WithSendExpiryTime(t time.Time) SendOption

Nov 9, 2020

Changes in this version

+ type ModuleClient struct

+ func NewModule(transport transport.Transport, creds transport.Credentials, ...) (*ModuleClient, error)

+ func NewModuleFromConnectionString(transport transport.Transport, ...) (*ModuleClient, error)

+ func NewModuleFromEnvironment(transport transport.Transport, edge bool, opts ...ClientOption) (*ModuleClient, error)

+ func (c *ModuleClient) Broker() string

+ func (c *ModuleClient) Gateway() string

+ func (c *ModuleClient) GenerationID() string

+ func (c *ModuleClient) ModuleID() string

+ type ModuleSharedAccessKeyCredentials struct

+ EdgeGateway bool

+ Gateway string

+ GenerationID string

+ ModuleID string

+ WorkloadURI string

+ func ParseModuleConnectionString(cs string) (*ModuleSharedAccessKeyCredentials, error)

+ func ParseModuleEnvironmentVariables() (*ModuleSharedAccessKeyCredentials, error)

+ func (c *ModuleSharedAccessKeyCredentials) GetBroker() string

+ func (c *ModuleSharedAccessKeyCredentials) GetCertificate() *tls.Certificate

+ func (c *ModuleSharedAccessKeyCredentials) GetGateway() string

+ func (c *ModuleSharedAccessKeyCredentials) GetGenerationID() string

+ func (c *ModuleSharedAccessKeyCredentials) GetModuleID() string

+ func (c *ModuleSharedAccessKeyCredentials) GetSAK() string

+ func (c *ModuleSharedAccessKeyCredentials) GetWorkloadURI() string

+ func (c *ModuleSharedAccessKeyCredentials) UseEdgeGateway() bool

type SharedAccessKeyCredentials

+ func (c *SharedAccessKeyCredentials) GetBroker() string

+ func (c *SharedAccessKeyCredentials) GetGateway() string

+ func (c *SharedAccessKeyCredentials) GetGenerationID() string

+ func (c *SharedAccessKeyCredentials) GetModuleID() string

+ func (c *SharedAccessKeyCredentials) GetSAK() string

+ func (c *SharedAccessKeyCredentials) GetWorkloadURI() string

+ func (c *SharedAccessKeyCredentials) UseEdgeGateway() bool

type X509Credentials

+ func (c *X509Credentials) GetBroker() string

+ func (c *X509Credentials) GetGateway() string

+ func (c *X509Credentials) GetGenerationID() string

+ func (c *X509Credentials) GetModuleID() string

+ func (c *X509Credentials) GetSAK() string

+ func (c *X509Credentials) GetWorkloadURI() string

+ func (c *X509Credentials) TokenFromEdge(workloadURI, module, genid, resource string, lifetime time.Duration) (*common.SharedAccessSignature, error)

+ func (c *X509Credentials) UseEdgeGateway() bool

Oct 5, 2019

Changes in this version

type Client

+ func NewFromConnectionString(transport transport.Transport, cs string, opts ...ClientOption) (*Client, error)

+ func NewFromX509Cert(transport transport.Transport, deviceID, hostName string, crt *tls.Certificate, ...) (*Client, error)

+ func NewFromX509FromFile(transport transport.Transport, deviceID, hostname, certFile, keyFile string, ...) (*Client, error)

type SharedAccessKeyCredentials

+ func ParseConnectionString(cs string) (*SharedAccessKeyCredentials, error)

Jun 18, 2019

Changes in this version

+ type SharedAccessKeyCredentials struct

+ DeviceID string

+ func (c *SharedAccessKeyCredentials) GetCertificate() *tls.Certificate

+ func (c *SharedAccessKeyCredentials) GetDeviceID() string

+ func (c *SharedAccessKeyCredentials) GetHostName() string

+ type X509Credentials struct

+ Certificate *tls.Certificate

+ DeviceID string

+ HostName string

+ func (c *X509Credentials) GetCertificate() *tls.Certificate

+ func (c *X509Credentials) GetDeviceID() string

+ func (c *X509Credentials) GetHostName() string

+ func (c *X509Credentials) Token(resource string, lifetime time.Duration) (*common.SharedAccessSignature, error)

Apr 8, 2019

Changes in this version

+ var ErrClosed = errors.New("closed")

+ func NewSASCredentials(cs string) (transport.Credentials, error)

+ func NewX509Credentials(deviceID, hostname string, crt *tls.Certificate) (transport.Credentials, error)

+ type Client struct

+ func New(opts ...ClientOption) (*Client, error)

+ func (c *Client) Close() error

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

+ func (c *Client) DeviceID() string

+ func (c *Client) RegisterMethod(ctx context.Context, name string, fn DirectMethodHandler) error

+ func (c *Client) RetrieveTwinState(ctx context.Context) (desired TwinState, reported TwinState, err error)

+ func (c *Client) SendEvent(ctx context.Context, payload []byte, opts ...SendOption) error

+ func (c *Client) SubscribeEvents(ctx context.Context) (*EventSub, error)

+ func (c *Client) SubscribeTwinUpdates(ctx context.Context) (*TwinStateSub, error)

+ func (c *Client) UnregisterMethod(name string)

+ func (c *Client) UnsubscribeEvents(sub *EventSub)

+ func (c *Client) UnsubscribeTwinUpdates(sub *TwinStateSub)

+ func (c *Client) UpdateTwinState(ctx context.Context, s TwinState) (int, error)

+ type ClientOption func(c *Client) error

+ func WithConnectionString(cs string) ClientOption

+ func WithCredentials(creds transport.Credentials) ClientOption

+ func WithLogger(l common.Logger) ClientOption

+ func WithTransport(tr transport.Transport) ClientOption

+ func WithX509FromCert(deviceID, hostname string, crt *tls.Certificate) ClientOption

+ func WithX509FromFile(deviceID, hostname, certFile, keyFile string) ClientOption

+ type DirectMethodHandler func(p map[string]interface{}) (map[string]interface{}, error)

+ type EventSub struct

+ func (s *EventSub) C() <-chan *common.Message

+ func (s *EventSub) Err() error

+ type SendOption func(msg *common.Message) error

+ func WithSendCorrelationID(cid string) SendOption

+ func WithSendMessageID(mid string) SendOption

+ func WithSendProperties(m map[string]string) SendOption

+ func WithSendProperty(k, v string) SendOption

+ func WithSendQoS(qos int) SendOption

+ type TwinState map[string]interface

+ func (s TwinState) Version() int

+ type TwinStateSub struct

+ func (s *TwinStateSub) C() <-chan TwinState

+ func (s *TwinStateSub) Err() error