-
Notifications
You must be signed in to change notification settings - Fork 14
/
datachange_monitored_item.go
602 lines (567 loc) · 17 KB
/
datachange_monitored_item.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
// Copyright 2021 Converter Systems LLC. All rights reserved.
package server
import (
"context"
"math"
"reflect"
"sync/atomic"
"time"
"sync"
"github.com/awcullen/opcua/ua"
deque "github.com/gammazero/deque"
)
// DataChangeMonitoredItem specifies the node and attribute that is monitored for data changes.
type DataChangeMonitoredItem struct {
sync.RWMutex
id uint32
itemToMonitor ua.ReadValueID
monitoringMode ua.MonitoringMode
clientHandle uint32
samplingInterval float64
queueSize uint32
discardOldest bool
timestampsToReturn ua.TimestampsToReturn
minSamplingInterval float64
queue deque.Deque[ua.DataValue]
node Node
dataChangeFilter ua.DataChangeFilter
previousQueuedValue ua.DataValue
sub *Subscription
srv *Server
prequeue deque.Deque[ua.DataValue]
ts time.Time
ti time.Duration
cachedCtx context.Context
triggeredItems []MonitoredItem
triggered bool
}
// NewDataChangeMonitoredItem constructs a new DataChangeMonitoredItem.
func NewDataChangeMonitoredItem(ctx context.Context, sub *Subscription, node Node, itemToMonitor ua.ReadValueID, monitoringMode ua.MonitoringMode, parameters ua.MonitoringParameters, timestampsToReturn ua.TimestampsToReturn, minSamplingInterval float64) *DataChangeMonitoredItem {
mi := &DataChangeMonitoredItem{
sub: sub,
srv: sub.manager.server,
node: node,
id: atomic.AddUint32(&monitoredItemID, 1),
itemToMonitor: itemToMonitor,
monitoringMode: monitoringMode,
clientHandle: parameters.ClientHandle,
discardOldest: parameters.DiscardOldest,
timestampsToReturn: timestampsToReturn,
minSamplingInterval: minSamplingInterval,
queue: deque.Deque[ua.DataValue]{},
prequeue: deque.Deque[ua.DataValue]{},
previousQueuedValue: ua.NewDataValue(nil, ua.BadWaitingForInitialData, time.Time{}, 0, time.Time{}, 0),
}
mi.setQueueSize(parameters.QueueSize)
mi.setSamplingInterval(parameters.SamplingInterval)
mi.setFilter(parameters.Filter)
mi.Lock()
mi.startMonitoring(ctx)
mi.Unlock()
return mi
}
// ID returns the identifier of the MonitoredItem.
func (mi *DataChangeMonitoredItem) ID() uint32 {
return mi.id
}
// Node returns the Node of the MonitoredItem.
func (mi *DataChangeMonitoredItem) Node() Node {
return mi.node
}
// ItemToMonitor returns the ReadValueID of the MonitoredItem.
func (mi *DataChangeMonitoredItem) ItemToMonitor() ua.ReadValueID {
return mi.itemToMonitor
}
// SamplingInterval returns the sampling interval in ms of the MonitoredItem.
func (mi *DataChangeMonitoredItem) SamplingInterval() float64 {
mi.RLock()
defer mi.RUnlock()
return mi.samplingInterval
}
// QueueSize returns the queue size of the MonitoredItem.
func (mi *DataChangeMonitoredItem) QueueSize() uint32 {
mi.RLock()
defer mi.RUnlock()
return mi.queueSize
}
// MonitoringMode returns the monitoring mode of the MonitoredItem.
func (mi *DataChangeMonitoredItem) MonitoringMode() ua.MonitoringMode {
mi.RLock()
defer mi.RUnlock()
return mi.monitoringMode
}
// ClientHandle returns the client handle of the MonitoredItem.
func (mi *DataChangeMonitoredItem) ClientHandle() uint32 {
mi.RLock()
defer mi.RUnlock()
return mi.clientHandle
}
// Triggered returns true when the MonitoredItem is triggered.
func (mi *DataChangeMonitoredItem) Triggered() bool {
mi.RLock()
defer mi.RUnlock()
return mi.triggered
}
// SetTriggered sets when the MonitoredItem is triggered.
func (mi *DataChangeMonitoredItem) SetTriggered(val bool) {
mi.Lock()
defer mi.Unlock()
mi.triggered = val
}
// Modify modifies the MonitoredItem.
func (mi *DataChangeMonitoredItem) Modify(ctx context.Context, req ua.MonitoredItemModifyRequest) ua.MonitoredItemModifyResult {
mi.Lock()
defer mi.Unlock()
mi.stopMonitoring()
mi.clientHandle = req.RequestedParameters.ClientHandle
mi.discardOldest = req.RequestedParameters.DiscardOldest
mi.setQueueSize(req.RequestedParameters.QueueSize)
mi.setSamplingInterval(req.RequestedParameters.SamplingInterval)
mi.setFilter(req.RequestedParameters.Filter)
mi.startMonitoring(ctx)
return ua.MonitoredItemModifyResult{RevisedSamplingInterval: mi.samplingInterval, RevisedQueueSize: mi.queueSize}
}
// Delete deletes the DataMonitoredItem.
func (mi *DataChangeMonitoredItem) Delete() {
mi.Lock()
defer mi.Unlock()
mi.stopMonitoring()
mi.queue.Clear()
mi.node = nil
mi.previousQueuedValue = ua.NewDataValue(nil, ua.BadWaitingForInitialData, time.Time{}, 0, time.Time{}, 0)
mi.sub = nil
mi.prequeue.Clear()
mi.triggeredItems = nil
}
// SetMonitoringMode sets the MonitoringMode of the MonitoredItem.
func (mi *DataChangeMonitoredItem) SetMonitoringMode(ctx context.Context, mode ua.MonitoringMode) {
mi.Lock()
defer mi.Unlock()
if mi.monitoringMode == mode {
return
}
mi.stopMonitoring()
mi.monitoringMode = mode
if mode == ua.MonitoringModeDisabled {
mi.queue.Clear()
mi.previousQueuedValue = ua.NewDataValue(nil, ua.BadWaitingForInitialData, time.Time{}, 0, time.Time{}, 0)
mi.sub.disabledMonitoredItemCount++
} else {
mi.sub.disabledMonitoredItemCount--
}
mi.startMonitoring(ctx)
}
func (mi *DataChangeMonitoredItem) setQueueSize(queueSize uint32) {
if queueSize > maxQueueSize {
queueSize = maxQueueSize
}
if queueSize < 1 {
queueSize = 1
}
mi.queueSize = queueSize
// trim to size
overflow := false
if mi.discardOldest {
for mi.queue.Len() > int(mi.queueSize) {
mi.queue.PopFront()
overflow = true
}
if overflow && mi.queue.Len() > 1 {
// set overflow bit of statuscode
v := mi.queue.Front()
v.StatusCode = ua.StatusCode(uint32(v.StatusCode) | ua.InfoTypeDataValue | ua.Overflow)
}
} else {
for mi.queue.Len() > int(mi.queueSize) {
mi.queue.PopBack()
overflow = true
}
if overflow && mi.queue.Len() > 1 {
// set overflow bit of statuscode
v := mi.queue.Back()
v.StatusCode = ua.StatusCode(uint32(v.StatusCode) | ua.InfoTypeDataValue | ua.Overflow)
}
}
}
func (mi *DataChangeMonitoredItem) setSamplingInterval(samplingInterval float64) {
switch mi.itemToMonitor.AttributeID {
case ua.AttributeIDValue:
if samplingInterval < 0 {
samplingInterval = mi.sub.publishingInterval
}
if samplingInterval < mi.minSamplingInterval {
samplingInterval = mi.minSamplingInterval
}
if samplingInterval > maxSamplingInterval {
samplingInterval = maxSamplingInterval
}
if v, ok := mi.node.(*VariableNode); ok {
if min := v.MinimumSamplingInterval(); samplingInterval < min {
samplingInterval = min
}
}
default:
if samplingInterval < 0 {
samplingInterval = mi.sub.publishingInterval
}
if samplingInterval < mi.minSamplingInterval {
samplingInterval = mi.minSamplingInterval
}
if samplingInterval > maxSamplingInterval {
samplingInterval = maxSamplingInterval
}
}
mi.samplingInterval = samplingInterval
mi.ti = time.Duration(mi.samplingInterval) * time.Millisecond
}
func (mi *DataChangeMonitoredItem) setFilter(filter any) {
if dcf, ok := filter.(ua.DataChangeFilter); ok {
mi.dataChangeFilter = dcf
} else {
mi.dataChangeFilter = ua.DataChangeFilter{Trigger: ua.DataChangeTriggerStatusValue}
}
}
func (mi *DataChangeMonitoredItem) startMonitoring(ctx context.Context) {
mi.cachedCtx = ctx
mi.ts = time.Now()
if mi.monitoringMode == ua.MonitoringModeDisabled {
return
}
v := mi.srv.readValue(ctx, mi.itemToMonitor)
mi.prequeue.PushBack(v)
mi.Unlock()
mi.srv.Scheduler().GetPollGroup(time.Duration(mi.samplingInterval) * time.Millisecond).Subscribe(mi)
mi.Lock()
}
func (mi *DataChangeMonitoredItem) stopMonitoring() {
mi.Unlock()
mi.srv.Scheduler().GetPollGroup(time.Duration(mi.samplingInterval) * time.Millisecond).Unsubscribe(mi)
mi.Lock()
mi.cachedCtx = nil
}
// Poll reads the value of the itemToMonitor.
func (mi *DataChangeMonitoredItem) Poll() {
mi.Lock()
if n := mi.node; n != nil {
v := mi.srv.readValue(mi.cachedCtx, mi.itemToMonitor)
mi.prequeue.PushBack(v)
}
mi.Unlock()
}
// AddTriggeredItem adds a item to be triggered by this item.
func (mi *DataChangeMonitoredItem) AddTriggeredItem(item MonitoredItem) bool {
mi.Lock()
mi.triggeredItems = append(mi.triggeredItems, item)
mi.Unlock()
return true
}
// RemoveTriggeredItem removes an item to be triggered by this item.
func (mi *DataChangeMonitoredItem) RemoveTriggeredItem(item MonitoredItem) bool {
mi.Lock()
ret := false
for i, e := range mi.triggeredItems {
if e.ID() == item.ID() {
mi.triggeredItems[i] = mi.triggeredItems[len(mi.triggeredItems)-1]
mi.triggeredItems[len(mi.triggeredItems)-1] = nil
mi.triggeredItems = mi.triggeredItems[:len(mi.triggeredItems)-1]
ret = true
break
}
}
mi.Unlock()
return ret
}
func (mi *DataChangeMonitoredItem) enqueue(item ua.DataValue) {
overflow := false
if mi.discardOldest {
for mi.queue.Len() >= int(mi.queueSize) {
mi.queue.PopFront() // discard oldest
overflow = true
}
mi.queue.PushBack(item)
if overflow && mi.queueSize > 1 {
// set overflow bit of statuscode
v := mi.queue.Front()
v.StatusCode = ua.StatusCode(uint32(v.StatusCode) | ua.InfoTypeDataValue | ua.Overflow)
mi.sub.monitoringQueueOverflowCount++
}
} else {
for mi.queue.Len() >= int(mi.queueSize) {
mi.queue.PopBack() // discard newest
overflow = true
}
mi.queue.PushBack(item)
if overflow && mi.queueSize > 1 {
// set overflow bit of statuscode
v := mi.queue.Back()
v.StatusCode = ua.StatusCode(uint32(v.StatusCode) | ua.InfoTypeDataValue | ua.Overflow)
mi.sub.monitoringQueueOverflowCount++
}
}
if mi.triggeredItems != nil {
for _, item := range mi.triggeredItems {
item.SetTriggered(true)
// log.Printf("Item %d triggered %d", mi.id, item.id)
}
}
}
func (mi *DataChangeMonitoredItem) notifications(max int) (notifications []any, more bool) {
mi.Lock()
defer mi.Unlock()
notifications = make([]any, 0, 4)
for i := 0; i < max; i++ {
if mi.queue.Len() > 0 {
notifications = append(notifications, mi.queue.PopFront())
} else {
break
}
}
more = mi.queue.Len() > 0
if mi.triggered && !more {
mi.triggered = false
// log.Printf("Reset triggered %d", mi.id)
}
return notifications, more
}
func (mi *DataChangeMonitoredItem) notificationsAvailable(tn time.Time, late bool, resend bool) bool {
_ = late
mi.Lock()
defer mi.Unlock()
// if disabled, then report false.
if mi.monitoringMode == ua.MonitoringModeDisabled {
mi.ts = tn
return false
}
// update queue and report if queue has notifications available.
// if in sampling interval mode, queue the last value of each sampling interval
if mi.ti > 0 {
// log.Printf("Sample from %s to %s", mi.ts.Add(-mi.ti).Format(time.StampMilli), tn.Format(time.StampMilli))
v := mi.previousQueuedValue
// for each interval
for ; !mi.ts.After(tn); mi.ts = mi.ts.Add(mi.ti) {
// for each value in prequeue
for mi.prequeue.Len() > 0 {
// peek
peek := mi.prequeue.Front()
// if timestamp is within sampling interval
if !peek.ServerTimestamp.After(mi.ts) {
v = peek
mi.prequeue.PopFront()
// log.Printf("Peek at %s take %s", mi.ts.Format(time.StampMilli), peek.ServerTimestamp.Format(time.StampMilli))
} else {
// log.Printf("Peek at %s leave %s", mi.ts.Format(time.StampMilli), peek.ServerTimestamp.Format(time.StampMilli))
break
}
}
// holding latest sample in v, enqueue it
// v.ServerTimestamp = mi.ts
// v.ServerPicoseconds = 0
if mi.isDataChange(v, mi.previousQueuedValue) {
mi.enqueue(withTimestamps(v, mi.timestampsToReturn))
mi.previousQueuedValue = v
}
}
} else {
// for each value in prequeue
for mi.prequeue.Len() > 0 {
v := mi.prequeue.PopFront()
if mi.isDataChange(v, mi.previousQueuedValue) {
mi.enqueue(withTimestamps(v, mi.timestampsToReturn))
mi.previousQueuedValue = v
}
}
}
if resend && mi.monitoringMode == ua.MonitoringModeReporting {
if mi.queue.Len() == 0 {
v := mi.srv.readValue(mi.cachedCtx, mi.itemToMonitor)
mi.enqueue(withTimestamps(v, mi.timestampsToReturn))
mi.previousQueuedValue = v
}
}
return mi.queue.Len() > 0 && (mi.monitoringMode == ua.MonitoringModeReporting || mi.triggered)
}
func (mi *DataChangeMonitoredItem) isDataChange(current, previous ua.DataValue) bool {
dcf := mi.dataChangeFilter
switch dcf.Trigger {
case ua.DataChangeTriggerStatus:
return (current.StatusCode&0xFFFFF000 != previous.StatusCode&0xFFFFF000)
case ua.DataChangeTriggerStatusValue:
if current.StatusCode&0xFFFFF000 != previous.StatusCode&0xFFFFF000 {
return true
}
switch ua.DeadbandType(dcf.DeadbandType) {
case ua.DeadbandTypeNone:
return !reflect.DeepEqual(current.Value, previous.Value)
case ua.DeadbandTypeAbsolute:
return !equalDeadbandAbsolute(current.Value, previous.Value, dcf.DeadbandValue)
case ua.DeadbandTypePercent:
return true
}
case ua.DataChangeTriggerStatusValueTimestamp:
if current.StatusCode&0xFFFFF000 != previous.StatusCode&0xFFFFF000 {
return true
}
if current.SourceTimestamp != previous.SourceTimestamp {
return true
}
switch ua.DeadbandType(dcf.DeadbandType) {
case ua.DeadbandTypeNone:
return !reflect.DeepEqual(current.Value, previous.Value)
case ua.DeadbandTypeAbsolute:
return !equalDeadbandAbsolute(current.Value, previous.Value, dcf.DeadbandValue)
case ua.DeadbandTypePercent:
return true
}
}
return true
}
func equalDeadbandAbsolute(current, previous ua.Variant, deadband float64) bool {
switch c := current.(type) {
case nil:
return previous == nil
case int8:
if p, ok := previous.(int8); ok {
return math.Abs(float64(c)-float64(p)) <= deadband
}
case uint8:
if p, ok := previous.(uint8); ok {
return math.Abs(float64(c)-float64(p)) <= deadband
}
case int16:
if p, ok := previous.(int16); ok {
return math.Abs(float64(c)-float64(p)) <= deadband
}
case uint16:
if p, ok := previous.(uint16); ok {
return math.Abs(float64(c)-float64(p)) <= deadband
}
case int32:
if p, ok := previous.(int32); ok {
return math.Abs(float64(c)-float64(p)) <= deadband
}
case uint32:
if p, ok := previous.(uint32); ok {
return math.Abs(float64(c)-float64(p)) <= deadband
}
case int64:
if p, ok := previous.(int64); ok {
return math.Abs(float64(c)-float64(p)) <= deadband
}
case uint64:
if p, ok := previous.(uint64); ok {
return math.Abs(float64(c)-float64(p)) <= deadband
}
case float32:
if p, ok := previous.(float32); ok {
return math.Abs(float64(c)-float64(p)) <= deadband
}
case float64:
if p, ok := previous.(float64); ok {
return math.Abs(float64(c)-float64(p)) <= deadband
}
case []int8:
if p, ok := previous.([]int8); ok {
for i := 0; i < len(c); i++ {
if math.Abs(float64(c[i])-float64(p[i])) > deadband {
return false
}
}
return true
}
case []uint8:
if p, ok := previous.([]uint8); ok {
for i := 0; i < len(c); i++ {
if math.Abs(float64(c[i])-float64(p[i])) > deadband {
return false
}
}
return true
}
case []int16:
if p, ok := previous.([]int16); ok {
for i := 0; i < len(c); i++ {
if math.Abs(float64(c[i])-float64(p[i])) > deadband {
return false
}
}
return true
}
case []uint16:
if p, ok := previous.([]uint16); ok {
for i := 0; i < len(c); i++ {
if math.Abs(float64(c[i])-float64(p[i])) > deadband {
return false
}
}
return true
}
case []int32:
if p, ok := previous.([]int32); ok {
for i := 0; i < len(c); i++ {
if math.Abs(float64(c[i])-float64(p[i])) > deadband {
return false
}
}
return true
}
case []uint32:
if p, ok := previous.([]uint32); ok {
for i := 0; i < len(c); i++ {
if math.Abs(float64(c[i])-float64(p[i])) > deadband {
return false
}
}
return true
}
case []int64:
if p, ok := previous.([]int64); ok {
for i := 0; i < len(c); i++ {
if math.Abs(float64(c[i])-float64(p[i])) > deadband {
return false
}
}
return true
}
case []uint64:
if p, ok := previous.([]uint64); ok {
for i := 0; i < len(c); i++ {
if math.Abs(float64(c[i])-float64(p[i])) > deadband {
return false
}
}
return true
}
case []float32:
if p, ok := previous.([]float32); ok {
for i := 0; i < len(c); i++ {
if math.Abs(float64(c[i])-float64(p[i])) > deadband {
return false
}
}
return true
}
case []float64:
if p, ok := previous.([]float64); ok {
for i := 0; i < len(c); i++ {
if math.Abs(float64(c[i])-float64(p[i])) > deadband {
return false
}
}
return true
}
}
return false
}
// withTimestamps returns a new instance of DataValue with only the selected timestamps.
func withTimestamps(value ua.DataValue, timestampsToReturn ua.TimestampsToReturn) ua.DataValue {
switch timestampsToReturn {
case ua.TimestampsToReturnSource:
return ua.NewDataValue(value.Value, value.StatusCode, value.SourceTimestamp, 0, time.Time{}, 0)
case ua.TimestampsToReturnServer:
return ua.NewDataValue(value.Value, value.StatusCode, time.Time{}, 0, value.ServerTimestamp, 0)
case ua.TimestampsToReturnNeither:
return ua.NewDataValue(value.Value, value.StatusCode, time.Time{}, 0, time.Time{}, 0)
default:
return value
}
}