-
Notifications
You must be signed in to change notification settings - Fork 389
/
Subscriber.go
270 lines (246 loc) · 10.6 KB
/
Subscriber.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
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package ads
import (
"context"
"github.com/apache/plc4x/plc4go/spi/options"
"runtime/debug"
"time"
dirverModel "github.com/apache/plc4x/plc4go/internal/ads/model"
apiModel "github.com/apache/plc4x/plc4go/pkg/api/model"
"github.com/apache/plc4x/plc4go/protocols/ads/readwrite/model"
spiModel "github.com/apache/plc4x/plc4go/spi/model"
"github.com/apache/plc4x/plc4go/spi/utils"
"github.com/pkg/errors"
)
func (m *Connection) SubscriptionRequestBuilder() apiModel.PlcSubscriptionRequestBuilder {
return spiModel.NewDefaultPlcSubscriptionRequestBuilder(m.GetPlcTagHandler(), m.GetPlcValueHandler(), m)
}
func (m *Connection) UnsubscriptionRequestBuilder() apiModel.PlcUnsubscriptionRequestBuilder {
// TODO: Implement this ...
return nil
}
func (m *Connection) Subscribe(ctx context.Context, subscriptionRequest apiModel.PlcSubscriptionRequest) <-chan apiModel.PlcSubscriptionRequestResult {
defaultSubscriptionRequest := subscriptionRequest.(*spiModel.DefaultPlcSubscriptionRequest)
// Subscription requests are unfortunately now supported as multi-item requests,
// so we have to send one subscription request for every tag.
// Prepare the subscription requests, by ensuring any symbolic tags are correctly resolved
// and splitting them up into single-tag requests.
subSubscriptionRequests := map[string]apiModel.PlcSubscriptionRequest{}
subResults := map[string]apiModel.PlcSubscriptionRequestResult{}
// Iterate over all requests and add the result-channels to the list
for _, tagName := range subscriptionRequest.GetTagNames() {
tag := subscriptionRequest.GetTag(tagName)
var directTag dirverModel.DirectPlcTag
switch tag.(type) {
case dirverModel.DirectPlcTag:
directTag = tag.(dirverModel.DirectPlcTag)
case dirverModel.SymbolicPlcTag:
symbolicTag := tag.(dirverModel.SymbolicPlcTag)
directTagPtr, err := m.driverContext.getDirectTagForSymbolTag(symbolicTag)
if err != nil {
subResults[tagName] = spiModel.NewDefaultPlcSubscriptionRequestResult(subscriptionRequest, nil, errors.Wrap(err, "error resolving symbolic tag"))
continue
}
directTag = *directTagPtr
default:
subResults[tagName] = spiModel.NewDefaultPlcSubscriptionRequestResult(subscriptionRequest, nil, errors.New("invalid tag type"))
continue
}
subscriptionType := defaultSubscriptionRequest.GetType(tagName)
interval := defaultSubscriptionRequest.GetInterval(tagName)
preRegisteredConsumers := defaultSubscriptionRequest.GetPreRegisteredConsumers(tagName)
subSubscriptionRequests[tagName] = spiModel.NewDefaultPlcSubscriptionRequest(
m,
[]string{tagName},
map[string]apiModel.PlcSubscriptionTag{tagName: directTag},
map[string]apiModel.PlcSubscriptionType{tagName: subscriptionType},
map[string]time.Duration{tagName: interval},
map[string][]apiModel.PlcSubscriptionEventConsumer{tagName: preRegisteredConsumers},
)
}
// If this is a single item request, we can take a shortcut.
if len(subSubscriptionRequests) == 1 {
tagName := subscriptionRequest.GetTagNames()[0]
subSubscriptionRequest := subSubscriptionRequests[tagName]
return m.subscribe(ctx, subSubscriptionRequest)
}
// Create a sub-result-channel map and prepare execute the subscriptions.
subResultChannels := map[string]<-chan apiModel.PlcSubscriptionRequestResult{}
for tagName, subSubscriptionRequest := range subSubscriptionRequests {
subResultChannels[tagName] = m.subscribe(ctx, subSubscriptionRequest)
}
// Create a new result-channel, which completes as soon as all sub-result-channels have returned
globalResultChannel := make(chan apiModel.PlcSubscriptionRequestResult, 1)
go func() {
defer func() {
if err := recover(); err != nil {
m.log.Error().
Str("stack", string(debug.Stack())).
Interface("err", err).
Msg("panic-ed")
}
}()
// Iterate over all sub-results
for _, subResultChannel := range subResultChannels {
select {
case <-ctx.Done():
globalResultChannel <- spiModel.NewDefaultPlcSubscriptionRequestResult(subscriptionRequest, nil, ctx.Err())
return
case subResult := <-subResultChannel:
// These are all single value requests ... so it's safe to assume this shortcut.
tagName := subResult.GetRequest().GetTagNames()[0]
subResults[tagName] = subResult
}
}
// As soon as all are done, process the results
result := m.processSubscriptionResponses(ctx, subscriptionRequest, subResults)
// Return the final result
globalResultChannel <- result
}()
return globalResultChannel
}
func (m *Connection) subscribe(ctx context.Context, subscriptionRequest apiModel.PlcSubscriptionRequest) <-chan apiModel.PlcSubscriptionRequestResult {
responseChan := make(chan apiModel.PlcSubscriptionRequestResult, 1)
go func() {
defer func() {
if err := recover(); err != nil {
responseChan <- spiModel.NewDefaultPlcSubscriptionRequestResult(subscriptionRequest, nil, errors.Errorf("panic-ed %v. Stack: %s", err, debug.Stack()))
}
}()
// At this point we are sure to only have single item direct tag requests.
tagName := subscriptionRequest.GetTagNames()[0]
directTag := subscriptionRequest.GetTag(tagName).(dirverModel.DirectPlcTag)
if directTag.DataType == nil {
directTag.DataType = m.driverContext.dataTypeTable[directTag.ValueType.String()]
}
response, err := m.ExecuteAdsAddDeviceNotificationRequest(ctx, directTag.IndexGroup, directTag.IndexOffset, directTag.DataType.GetSize(), model.AdsTransMode_ON_CHANGE, 0, 0)
if err != nil {
responseChan <- spiModel.NewDefaultPlcSubscriptionRequestResult(
subscriptionRequest,
nil,
err,
)
}
// Create a new subscription handle.
subscriptionHandle := dirverModel.NewAdsSubscriptionHandle(
m,
tagName,
directTag,
append(m._options, options.WithCustomLogger(m.log))...,
)
responseChan <- spiModel.NewDefaultPlcSubscriptionRequestResult(
subscriptionRequest,
spiModel.NewDefaultPlcSubscriptionResponse(
subscriptionRequest,
map[string]apiModel.PlcResponseCode{tagName: apiModel.PlcResponseCode_OK},
map[string]apiModel.PlcSubscriptionHandle{tagName: subscriptionHandle},
append(m._options, options.WithCustomLogger(m.log))...,
),
nil,
)
// Store it together with the returned ADS handle.
m.subscriptions[response.GetNotificationHandle()] = subscriptionHandle
}()
return responseChan
}
func (m *Connection) processSubscriptionResponses(_ context.Context, subscriptionRequest apiModel.PlcSubscriptionRequest, subscriptionResults map[string]apiModel.PlcSubscriptionRequestResult) apiModel.PlcSubscriptionRequestResult {
if len(subscriptionResults) == 1 {
m.log.Debug().Msg("We got only one response, no merging required")
for tagName := range subscriptionResults {
return subscriptionResults[tagName]
}
}
m.log.Trace().Msg("Merging requests")
responseCodes := map[string]apiModel.PlcResponseCode{}
subscriptionHandles := map[string]apiModel.PlcSubscriptionHandle{}
var err error = nil
for _, subscriptionResult := range subscriptionResults {
if subscriptionResult.GetErr() != nil {
m.log.Debug().Err(subscriptionResult.GetErr()).Msg("Error during subscription")
if err == nil {
// Lazy initialization of multi error
err = utils.MultiError{MainError: errors.New("while aggregating results"), Errors: []error{subscriptionResult.GetErr()}}
} else {
multiError := err.(utils.MultiError)
multiError.Errors = append(multiError.Errors, subscriptionResult.GetErr())
}
} else if subscriptionResult.GetResponse() != nil {
if len(subscriptionResult.GetResponse().GetRequest().GetTagNames()) > 1 {
m.log.Error().Int("numberOfTags", len(subscriptionResult.GetResponse().GetRequest().GetTagNames())).Msg("We should only get 1")
}
for _, tagName := range subscriptionResult.GetResponse().GetRequest().GetTagNames() {
handle, err := subscriptionResult.GetResponse().GetSubscriptionHandle(tagName)
if err != nil {
responseCodes[tagName] = apiModel.PlcResponseCode_REMOTE_ERROR
} else {
responseCodes[tagName] = subscriptionResult.GetResponse().GetResponseCode(tagName)
subscriptionHandles[tagName] = handle
}
}
}
}
return spiModel.NewDefaultPlcSubscriptionRequestResult(
subscriptionRequest,
spiModel.NewDefaultPlcSubscriptionResponse(
subscriptionRequest,
responseCodes,
subscriptionHandles,
append(m._options, options.WithCustomLogger(m.log))...,
),
err,
)
}
func (m *Connection) handleIncomingDeviceNotificationRequest(deviceNotificationRequest model.AdsDeviceNotificationRequest) {
for _, stampHeader := range deviceNotificationRequest.GetAdsStampHeaders() {
for _, sample := range stampHeader.GetAdsNotificationSamples() {
notificationHandle := sample.GetNotificationHandle()
subscriptionHandler, ok := m.subscriptions[notificationHandle]
if !ok {
continue
}
adsSubscriptionHandler, ok := subscriptionHandler.(*dirverModel.AdsSubscriptionHandle)
if !ok {
continue
}
// If no one is consuming, we don't need to waste effort in parsing.
if adsSubscriptionHandler.GetNumConsumers() == 0 {
continue
}
// Create a readBuffer containing the sample data
readBuffer := utils.NewReadBufferByteBased(sample.GetData())
// Parse the data according to theÏ type data stored in the tag
directTag := adsSubscriptionHandler.GetDirectTag()
plcValue, err := m.parsePlcValue(directTag.DataType, directTag.DataType.GetArrayInfo(), readBuffer)
if err != nil {
continue
}
// Publish the parsed value to the subscribers.
adsSubscriptionHandler.PublishPlcValue(plcValue)
}
}
}
func (m *Connection) Unsubscribe(ctx context.Context, unsubscriptionRequest apiModel.PlcUnsubscriptionRequest) <-chan apiModel.PlcUnsubscriptionRequestResult {
return nil
}
func (m *Connection) Register(consumer apiModel.PlcSubscriptionEventConsumer, handles []apiModel.PlcSubscriptionHandle) apiModel.PlcConsumerRegistration {
return nil
}
func (m *Connection) Unregister(registration apiModel.PlcConsumerRegistration) {
}