observation

Documentation

Index

• func GetResourceLinks(ctx context.Context, coapConn ClientConn, href string) (schema.ResourceLinks, uint64, error)
• func IsDiscoveryResourceObservable(links schema.ResourceLinks) (bool, error)
• 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) GetTwinEnabled() bool
  • func (d *DeviceObserver) RemovePublishedResources(ctx context.Context, resourceHrefs []string)
  • func (d *DeviceObserver) ResourceHasBeenSynchronized(ctx context.Context, href string)
• type DeviceObserverConfig
• type GrpcGatewayClient
• type LoggerOpt
  • func WithLogger(logger log.Logger) LoggerOpt
  • func (o LoggerOpt) Apply(opts *DeviceObserverConfig)
• type Observation
• type ObservationType
• type ObservationTypeOpt
  • func WithObservationType(observationType ObservationType) ObservationTypeOpt
  • func (o ObservationTypeOpt) Apply(opts *DeviceObserverConfig)
• type OnGetResourceContent
• type OnObserveResource
• type Option
• type RequireBatchObserveEnabledOpt
  • func WithRequireBatchObserveEnabled(v bool) RequireBatchObserveEnabledOpt
  • func (o RequireBatchObserveEnabledOpt) Apply(opts *DeviceObserverConfig)
• type ResourceAggregateClient
• type ResourcesObserverCallbacks
  • func MakeResourcesObserverCallbacks(onObserveResource OnObserveResource, onGetResourceContent OnGetResourceContent, ...) ResourcesObserverCallbacks
• type TwinEnabledOpt
  • func WithTwinEnabled(twinEnabled bool) TwinEnabledOpt
  • func (o TwinEnabledOpt) Apply(opts *DeviceObserverConfig)
• type UpdateTwinSynchronization

Functions

func GetResourceLinks

func GetResourceLinks(ctx context.Context, coapConn ClientConn, href string) (schema.ResourceLinks, uint64, error)

Query resource links from the given resource with the interface oic.if.ll.

func IsDiscoveryResourceObservable

func IsDiscoveryResourceObservable(links schema.ResourceLinks) (bool, error)

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) (Observation, error)
	ReleaseMessage(m *pool.Message)
	RemoteAddr() net.Addr
}

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, raClient ResourceAggregateClient, 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 twin 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) GetTwinEnabled

func (d *DeviceObserver) GetTwinEnabled() bool

func (*DeviceObserver) RemovePublishedResources

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

Remove observation of published resources.

Function does nothing if device twin 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.

func (*DeviceObserver) ResourceHasBeenSynchronized

func (d *DeviceObserver) ResourceHasBeenSynchronized(ctx context.Context, href string)

type DeviceObserverConfig

type DeviceObserverConfig struct {
	Logger                     log.Logger
	ObservationType            ObservationType
	TwinEnabled                bool
	TwinEnabledSet             bool
	RequireBatchObserveEnabled bool
}

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 Observation

type Observation = interface {
	Cancel(context.Context) error
	Canceled() bool
}

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 RequireBatchObserveEnabledOpt

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

Force observationType

func WithRequireBatchObserveEnabled

func WithRequireBatchObserveEnabled(v bool) RequireBatchObserveEnabledOpt

func (RequireBatchObserveEnabledOpt) Apply

func (o RequireBatchObserveEnabledOpt) Apply(opts *DeviceObserverConfig)

type ResourceAggregateClient

type ResourceAggregateClient interface {
	UnpublishResourceLinks(ctx context.Context, in *commands.UnpublishResourceLinksRequest, opts ...grpc.CallOption) (*commands.UnpublishResourceLinksResponse, error)
}

type ResourcesObserverCallbacks

type ResourcesObserverCallbacks struct {
	OnObserveResource         OnObserveResource
	OnGetResourceContent      OnGetResourceContent
	UpdateTwinSynchronization UpdateTwinSynchronization
}

func MakeResourcesObserverCallbacks

func MakeResourcesObserverCallbacks(onObserveResource OnObserveResource, onGetResourceContent OnGetResourceContent, updateTwinSynchronization UpdateTwinSynchronization) ResourcesObserverCallbacks

type TwinEnabledOpt

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

Force twinEnabled value

func WithTwinEnabled

func WithTwinEnabled(twinEnabled bool) TwinEnabledOpt

func (TwinEnabledOpt) Apply

func (o TwinEnabledOpt) Apply(opts *DeviceObserverConfig)

type UpdateTwinSynchronization

type UpdateTwinSynchronization = func(ctx context.Context, deviceID string, status commands.TwinSynchronization_State, t time.Time) error