core

package

Go to main page

Versions in this module

v1

v1.3.4

Oct 14, 2022

Changes in this version

type Device

+ func (d *Device) SetDeviceID(deviceID string)

+ func (d *Device) SetEndpoints(getEndpoints func() schema.Endpoints)

v1.3.3

Oct 13, 2022

v1.3.2

Oct 12, 2022

v1.3.1

Oct 11, 2022

v1.3.0

Oct 6, 2022

Changes in this version

type Device

+ func (d *Device) FoundByIP() string

+ func (d *Device) IsConnected() bool

+ func (d *Device) UpdateBy(v *Device)

+ type DeviceConfiguration struct

+ DialDTLS DialDTLS

+ DialTCP DialTCP

+ DialTLS DialTLS

+ DialUDP DialUDP

+ ErrFunc ErrFunc

+ GetOwnerID func() (string, error)

+ TLSConfig *TLSConfig

v1.2.1

Apr 20, 2022

v1.2.0

Apr 13, 2022

Changes in this version

+ type ActionAfterOwnFunc = func(ctx context.Context, client *coap.ClientCloseHandler) error

type OwnOption

+ func WithActionAfterOwn(actionAfterOwn ActionAfterOwnFunc) OwnOption

+ func WithPresharedKey(psk []byte) OwnOption

+ func WithSetupCertificates(sign otm.SignFunc) OwnOption

v1.1.0

Jan 26, 2022

Changes in this version

type DiscoveryConfiguration

+ MulticastOptions []net.MulticastOption

v1.0.0

Dec 16, 2021

Changes in this version

+ const ANY_DEVICE

+ const DiscoverAllDevices

+ const DiscoverDisownedDevices

+ const DiscoverOwnedDevices

+ var DiscoveryAddressUDP4 = []string

+ var DiscoveryAddressUDP6 = []string

+ func Discover(ctx context.Context, conn []*DiscoveryClient, href string, ...) error

+ func DiscoverDeviceOwnership(ctx context.Context, conn []*DiscoveryClient, status DiscoverOwnershipStatus, ...) error

+ func DiscoverDevices(ctx context.Context, conn []*DiscoveryClient, handler DiscoverDevicesHandler, ...) error

+ func GetResourceLink(links schema.ResourceLinks, href string) (schema.ResourceLink, error)

+ func MakeAborted(e error) error

+ func MakeAlreadyExists(e error) error

+ func MakeCanceled(e error) error

+ func MakeDataLoss(e error) error

+ func MakeDeadlineExceeded(e error) error

+ func MakeFailedPrecondition(e error) error

+ func MakeInternal(e error) error

+ func MakeInternalStr(str string, e error) error

+ func MakeInvalidArgument(e error) error

+ func MakeNotFound(e error) error

+ func MakeOutOfRange(e error) error

+ func MakePermissionDenied(e error) error

+ func MakeResourceExhausted(e error) error

+ func MakeSdkError(code codes.Code, err error) error

+ func MakeUnauthenticated(e error) error

+ func MakeUnavailable(e error) error

+ func MakeUnimplemented(e error) error

+ func MakeUnknown(e error) error

+ type ActionDuringOwnFunc = func(ctx context.Context, client *kitNetCoap.ClientCloseHandler) (string, error)

+ type CertificateSigner = interface

+ Sign func(ctx context.Context, csr []byte) ([]byte, error)

+ type Client struct

+ func NewClient(opts ...OptionFunc) *Client

+ func (c *Client) GetDeviceByIP(ctx context.Context, ip string) (*Device, error)

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

+ func (c *Client) GetDevices(ctx context.Context, handler DeviceHandler) error

+ func (c *Client) GetDevicesV2(ctx context.Context, discoveryConfiguration DiscoveryConfiguration, ...) error

+ func (c *Client) GetOwnerships(ctx context.Context, discoveryConfiguration DiscoveryConfiguration, ...) error

+ func (c *Client) GetSdkOwnerID() (string, error)

+ type Device struct

+ func NewDevice(cfg deviceConfiguration, deviceID string, deviceTypes []string, ...) *Device

+ func (d *Device) Close(ctx context.Context) error

+ func (d *Device) DeleteResource(ctx context.Context, link schema.ResourceLink, response interface{}, ...) error

+ func (d *Device) DeleteResourceWithCodec(ctx context.Context, link schema.ResourceLink, codec kitNetCoap.Codec, ...) error

+ func (d *Device) DeviceID() string

+ func (d *Device) DeviceTypes() []string

+ func (d *Device) Disown(ctx context.Context, links schema.ResourceLinks) error

+ func (d *Device) FactoryReset(ctx context.Context, links schema.ResourceLinks) error

+ func (d *Device) GetEndpoints() schema.Endpoints

+ func (d *Device) GetOwnership(ctx context.Context, links schema.ResourceLinks) (doxm.Doxm, error)

+ func (d *Device) GetResource(ctx context.Context, link schema.ResourceLink, response interface{}, ...) error

+ func (d *Device) GetResourceLinks(ctx context.Context, endpoints []schema.Endpoint, options ...coap.OptionFunc) (schema.ResourceLinks, error)

+ func (d *Device) GetResourceWithCodec(ctx context.Context, link schema.ResourceLink, codec coap.Codec, ...) error

+ func (d *Device) GetResources(ctx context.Context, links schema.ResourceLinks) *ResourceIterator

+ func (d *Device) GetSdkOwnerID() (string, error)

+ func (d *Device) IsSecured() bool

+ func (d *Device) ObserveResource(ctx context.Context, link schema.ResourceLink, handler ObservationHandler, ...) (observationID string, _ error)

+ func (d *Device) ObserveResourceWithCodec(ctx context.Context, link schema.ResourceLink, codec kitNetCoap.Codec, ...) (observationID string, _ error)

+ func (d *Device) Own(ctx context.Context, links schema.ResourceLinks, otmClient otm.Client, ...) error

+ func (d *Device) Provision(ctx context.Context, links schema.ResourceLinks) (*ProvisioningClient, error)

+ func (d *Device) Reboot(ctx context.Context, links schema.ResourceLinks) error

+ func (d *Device) StopObservingResource(ctx context.Context, observationID string) error

+ func (d *Device) UpdateResource(ctx context.Context, link schema.ResourceLink, request interface{}, ...) error

+ func (d *Device) UpdateResourceWithCodec(ctx context.Context, link schema.ResourceLink, codec kitNetCoap.Codec, ...) error

+ type DeviceHandler interface

+ Error func(err error)

+ Handle func(ctx context.Context, device *Device, deviceLinks schema.ResourceLinks)

+ type DeviceHandlerV2 interface

+ Error func(err error)

+ Handle func(ctx context.Context, device *Device)

+ type DialDTLS = func(ctx context.Context, addr string, dtlsCfg *dtls.Config, ...) (*coap.ClientCloseHandler, error)

+ type DialTCP = func(ctx context.Context, addr string, opts ...coap.DialOptionFunc) (*coap.ClientCloseHandler, error)

+ type DialTLS = func(ctx context.Context, addr string, tlsCfg *tls.Config, ...) (*coap.ClientCloseHandler, error)

+ type DialUDP = func(ctx context.Context, addr string, opts ...coap.DialOptionFunc) (*coap.ClientCloseHandler, error)

+ type DiscoverDeviceCodec struct

+ func (c DiscoverDeviceCodec) ContentFormat() message.MediaType

+ func (c DiscoverDeviceCodec) Decode(msg *message.Message, v interface{}) error

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

+ type DiscoverDeviceOwnershipHandler interface

+ Error func(err error)

+ Handle func(ctx context.Context, client *client.ClientConn, device doxm.Doxm)

+ type DiscoverDevicesHandler interface

+ Error func(err error)

+ Handle func(ctx context.Context, client *client.ClientConn, device schema.ResourceLinks)

+ type DiscoverOwnershipStatus int

+ type DiscoveryClient struct

+ func DialDiscoveryAddresses(ctx context.Context, cfg DiscoveryConfiguration, errors func(error)) ([]*DiscoveryClient, error)

+ func (d *DiscoveryClient) Close() error

+ func (d *DiscoveryClient) PublishMsgWithContext(req *pool.Message, discoveryHandler DiscoveryHandler) error

+ type DiscoveryConfiguration struct

+ MulticastAddressUDP4 []string

+ MulticastAddressUDP6 []string

+ MulticastHopLimit int

+ func DefaultDiscoveryConfiguration() DiscoveryConfiguration

+ type DiscoveryHandler = func(conn *client.ClientConn, req *pool.Message)

+ type ErrFunc = func(err error)

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

+ type GetCertificateFunc func() (tls.Certificate, error)

+ type ObservationHandler interface

+ Error func(err error)

+ Handle func(ctx context.Context, body kitNetCoap.DecodeFunc)

+ OnClose func()

+ type OptionFunc func(config) config

+ func WithDialDTLS(dial DialDTLS) OptionFunc

+ func WithDialTCP(dial DialTCP) OptionFunc

+ func WithDialTLS(dial DialTLS) OptionFunc

+ func WithDialUDP(dial DialUDP) OptionFunc

+ func WithErr(errFunc ErrFunc) OptionFunc

+ func WithTLS(tlsConfig *TLSConfig) OptionFunc

+ type OwnOption = func(ownCfg) ownCfg

+ func WithActionDuringOwn(actionDuringOwn ActionDuringOwnFunc) OwnOption

+ type OwnershipHandler interface

+ Error func(err error)

+ Handle func(ctx context.Context, doxm doxm.Doxm)

+ type ProvisioningClient struct

+ func (c *ProvisioningClient) AddCertificateAuthority(ctx context.Context, subject string, cert *x509.Certificate) error

+ func (c *ProvisioningClient) AddCredentials(ctx context.Context, cr credential.CredentialUpdateRequest) error

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

+ func (c *ProvisioningClient) SetAccessControl(ctx context.Context, permission acl.Permission, subject acl.Subject, ...) error

+ func (c *ProvisioningClient) SetCloudResource(ctx context.Context, r cloud.ConfigurationUpdateRequest) error

+ type ResourceIterator struct

+ Err error

+ func (it *ResourceIterator) Next(ctx context.Context, v interface{}) bool

+ type SdkError struct

+ func (e SdkError) Error() string

+ func (e SdkError) GetCode() codes.Code

+ func (e SdkError) Unwrap() error

+ type TLSConfig struct

+ GetCertificate GetCertificateFunc

+ GetCertificateAuthorities GetCertificateAuthoritiesFunc

Other modules containing this package

github.com/plgd-dev/device/v2

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL