ua_services_subscription.c 32 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740
  1. /* This Source Code Form is subject to the terms of the Mozilla Public
  2. * License, v. 2.0. If a copy of the MPL was not distributed with this
  3. * file, You can obtain one at http://mozilla.org/MPL/2.0/.
  4. *
  5. * Copyright 2014-2017 (c) Fraunhofer IOSB (Author: Julius Pfrommer)
  6. * Copyright 2016-2017 (c) Florian Palm
  7. * Copyright 2015 (c) Chris Iatrou
  8. * Copyright 2015-2016 (c) Sten Grüner
  9. * Copyright 2015-2016 (c) Oleksiy Vasylyev
  10. * Copyright 2017 (c) Stefan Profanter, fortiss GmbH
  11. * Copyright 2017 (c) Mattias Bornhager
  12. * Copyright 2017 (c) Henrik Norrman
  13. * Copyright 2017-2018 (c) Thomas Stalder, Blue Time Concept SA
  14. */
  15. #include "ua_server_internal.h"
  16. #include "ua_services.h"
  17. #include "ua_subscription.h"
  18. #ifdef UA_ENABLE_SUBSCRIPTIONS /* conditional compilation */
  19. #define UA_BOUNDEDVALUE_SETWBOUNDS(BOUNDS, SRC, DST) { \
  20. if(SRC > BOUNDS.max) DST = BOUNDS.max; \
  21. else if(SRC < BOUNDS.min) DST = BOUNDS.min; \
  22. else DST = SRC; \
  23. }
  24. static void
  25. setSubscriptionSettings(UA_Server *server, UA_Subscription *subscription,
  26. UA_Double requestedPublishingInterval,
  27. UA_UInt32 requestedLifetimeCount,
  28. UA_UInt32 requestedMaxKeepAliveCount,
  29. UA_UInt32 maxNotificationsPerPublish, UA_Byte priority) {
  30. /* deregister the callback if required */
  31. UA_StatusCode retval = Subscription_unregisterPublishCallback(server, subscription);
  32. if(retval != UA_STATUSCODE_GOOD)
  33. UA_LOG_DEBUG_SESSION(server->config.logger, subscription->session,
  34. "Subscription %u | Could not unregister publish callback with error code %s",
  35. subscription->subscriptionId, UA_StatusCode_name(retval));
  36. /* re-parameterize the subscription */
  37. subscription->publishingInterval = requestedPublishingInterval;
  38. UA_BOUNDEDVALUE_SETWBOUNDS(server->config.publishingIntervalLimits,
  39. requestedPublishingInterval, subscription->publishingInterval);
  40. /* check for nan*/
  41. if(requestedPublishingInterval != requestedPublishingInterval)
  42. subscription->publishingInterval = server->config.publishingIntervalLimits.min;
  43. UA_BOUNDEDVALUE_SETWBOUNDS(server->config.keepAliveCountLimits,
  44. requestedMaxKeepAliveCount, subscription->maxKeepAliveCount);
  45. UA_BOUNDEDVALUE_SETWBOUNDS(server->config.lifeTimeCountLimits,
  46. requestedLifetimeCount, subscription->lifeTimeCount);
  47. if(subscription->lifeTimeCount < 3 * subscription->maxKeepAliveCount)
  48. subscription->lifeTimeCount = 3 * subscription->maxKeepAliveCount;
  49. subscription->notificationsPerPublish = maxNotificationsPerPublish;
  50. if(maxNotificationsPerPublish == 0 ||
  51. maxNotificationsPerPublish > server->config.maxNotificationsPerPublish)
  52. subscription->notificationsPerPublish = server->config.maxNotificationsPerPublish;
  53. subscription->priority = priority;
  54. retval = Subscription_registerPublishCallback(server, subscription);
  55. if(retval != UA_STATUSCODE_GOOD)
  56. UA_LOG_DEBUG_SESSION(server->config.logger, subscription->session,
  57. "Subscription %u | Could not register publish callback with error code %s",
  58. subscription->subscriptionId, UA_StatusCode_name(retval));
  59. }
  60. void
  61. Service_CreateSubscription(UA_Server *server, UA_Session *session,
  62. const UA_CreateSubscriptionRequest *request,
  63. UA_CreateSubscriptionResponse *response) {
  64. /* Check limits for the number of subscriptions */
  65. if((server->config.maxSubscriptionsPerSession != 0) &&
  66. (session->numPublishReq >= server->config.maxSubscriptionsPerSession)) {
  67. response->responseHeader.serviceResult = UA_STATUSCODE_BADTOOMANYSUBSCRIPTIONS;
  68. return;
  69. }
  70. /* Create the subscription */
  71. UA_Subscription *newSubscription = UA_Subscription_new(session, response->subscriptionId);
  72. if(!newSubscription) {
  73. UA_LOG_DEBUG_SESSION(server->config.logger, session,
  74. "Processing CreateSubscriptionRequest failed");
  75. response->responseHeader.serviceResult = UA_STATUSCODE_BADOUTOFMEMORY;
  76. return;
  77. }
  78. UA_Session_addSubscription(session, newSubscription); /* Also assigns the subscription id */
  79. /* Set the subscription parameters */
  80. newSubscription->publishingEnabled = request->publishingEnabled;
  81. setSubscriptionSettings(server, newSubscription, request->requestedPublishingInterval,
  82. request->requestedLifetimeCount, request->requestedMaxKeepAliveCount,
  83. request->maxNotificationsPerPublish, request->priority);
  84. newSubscription->currentKeepAliveCount = newSubscription->maxKeepAliveCount; /* set settings first */
  85. /* Prepare the response */
  86. response->subscriptionId = newSubscription->subscriptionId;
  87. response->revisedPublishingInterval = newSubscription->publishingInterval;
  88. response->revisedLifetimeCount = newSubscription->lifeTimeCount;
  89. response->revisedMaxKeepAliveCount = newSubscription->maxKeepAliveCount;
  90. UA_LOG_DEBUG_SESSION(server->config.logger, session,
  91. "CreateSubscriptionRequest: Created Subscription %u "
  92. "with a publishing interval of %f ms", response->subscriptionId,
  93. newSubscription->publishingInterval);
  94. }
  95. void
  96. Service_ModifySubscription(UA_Server *server, UA_Session *session,
  97. const UA_ModifySubscriptionRequest *request,
  98. UA_ModifySubscriptionResponse *response) {
  99. UA_LOG_DEBUG_SESSION(server->config.logger, session, "Processing ModifySubscriptionRequest");
  100. UA_Subscription *sub = UA_Session_getSubscriptionById(session, request->subscriptionId);
  101. if(!sub) {
  102. response->responseHeader.serviceResult = UA_STATUSCODE_BADSUBSCRIPTIONIDINVALID;
  103. return;
  104. }
  105. setSubscriptionSettings(server, sub, request->requestedPublishingInterval,
  106. request->requestedLifetimeCount, request->requestedMaxKeepAliveCount,
  107. request->maxNotificationsPerPublish, request->priority);
  108. sub->currentLifetimeCount = 0; /* Reset the subscription lifetime */
  109. response->revisedPublishingInterval = sub->publishingInterval;
  110. response->revisedLifetimeCount = sub->lifeTimeCount;
  111. response->revisedMaxKeepAliveCount = sub->maxKeepAliveCount;
  112. }
  113. static void
  114. Operation_SetPublishingMode(UA_Server *Server, UA_Session *session,
  115. UA_Boolean *publishingEnabled, UA_UInt32 *subscriptionId,
  116. UA_StatusCode *result) {
  117. UA_Subscription *sub = UA_Session_getSubscriptionById(session, *subscriptionId);
  118. if(!sub) {
  119. *result = UA_STATUSCODE_BADSUBSCRIPTIONIDINVALID;
  120. return;
  121. }
  122. sub->currentLifetimeCount = 0; /* Reset the subscription lifetime */
  123. sub->publishingEnabled = *publishingEnabled; /* Set the publishing mode */
  124. }
  125. void
  126. Service_SetPublishingMode(UA_Server *server, UA_Session *session,
  127. const UA_SetPublishingModeRequest *request,
  128. UA_SetPublishingModeResponse *response) {
  129. UA_LOG_DEBUG_SESSION(server->config.logger, session, "Processing SetPublishingModeRequest");
  130. UA_Boolean publishingEnabled = request->publishingEnabled; /* request is const */
  131. response->responseHeader.serviceResult =
  132. UA_Server_processServiceOperations(server, session, (UA_ServiceOperation)Operation_SetPublishingMode,
  133. &publishingEnabled,
  134. &request->subscriptionIdsSize, &UA_TYPES[UA_TYPES_UINT32],
  135. &response->resultsSize, &UA_TYPES[UA_TYPES_STATUSCODE]);
  136. }
  137. static UA_StatusCode
  138. setMonitoredItemSettings(UA_Server *server, UA_MonitoredItem *mon,
  139. UA_MonitoringMode monitoringMode,
  140. const UA_MonitoringParameters *params,
  141. // This parameter is optional and used only if mon->lastValue is not set yet.
  142. // Then numeric type will be detected from this value. Set null as defaut.
  143. const UA_DataType* dataType) {
  144. /* Filter */
  145. if(params->filter.encoding != UA_EXTENSIONOBJECT_DECODED) {
  146. UA_DataChangeFilter_init(&(mon->filter));
  147. mon->filter.trigger = UA_DATACHANGETRIGGER_STATUSVALUE;
  148. } else if(params->filter.content.decoded.type != &UA_TYPES[UA_TYPES_DATACHANGEFILTER]) {
  149. return UA_STATUSCODE_BADMONITOREDITEMFILTERINVALID;
  150. } else {
  151. UA_DataChangeFilter *filter = (UA_DataChangeFilter *)params->filter.content.decoded.data;
  152. // TODO implement EURange to support UA_DEADBANDTYPE_PERCENT
  153. if (filter->deadbandType == UA_DEADBANDTYPE_PERCENT) {
  154. return UA_STATUSCODE_BADMONITOREDITEMFILTERUNSUPPORTED;
  155. }
  156. if (UA_Variant_isEmpty(&mon->lastValue)) {
  157. if (!dataType || !isDataTypeNumeric(dataType))
  158. return UA_STATUSCODE_BADFILTERNOTALLOWED;
  159. } else
  160. if (!isDataTypeNumeric(mon->lastValue.type)) {
  161. return UA_STATUSCODE_BADFILTERNOTALLOWED;
  162. }
  163. UA_DataChangeFilter_copy(filter, &(mon->filter));
  164. }
  165. MonitoredItem_unregisterSampleCallback(server, mon);
  166. mon->monitoringMode = monitoringMode;
  167. /* ClientHandle */
  168. mon->clientHandle = params->clientHandle;
  169. /* SamplingInterval */
  170. UA_Double samplingInterval = params->samplingInterval;
  171. if(mon->attributeId == UA_ATTRIBUTEID_VALUE) {
  172. const UA_VariableNode *vn = (const UA_VariableNode *)
  173. UA_Nodestore_get(server, &mon->monitoredNodeId);
  174. if(vn) {
  175. if(vn->nodeClass == UA_NODECLASS_VARIABLE &&
  176. samplingInterval < vn->minimumSamplingInterval)
  177. samplingInterval = vn->minimumSamplingInterval;
  178. UA_Nodestore_release(server, (const UA_Node *)vn);
  179. }
  180. } else if(mon->attributeId == UA_ATTRIBUTEID_EVENTNOTIFIER) {
  181. /* TODO: events should not need a samplinginterval */
  182. samplingInterval = 10000.0f; // 10 seconds to reduce the load
  183. }
  184. mon->samplingInterval = samplingInterval;
  185. UA_BOUNDEDVALUE_SETWBOUNDS(server->config.samplingIntervalLimits,
  186. samplingInterval, mon->samplingInterval);
  187. if(samplingInterval != samplingInterval) /* Check for nan */
  188. mon->samplingInterval = server->config.samplingIntervalLimits.min;
  189. /* QueueSize */
  190. UA_BOUNDEDVALUE_SETWBOUNDS(server->config.queueSizeLimits,
  191. params->queueSize, mon->maxQueueSize);
  192. /* DiscardOldest */
  193. mon->discardOldest = params->discardOldest;
  194. /* Register sample callback if reporting is enabled */
  195. if(monitoringMode == UA_MONITORINGMODE_REPORTING)
  196. MonitoredItem_registerSampleCallback(server, mon);
  197. return UA_STATUSCODE_GOOD;
  198. }
  199. static const UA_String binaryEncoding = {sizeof("Default Binary") - 1, (UA_Byte *)"Default Binary"};
  200. /* Thread-local variables to pass additional arguments into the operation */
  201. struct createMonContext {
  202. UA_Subscription *sub;
  203. UA_TimestampsToReturn timestampsToReturn;
  204. };
  205. static void
  206. Operation_CreateMonitoredItem(UA_Server *server, UA_Session *session, struct createMonContext *cmc,
  207. const UA_MonitoredItemCreateRequest *request,
  208. UA_MonitoredItemCreateResult *result) {
  209. /* Check available capacity */
  210. if(server->config.maxMonitoredItemsPerSubscription != 0 &&
  211. cmc->sub->monitoredItemsSize >= server->config.maxMonitoredItemsPerSubscription) {
  212. result->statusCode = UA_STATUSCODE_BADTOOMANYMONITOREDITEMS;
  213. return;
  214. }
  215. /* Make an example read to get errors in the itemToMonitor. Allow return
  216. * codes "good" and "uncertain", as well as a list of statuscodes that might
  217. * be repaired inside the data source. */
  218. UA_DataValue v = UA_Server_readWithSession(server, session, &request->itemToMonitor,
  219. cmc->timestampsToReturn);
  220. if(v.hasStatus && (v.status >> 30) > 1 &&
  221. v.status != UA_STATUSCODE_BADRESOURCEUNAVAILABLE &&
  222. v.status != UA_STATUSCODE_BADCOMMUNICATIONERROR &&
  223. v.status != UA_STATUSCODE_BADWAITINGFORINITIALDATA &&
  224. v.status != UA_STATUSCODE_BADUSERACCESSDENIED &&
  225. v.status != UA_STATUSCODE_BADNOTREADABLE &&
  226. v.status != UA_STATUSCODE_BADINDEXRANGENODATA) {
  227. result->statusCode = v.status;
  228. UA_DataValue_deleteMembers(&v);
  229. return;
  230. }
  231. /* Check if the encoding is supported */
  232. if(request->itemToMonitor.dataEncoding.name.length > 0 &&
  233. (!UA_String_equal(&binaryEncoding, &request->itemToMonitor.dataEncoding.name) ||
  234. request->itemToMonitor.dataEncoding.namespaceIndex != 0)) {
  235. result->statusCode = UA_STATUSCODE_BADDATAENCODINGUNSUPPORTED;
  236. UA_DataValue_deleteMembers(&v);
  237. return;
  238. }
  239. /* Check if the encoding is set for a value */
  240. if(request->itemToMonitor.attributeId != UA_ATTRIBUTEID_VALUE &&
  241. request->itemToMonitor.dataEncoding.name.length > 0) {
  242. result->statusCode = UA_STATUSCODE_BADDATAENCODINGINVALID;
  243. UA_DataValue_deleteMembers(&v);
  244. return;
  245. }
  246. /* Create the monitoreditem */
  247. UA_MonitoredItem *newMon = UA_MonitoredItem_new(UA_MONITOREDITEMTYPE_CHANGENOTIFY);
  248. if(!newMon) {
  249. result->statusCode = UA_STATUSCODE_BADOUTOFMEMORY;
  250. UA_DataValue_deleteMembers(&v);
  251. return;
  252. }
  253. UA_StatusCode retval = UA_NodeId_copy(&request->itemToMonitor.nodeId,
  254. &newMon->monitoredNodeId);
  255. if(retval != UA_STATUSCODE_GOOD) {
  256. result->statusCode = retval;
  257. MonitoredItem_delete(server, newMon);
  258. UA_DataValue_deleteMembers(&v);
  259. return;
  260. }
  261. newMon->subscription = cmc->sub;
  262. newMon->attributeId = request->itemToMonitor.attributeId;
  263. UA_String_copy(&request->itemToMonitor.indexRange, &newMon->indexRange);
  264. newMon->monitoredItemId = ++cmc->sub->lastMonitoredItemId;
  265. newMon->timestampsToReturn = cmc->timestampsToReturn;
  266. retval = setMonitoredItemSettings(server, newMon, request->monitoringMode,
  267. &request->requestedParameters, v.value.type);
  268. UA_DataValue_deleteMembers(&v);
  269. if(retval != UA_STATUSCODE_GOOD) {
  270. UA_LOG_INFO_SESSION(server->config.logger, session, "Could not create MonitoredItem "
  271. "with status code %s", UA_StatusCode_name(retval));
  272. result->statusCode = retval;
  273. MonitoredItem_delete(server, newMon);
  274. --cmc->sub->lastMonitoredItemId;
  275. return;
  276. }
  277. UA_Subscription_addMonitoredItem(cmc->sub, newMon);
  278. /* Create the first sample */
  279. if(request->monitoringMode == UA_MONITORINGMODE_REPORTING)
  280. UA_MonitoredItem_SampleCallback(server, newMon);
  281. /* Prepare the response */
  282. result->revisedSamplingInterval = newMon->samplingInterval;
  283. result->revisedQueueSize = newMon->maxQueueSize;
  284. result->monitoredItemId = newMon->monitoredItemId;
  285. }
  286. void
  287. Service_CreateMonitoredItems(UA_Server *server, UA_Session *session,
  288. const UA_CreateMonitoredItemsRequest *request,
  289. UA_CreateMonitoredItemsResponse *response) {
  290. UA_LOG_DEBUG_SESSION(server->config.logger, session, "Processing CreateMonitoredItemsRequest");
  291. if(server->config.maxMonitoredItemsPerCall != 0 &&
  292. request->itemsToCreateSize > server->config.maxMonitoredItemsPerCall) {
  293. response->responseHeader.serviceResult = UA_STATUSCODE_BADTOOMANYOPERATIONS;
  294. return;
  295. }
  296. /* Check if the timestampstoreturn is valid */
  297. struct createMonContext cmc;
  298. cmc.timestampsToReturn = request->timestampsToReturn;
  299. if(cmc.timestampsToReturn > UA_TIMESTAMPSTORETURN_NEITHER) {
  300. response->responseHeader.serviceResult = UA_STATUSCODE_BADTIMESTAMPSTORETURNINVALID;
  301. return;
  302. }
  303. /* Find the subscription */
  304. cmc.sub = UA_Session_getSubscriptionById(session, request->subscriptionId);
  305. if(!cmc.sub) {
  306. response->responseHeader.serviceResult = UA_STATUSCODE_BADSUBSCRIPTIONIDINVALID;
  307. return;
  308. }
  309. /* Reset the subscription lifetime */
  310. cmc.sub->currentLifetimeCount = 0;
  311. response->responseHeader.serviceResult =
  312. UA_Server_processServiceOperations(server, session, (UA_ServiceOperation)Operation_CreateMonitoredItem, &cmc,
  313. &request->itemsToCreateSize, &UA_TYPES[UA_TYPES_MONITOREDITEMCREATEREQUEST],
  314. &response->resultsSize, &UA_TYPES[UA_TYPES_MONITOREDITEMCREATERESULT]);
  315. }
  316. static void
  317. Operation_ModifyMonitoredItem(UA_Server *server, UA_Session *session, UA_Subscription *sub,
  318. const UA_MonitoredItemModifyRequest *request,
  319. UA_MonitoredItemModifyResult *result) {
  320. /* Get the MonitoredItem */
  321. UA_MonitoredItem *mon = UA_Subscription_getMonitoredItem(sub, request->monitoredItemId);
  322. if(!mon) {
  323. result->statusCode = UA_STATUSCODE_BADMONITOREDITEMIDINVALID;
  324. return;
  325. }
  326. UA_StatusCode retval;
  327. retval = setMonitoredItemSettings(server, mon, mon->monitoringMode, &request->requestedParameters, NULL);
  328. if(retval != UA_STATUSCODE_GOOD) {
  329. result->statusCode = retval;
  330. return;
  331. }
  332. result->revisedSamplingInterval = mon->samplingInterval;
  333. result->revisedQueueSize = mon->maxQueueSize;
  334. /* Remove some notifications if the queue is now too small */
  335. MonitoredItem_ensureQueueSpace(mon);
  336. }
  337. void
  338. Service_ModifyMonitoredItems(UA_Server *server, UA_Session *session,
  339. const UA_ModifyMonitoredItemsRequest *request,
  340. UA_ModifyMonitoredItemsResponse *response) {
  341. UA_LOG_DEBUG_SESSION(server->config.logger, session, "Processing ModifyMonitoredItemsRequest");
  342. if(server->config.maxMonitoredItemsPerCall != 0 &&
  343. request->itemsToModifySize > server->config.maxMonitoredItemsPerCall) {
  344. response->responseHeader.serviceResult = UA_STATUSCODE_BADTOOMANYOPERATIONS;
  345. return;
  346. }
  347. /* Check if the timestampstoreturn is valid */
  348. if(request->timestampsToReturn > UA_TIMESTAMPSTORETURN_NEITHER) {
  349. response->responseHeader.serviceResult = UA_STATUSCODE_BADTIMESTAMPSTORETURNINVALID;
  350. return;
  351. }
  352. /* Get the subscription */
  353. UA_Subscription *sub = UA_Session_getSubscriptionById(session, request->subscriptionId);
  354. if(!sub) {
  355. response->responseHeader.serviceResult = UA_STATUSCODE_BADSUBSCRIPTIONIDINVALID;
  356. return;
  357. }
  358. sub->currentLifetimeCount = 0; /* Reset the subscription lifetime */
  359. response->responseHeader.serviceResult =
  360. UA_Server_processServiceOperations(server, session,
  361. (UA_ServiceOperation)Operation_ModifyMonitoredItem, sub,
  362. &request->itemsToModifySize, &UA_TYPES[UA_TYPES_MONITOREDITEMMODIFYREQUEST],
  363. &response->resultsSize, &UA_TYPES[UA_TYPES_MONITOREDITEMMODIFYRESULT]);
  364. }
  365. struct setMonitoringContext {
  366. UA_Subscription *sub;
  367. UA_MonitoringMode monitoringMode;
  368. };
  369. static void
  370. Operation_SetMonitoringMode(UA_Server *server, UA_Session *session,
  371. struct setMonitoringContext *smc,
  372. UA_UInt32 *monitoredItemId, UA_StatusCode *result) {
  373. UA_MonitoredItem *mon = UA_Subscription_getMonitoredItem(smc->sub, *monitoredItemId);
  374. if(!mon) {
  375. *result = UA_STATUSCODE_BADMONITOREDITEMIDINVALID;
  376. return;
  377. }
  378. if(mon->monitoredItemType != UA_MONITOREDITEMTYPE_CHANGENOTIFY) {
  379. *result = UA_STATUSCODE_BADNOTIMPLEMENTED;
  380. return;
  381. }
  382. /* Check if the MonitoringMode is valid or not */
  383. if(smc->monitoringMode > UA_MONITORINGMODE_REPORTING) {
  384. *result = UA_STATUSCODE_BADMONITORINGMODEINVALID;
  385. return;
  386. }
  387. if(mon->monitoringMode == smc->monitoringMode)
  388. return;
  389. mon->monitoringMode = smc->monitoringMode;
  390. if(mon->monitoringMode == UA_MONITORINGMODE_REPORTING) {
  391. MonitoredItem_registerSampleCallback(server, mon);
  392. } else {
  393. MonitoredItem_unregisterSampleCallback(server, mon);
  394. // TODO correctly implement SAMPLING
  395. /* Setting the mode to DISABLED or SAMPLING causes all queued Notifications to be deleted */
  396. UA_Notification *notification, *notification_tmp;
  397. TAILQ_FOREACH_SAFE(notification, &mon->queue, listEntry, notification_tmp) {
  398. TAILQ_REMOVE(&mon->queue, notification, listEntry);
  399. TAILQ_REMOVE(&smc->sub->notificationQueue, notification, globalEntry);
  400. --smc->sub->notificationQueueSize;
  401. UA_DataValue_deleteMembers(&notification->data.value);
  402. UA_free(notification);
  403. }
  404. mon->queueSize = 0;
  405. /* Initialize lastSampledValue */
  406. UA_ByteString_deleteMembers(&mon->lastSampledValue);
  407. UA_Variant_deleteMembers(&mon->lastValue);
  408. }
  409. }
  410. void
  411. Service_SetMonitoringMode(UA_Server *server, UA_Session *session,
  412. const UA_SetMonitoringModeRequest *request,
  413. UA_SetMonitoringModeResponse *response) {
  414. UA_LOG_DEBUG_SESSION(server->config.logger, session, "Processing SetMonitoringMode");
  415. if(server->config.maxMonitoredItemsPerCall != 0 &&
  416. request->monitoredItemIdsSize > server->config.maxMonitoredItemsPerCall) {
  417. response->responseHeader.serviceResult = UA_STATUSCODE_BADTOOMANYOPERATIONS;
  418. return;
  419. }
  420. /* Get the subscription */
  421. struct setMonitoringContext smc;
  422. smc.sub = UA_Session_getSubscriptionById(session, request->subscriptionId);
  423. if(!smc.sub) {
  424. response->responseHeader.serviceResult = UA_STATUSCODE_BADSUBSCRIPTIONIDINVALID;
  425. return;
  426. }
  427. smc.sub->currentLifetimeCount = 0; /* Reset the subscription lifetime */
  428. smc.monitoringMode = request->monitoringMode;
  429. response->responseHeader.serviceResult =
  430. UA_Server_processServiceOperations(server, session,
  431. (UA_ServiceOperation)Operation_SetMonitoringMode, &smc,
  432. &request->monitoredItemIdsSize, &UA_TYPES[UA_TYPES_UINT32],
  433. &response->resultsSize, &UA_TYPES[UA_TYPES_STATUSCODE]);
  434. }
  435. /* TODO: Unify with senderror in ua_server_binary.c */
  436. static void
  437. subscriptionSendError(UA_SecureChannel *channel, UA_UInt32 requestHandle,
  438. UA_UInt32 requestId, UA_StatusCode error) {
  439. UA_PublishResponse err_response;
  440. UA_PublishResponse_init(&err_response);
  441. err_response.responseHeader.requestHandle = requestHandle;
  442. err_response.responseHeader.timestamp = UA_DateTime_now();
  443. err_response.responseHeader.serviceResult = error;
  444. UA_SecureChannel_sendSymmetricMessage(channel, requestId, UA_MESSAGETYPE_MSG,
  445. &err_response, &UA_TYPES[UA_TYPES_PUBLISHRESPONSE]);
  446. }
  447. void
  448. Service_Publish(UA_Server *server, UA_Session *session,
  449. const UA_PublishRequest *request, UA_UInt32 requestId) {
  450. UA_LOG_DEBUG_SESSION(server->config.logger, session, "Processing PublishRequest");
  451. /* Return an error if the session has no subscription */
  452. if(LIST_EMPTY(&session->serverSubscriptions)) {
  453. subscriptionSendError(session->header.channel, request->requestHeader.requestHandle,
  454. requestId, UA_STATUSCODE_BADNOSUBSCRIPTION);
  455. return;
  456. }
  457. /* Handle too many subscriptions to free resources before trying to allocate
  458. * resources for the new publish request. If the limit has been reached the
  459. * oldest publish request shall be responded */
  460. if((server->config.maxPublishReqPerSession != 0) &&
  461. (session->numPublishReq >= server->config.maxPublishReqPerSession)) {
  462. if(!UA_Subscription_reachedPublishReqLimit(server, session)) {
  463. subscriptionSendError(session->header.channel, requestId,
  464. request->requestHeader.requestHandle,
  465. UA_STATUSCODE_BADINTERNALERROR);
  466. return;
  467. }
  468. }
  469. /* Allocate the response to store it in the retransmission queue */
  470. UA_PublishResponseEntry *entry = (UA_PublishResponseEntry *)
  471. UA_malloc(sizeof(UA_PublishResponseEntry));
  472. if(!entry) {
  473. subscriptionSendError(session->header.channel, requestId,
  474. request->requestHeader.requestHandle,
  475. UA_STATUSCODE_BADOUTOFMEMORY);
  476. return;
  477. }
  478. /* Prepare the response */
  479. entry->requestId = requestId;
  480. UA_PublishResponse *response = &entry->response;
  481. UA_PublishResponse_init(response);
  482. response->responseHeader.requestHandle = request->requestHeader.requestHandle;
  483. /* Allocate the results array to acknowledge the acknowledge */
  484. if(request->subscriptionAcknowledgementsSize > 0) {
  485. response->results = (UA_StatusCode *)
  486. UA_Array_new(request->subscriptionAcknowledgementsSize,
  487. &UA_TYPES[UA_TYPES_STATUSCODE]);
  488. if(!response->results) {
  489. UA_free(entry);
  490. subscriptionSendError(session->header.channel, requestId,
  491. request->requestHeader.requestHandle,
  492. UA_STATUSCODE_BADOUTOFMEMORY);
  493. return;
  494. }
  495. response->resultsSize = request->subscriptionAcknowledgementsSize;
  496. }
  497. /* Delete Acknowledged Subscription Messages */
  498. for(size_t i = 0; i < request->subscriptionAcknowledgementsSize; ++i) {
  499. UA_SubscriptionAcknowledgement *ack = &request->subscriptionAcknowledgements[i];
  500. UA_Subscription *sub = UA_Session_getSubscriptionById(session, ack->subscriptionId);
  501. if(!sub) {
  502. response->results[i] = UA_STATUSCODE_BADSUBSCRIPTIONIDINVALID;
  503. UA_LOG_DEBUG_SESSION(server->config.logger, session,
  504. "Cannot process acknowledgements subscription %u",
  505. ack->subscriptionId);
  506. continue;
  507. }
  508. /* Remove the acked transmission from the retransmission queue */
  509. response->results[i] = UA_Subscription_removeRetransmissionMessage(sub, ack->sequenceNumber);
  510. }
  511. /* Queue the publish response. It will be dequeued in a repeated publish
  512. * callback. This can also be triggered right now for a late
  513. * subscription. */
  514. UA_Session_queuePublishReq(session, entry, false);
  515. UA_LOG_DEBUG_SESSION(server->config.logger, session, "Queued a publication message");
  516. /* If there are late subscriptions, the new publish request is used to
  517. * answer them immediately. However, a single subscription that generates
  518. * many notifications must not "starve" other late subscriptions. Therefore
  519. * we keep track of the last subscription that got preferential treatment.
  520. * We start searching for late subscriptions **after** the last one. */
  521. UA_Subscription *immediate = NULL;
  522. if(session->lastSeenSubscriptionId > 0) {
  523. LIST_FOREACH(immediate, &session->serverSubscriptions, listEntry) {
  524. if(immediate->subscriptionId == session->lastSeenSubscriptionId) {
  525. immediate = LIST_NEXT(immediate, listEntry);
  526. break;
  527. }
  528. }
  529. }
  530. /* If no entry was found, start at the beginning and don't restart */
  531. UA_Boolean found = false;
  532. if(!immediate)
  533. immediate = LIST_FIRST(&session->serverSubscriptions);
  534. else
  535. found = true;
  536. repeat:
  537. while(immediate) {
  538. if(immediate->state == UA_SUBSCRIPTIONSTATE_LATE) {
  539. session->lastSeenSubscriptionId = immediate->subscriptionId;
  540. UA_LOG_DEBUG_SESSION(server->config.logger, session,
  541. "Subscription %u | Response on a late subscription",
  542. immediate->subscriptionId);
  543. UA_Subscription_publish(server, immediate);
  544. return;
  545. }
  546. immediate = LIST_NEXT(immediate, listEntry);
  547. }
  548. /* Restart at the beginning of the list */
  549. if(found) {
  550. immediate = LIST_FIRST(&session->serverSubscriptions);
  551. found = false;
  552. goto repeat;
  553. }
  554. /* No late subscription this time */
  555. session->lastSeenSubscriptionId = 0;
  556. }
  557. static void
  558. Operation_DeleteSubscription(UA_Server *server, UA_Session *session, void *_,
  559. UA_UInt32 *subscriptionId, UA_StatusCode *result) {
  560. *result = UA_Session_deleteSubscription(server, session, *subscriptionId);
  561. if(*result == UA_STATUSCODE_GOOD) {
  562. UA_LOG_DEBUG_SESSION(server->config.logger, session,
  563. "Subscription %u | Subscription deleted",
  564. *subscriptionId);
  565. } else {
  566. UA_LOG_DEBUG_SESSION(server->config.logger, session,
  567. "Deleting Subscription with Id %u failed with error code %s",
  568. *subscriptionId, UA_StatusCode_name(*result));
  569. }
  570. }
  571. void
  572. Service_DeleteSubscriptions(UA_Server *server, UA_Session *session,
  573. const UA_DeleteSubscriptionsRequest *request,
  574. UA_DeleteSubscriptionsResponse *response) {
  575. UA_LOG_DEBUG_SESSION(server->config.logger, session, "Processing DeleteSubscriptionsRequest");
  576. response->responseHeader.serviceResult =
  577. UA_Server_processServiceOperations(server, session,
  578. (UA_ServiceOperation)Operation_DeleteSubscription, NULL,
  579. &request->subscriptionIdsSize, &UA_TYPES[UA_TYPES_UINT32],
  580. &response->resultsSize, &UA_TYPES[UA_TYPES_STATUSCODE]);
  581. /* The session has at least one subscription */
  582. if(LIST_FIRST(&session->serverSubscriptions))
  583. return;
  584. /* Send remaining publish responses if the last subscription was removed */
  585. UA_Subscription_answerPublishRequestsNoSubscription(server, session);
  586. }
  587. static void
  588. Operation_DeleteMonitoredItem(UA_Server *server, UA_Session *session, UA_Subscription *sub,
  589. UA_UInt32 *monitoredItemId, UA_StatusCode *result) {
  590. *result = UA_Subscription_deleteMonitoredItem(server, sub, *monitoredItemId);
  591. }
  592. void
  593. Service_DeleteMonitoredItems(UA_Server *server, UA_Session *session,
  594. const UA_DeleteMonitoredItemsRequest *request,
  595. UA_DeleteMonitoredItemsResponse *response) {
  596. UA_LOG_DEBUG_SESSION(server->config.logger, session, "Processing DeleteMonitoredItemsRequest");
  597. if(server->config.maxMonitoredItemsPerCall != 0 &&
  598. request->monitoredItemIdsSize > server->config.maxMonitoredItemsPerCall) {
  599. response->responseHeader.serviceResult = UA_STATUSCODE_BADTOOMANYOPERATIONS;
  600. return;
  601. }
  602. /* Get the subscription */
  603. UA_Subscription *sub = UA_Session_getSubscriptionById(session, request->subscriptionId);
  604. if(!sub) {
  605. response->responseHeader.serviceResult = UA_STATUSCODE_BADSUBSCRIPTIONIDINVALID;
  606. return;
  607. }
  608. /* Reset the subscription lifetime */
  609. sub->currentLifetimeCount = 0;
  610. response->responseHeader.serviceResult =
  611. UA_Server_processServiceOperations(server, session,
  612. (UA_ServiceOperation)Operation_DeleteMonitoredItem, sub,
  613. &request->monitoredItemIdsSize, &UA_TYPES[UA_TYPES_UINT32],
  614. &response->resultsSize, &UA_TYPES[UA_TYPES_STATUSCODE]);
  615. }
  616. void
  617. Service_Republish(UA_Server *server, UA_Session *session, const UA_RepublishRequest *request,
  618. UA_RepublishResponse *response) {
  619. UA_LOG_DEBUG_SESSION(server->config.logger, session, "Processing RepublishRequest");
  620. /* Get the subscription */
  621. UA_Subscription *sub = UA_Session_getSubscriptionById(session, request->subscriptionId);
  622. if(!sub) {
  623. response->responseHeader.serviceResult = UA_STATUSCODE_BADSUBSCRIPTIONIDINVALID;
  624. return;
  625. }
  626. /* Reset the subscription lifetime */
  627. sub->currentLifetimeCount = 0;
  628. /* Find the notification in the retransmission queue */
  629. UA_NotificationMessageEntry *entry;
  630. TAILQ_FOREACH(entry, &sub->retransmissionQueue, listEntry) {
  631. if(entry->message.sequenceNumber == request->retransmitSequenceNumber)
  632. break;
  633. }
  634. if(!entry) {
  635. response->responseHeader.serviceResult = UA_STATUSCODE_BADMESSAGENOTAVAILABLE;
  636. return;
  637. }
  638. response->responseHeader.serviceResult =
  639. UA_NotificationMessage_copy(&entry->message, &response->notificationMessage);
  640. }
  641. #endif /* UA_ENABLE_SUBSCRIPTIONS */