observation

Documentation

Index

• func IsResourceObservableWithInterface(ctx context.Context, coapConn ClientConn, ...) (bool, error)
• func NewObservedResource(href, resInterface string) *observedResource
• type ClientConn
• type DeviceObserver
  • func NewDeviceObserver(ctx context.Context, deviceID string, coapConn ClientConn, ...) (*DeviceObserver, error)
  • func (d *DeviceObserver) AddPublishedResources(ctx context.Context, resources []*commands.Resource) error
  • func (d *DeviceObserver) Clean(ctx context.Context)
  • func (d *DeviceObserver) GetDeviceID() string
  • func (d *DeviceObserver) GetObservationType() ObservationType
  • func (d *DeviceObserver) GetResources() ([]*commands.ResourceId, error)
  • func (d *DeviceObserver) GetShadowSynchronization() commands.ShadowSynchronization
  • func (d *DeviceObserver) RemovePublishedResources(ctx context.Context, resourceHrefs []string)
• type DeviceObserverConfig
• type GrpcGatewayClient
• type LoggerOpt
  • func WithLogger(logger log.Logger) LoggerOpt
  • func (o LoggerOpt) Apply(opts *DeviceObserverConfig)
• type ObservationType
• type ObservationTypeOpt
  • func WithObservationType(observationType ObservationType) ObservationTypeOpt
  • func (o ObservationTypeOpt) Apply(opts *DeviceObserverConfig)
• type OnGetResourceContent
• type OnObserveResource
• type Option
• type ResourcesObserverCallbacks
  • func MakeResourcesObserverCallbacks(OnObserveResource OnObserveResource, OnGetResourceContent OnGetResourceContent) ResourcesObserverCallbacks
• type ShadowSynchronizationOpt
  • func WithShadowSynchronization(shadowSynchronization commands.ShadowSynchronization) ShadowSynchronizationOpt
  • func (o ShadowSynchronizationOpt) Apply(opts *DeviceObserverConfig)

Functions

func IsResourceObservableWithInterface

func IsResourceObservableWithInterface(ctx context.Context, coapConn ClientConn, resourceHref, resourceType, observeInterface string) (bool, error)

Query /oic/res resource to determine whether resource with given href is observable and supports given interface.

func NewObservedResource

func NewObservedResource(href, resInterface string) *observedResource

Types

type ClientConn

type ClientConn interface {
	Get(ctx context.Context, path string, opts ...message.Option) (*pool.Message, error)
	Observe(ctx context.Context, path string, observeFunc func(req *pool.Message), opts ...message.Option) (*tcp.Observation, error)
	ReleaseMessage(m *pool.Message)
}

type DeviceObserver

type DeviceObserver struct {
	// contains filtered or unexported fields
}

DeviceObserver is a type that sets up resources observation for a single device.

func NewDeviceObserver

func NewDeviceObserver(ctx context.Context, deviceID string, coapConn ClientConn, rdClient GrpcGatewayClient, callbacks ResourcesObserverCallbacks, opts ...Option) (*DeviceObserver, error)

Create new deviceObserver with given settings

func (*DeviceObserver) AddPublishedResources

func (d *DeviceObserver) AddPublishedResources(ctx context.Context, resources []*commands.Resource) error

Add observation of published resources.

Function does nothing if device shadow is disabled or /oic/res observation type (ObservationType_PerDevice) is active. Only if observation per published resource (ObservationType_PerResource) is active does the function try to add the given resources to active observations.

func (*DeviceObserver) Clean

func (d *DeviceObserver) Clean(ctx context.Context)

Remove all observations.

func (*DeviceObserver) GetDeviceID

func (d *DeviceObserver) GetDeviceID() string

func (*DeviceObserver) GetObservationType

func (d *DeviceObserver) GetObservationType() ObservationType

func (*DeviceObserver) GetResources

func (d *DeviceObserver) GetResources() ([]*commands.ResourceId, error)

Get list of observed resources for device.

func (*DeviceObserver) GetShadowSynchronization

func (d *DeviceObserver) GetShadowSynchronization() commands.ShadowSynchronization

func (*DeviceObserver) RemovePublishedResources

func (d *DeviceObserver) RemovePublishedResources(ctx context.Context, resourceHrefs []string)

Remove observation of published resources.

Function does nothing if device shadow is disabled or /oic/res observation type (ObservationType_PerDevice) is active. Only if observation per published resource (ObservationType_PerResource) is active does the function try to cancel the observations of given resources.

type DeviceObserverConfig

type DeviceObserverConfig struct {
	// contains filtered or unexported fields
}

type GrpcGatewayClient

type GrpcGatewayClient interface {
	GetDevicesMetadata(ctx context.Context, in *pb.GetDevicesMetadataRequest, opts ...grpc.CallOption) (pb.GrpcGateway_GetDevicesMetadataClient, error)
	GetResourceLinks(ctx context.Context, in *pb.GetResourceLinksRequest, opts ...grpc.CallOption) (pb.GrpcGateway_GetResourceLinksClient, error)
}

type LoggerOpt

type LoggerOpt struct {
	// contains filtered or unexported fields
}

Set logger option

func WithLogger

func WithLogger(logger log.Logger) LoggerOpt

func (LoggerOpt) Apply

func (o LoggerOpt) Apply(opts *DeviceObserverConfig)

type ObservationType

type ObservationType int

const (
	ObservationType_Detect      ObservationType = 0 // default, detect if /oic/res is observable using GET method, if not fallback to per resource observations
	ObservationType_PerDevice   ObservationType = 1 // single /oic/res observation
	ObservationType_PerResource ObservationType = 2 // fallback, observation of every published resource
)

type ObservationTypeOpt

type ObservationTypeOpt struct {
	// contains filtered or unexported fields
}

Force observationType

func WithObservationType

func WithObservationType(observationType ObservationType) ObservationTypeOpt

func (ObservationTypeOpt) Apply

func (o ObservationTypeOpt) Apply(opts *DeviceObserverConfig)

type OnGetResourceContent

type OnGetResourceContent = func(ctx context.Context, deviceID, resourceHref string, notification *pool.Message) error

type OnObserveResource

type OnObserveResource = func(ctx context.Context, deviceID, resourceHref string, batch bool, notification *pool.Message) error

type Option

type Option interface {
	Apply(o *DeviceObserverConfig)
}

type ResourcesObserverCallbacks

type ResourcesObserverCallbacks struct {
	OnObserveResource    OnObserveResource
	OnGetResourceContent OnGetResourceContent
}

func MakeResourcesObserverCallbacks

func MakeResourcesObserverCallbacks(OnObserveResource OnObserveResource, OnGetResourceContent OnGetResourceContent) ResourcesObserverCallbacks

type ShadowSynchronizationOpt

type ShadowSynchronizationOpt struct {
	// contains filtered or unexported fields
}

Force shadowSynchronization value

func WithShadowSynchronization

func WithShadowSynchronization(shadowSynchronization commands.ShadowSynchronization) ShadowSynchronizationOpt

func (ShadowSynchronizationOpt) Apply

func (o ShadowSynchronizationOpt) Apply(opts *DeviceObserverConfig)