ua_subscription.c 25 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635
  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. #include "ua_subscription.h"
  5. #include "ua_server_internal.h"
  6. #include "ua_types_encoding_binary.h"
  7. #include "ua_services.h"
  8. #include "ua_nodestore.h"
  9. #ifdef UA_ENABLE_SUBSCRIPTIONS /* conditional compilation */
  10. #define UA_VALUENCODING_MAXSTACK 512
  11. /*****************/
  12. /* MonitoredItem */
  13. /*****************/
  14. UA_MonitoredItem *
  15. UA_MonitoredItem_new(void) {
  16. /* Allocate the memory */
  17. UA_MonitoredItem *newItem =
  18. (UA_MonitoredItem*)UA_calloc(1, sizeof(UA_MonitoredItem));
  19. if(!newItem)
  20. return NULL;
  21. /* Remaining members are covered by calloc zeroing out the memory */
  22. newItem->monitoredItemType = UA_MONITOREDITEMTYPE_CHANGENOTIFY; /* currently hardcoded */
  23. newItem->timestampsToReturn = UA_TIMESTAMPSTORETURN_SOURCE;
  24. TAILQ_INIT(&newItem->queue);
  25. return newItem;
  26. }
  27. void
  28. MonitoredItem_delete(UA_Server *server, UA_MonitoredItem *monitoredItem) {
  29. /* Remove the sampling callback */
  30. MonitoredItem_unregisterSampleCallback(server, monitoredItem);
  31. /* Clear the queued samples */
  32. MonitoredItem_queuedValue *val, *val_tmp;
  33. TAILQ_FOREACH_SAFE(val, &monitoredItem->queue, listEntry, val_tmp) {
  34. TAILQ_REMOVE(&monitoredItem->queue, val, listEntry);
  35. UA_DataValue_deleteMembers(&val->value);
  36. UA_free(val);
  37. }
  38. monitoredItem->currentQueueSize = 0;
  39. /* Remove the monitored item */
  40. LIST_REMOVE(monitoredItem, listEntry);
  41. UA_String_deleteMembers(&monitoredItem->indexRange);
  42. UA_ByteString_deleteMembers(&monitoredItem->lastSampledValue);
  43. UA_NodeId_deleteMembers(&monitoredItem->monitoredNodeId);
  44. UA_free(monitoredItem); // TODO: Use a delayed free
  45. }
  46. static void
  47. ensureSpaceInMonitoredItemQueue(UA_MonitoredItem *mon) {
  48. /* Enough space, nothing to do here */
  49. if(mon->currentQueueSize < mon->maxQueueSize)
  50. return;
  51. /* Get the item to remove */
  52. MonitoredItem_queuedValue *queueItem;
  53. if(mon->discardOldest)
  54. queueItem = TAILQ_FIRST(&mon->queue);
  55. else
  56. queueItem = TAILQ_LAST(&mon->queue, QueuedValueQueue);
  57. UA_assert(queueItem);
  58. /* Remove the item */
  59. TAILQ_REMOVE(&mon->queue, queueItem, listEntry);
  60. UA_DataValue_deleteMembers(&queueItem->value);
  61. UA_free(queueItem);
  62. --mon->currentQueueSize;
  63. }
  64. /* Errors are returned as no change detected */
  65. static UA_Boolean
  66. detectValueChangeWithFilter(UA_MonitoredItem *mon, UA_DataValue *value,
  67. UA_ByteString *encoding) {
  68. /* Encode the data for comparison */
  69. size_t binsize = UA_calcSizeBinary(value, &UA_TYPES[UA_TYPES_DATAVALUE]);
  70. if(binsize == 0)
  71. return false;
  72. /* Allocate buffer on the heap if necessary */
  73. if(binsize > UA_VALUENCODING_MAXSTACK &&
  74. UA_ByteString_allocBuffer(encoding, binsize) != UA_STATUSCODE_GOOD)
  75. return false;
  76. /* Encode the value */
  77. UA_Byte *bufPos = encoding->data;
  78. const UA_Byte *bufEnd = &encoding->data[encoding->length];
  79. UA_StatusCode retval = UA_encodeBinary(value, &UA_TYPES[UA_TYPES_DATAVALUE],
  80. &bufPos, &bufEnd, NULL, NULL);
  81. if(retval != UA_STATUSCODE_GOOD)
  82. return false;
  83. /* The value has changed */
  84. encoding->length = (uintptr_t)bufPos - (uintptr_t)encoding->data;
  85. return !mon->lastSampledValue.data || !UA_String_equal(encoding, &mon->lastSampledValue);
  86. }
  87. /* Has this sample changed from the last one? The method may allocate additional
  88. * space for the encoding buffer. Detect the change in encoding->data. */
  89. static UA_Boolean
  90. detectValueChange(UA_MonitoredItem *mon, UA_DataValue *value, UA_ByteString *encoding) {
  91. /* Apply Filter */
  92. UA_Boolean hasValue = value->hasValue;
  93. if(mon->trigger == UA_DATACHANGETRIGGER_STATUS)
  94. value->hasValue = false;
  95. UA_Boolean hasServerTimestamp = value->hasServerTimestamp;
  96. UA_Boolean hasServerPicoseconds = value->hasServerPicoseconds;
  97. value->hasServerTimestamp = false;
  98. value->hasServerPicoseconds = false;
  99. UA_Boolean hasSourceTimestamp = value->hasSourceTimestamp;
  100. UA_Boolean hasSourcePicoseconds = value->hasSourcePicoseconds;
  101. if(mon->trigger < UA_DATACHANGETRIGGER_STATUSVALUETIMESTAMP) {
  102. value->hasSourceTimestamp = false;
  103. value->hasSourcePicoseconds = false;
  104. }
  105. /* Detect the Value Change */
  106. UA_Boolean res = detectValueChangeWithFilter(mon, value, encoding);
  107. /* Reset the filter */
  108. value->hasValue = hasValue;
  109. value->hasServerTimestamp = hasServerTimestamp;
  110. value->hasServerPicoseconds = hasServerPicoseconds;
  111. value->hasSourceTimestamp = hasSourceTimestamp;
  112. value->hasSourcePicoseconds = hasSourcePicoseconds;
  113. return res;
  114. }
  115. /* Returns whether a new sample was created */
  116. static UA_Boolean
  117. sampleCallbackWithValue(UA_Server *server, UA_Subscription *sub,
  118. UA_MonitoredItem *monitoredItem,
  119. UA_DataValue *value,
  120. UA_ByteString *valueEncoding) {
  121. /* Store the pointer to the stack-allocated bytestring to see if a heap-allocation
  122. * was necessary */
  123. UA_Byte *stackValueEncoding = valueEncoding->data;
  124. /* Has the value changed? */
  125. UA_Boolean changed = detectValueChange(monitoredItem, value, valueEncoding);
  126. if(!changed)
  127. return false;
  128. /* Allocate the entry for the publish queue */
  129. MonitoredItem_queuedValue *newQueueItem =
  130. (MonitoredItem_queuedValue *)UA_malloc(sizeof(MonitoredItem_queuedValue));
  131. if(!newQueueItem) {
  132. UA_LOG_WARNING_SESSION(server->config.logger, sub->session,
  133. "Subscription %u | MonitoredItem %i | "
  134. "Item for the publishing queue could not be allocated",
  135. sub->subscriptionID, monitoredItem->itemId);
  136. return false;
  137. }
  138. /* Copy valueEncoding on the heap for the next comparison (if not already done) */
  139. if(valueEncoding->data == stackValueEncoding) {
  140. UA_ByteString cbs;
  141. if(UA_ByteString_copy(valueEncoding, &cbs) != UA_STATUSCODE_GOOD) {
  142. UA_LOG_WARNING_SESSION(server->config.logger, sub->session,
  143. "Subscription %u | MonitoredItem %i | "
  144. "ByteString to compare values could not be created",
  145. sub->subscriptionID, monitoredItem->itemId);
  146. UA_free(newQueueItem);
  147. return false;
  148. }
  149. *valueEncoding = cbs;
  150. }
  151. /* Prepare the newQueueItem */
  152. if(value->hasValue && value->value.storageType == UA_VARIANT_DATA_NODELETE) {
  153. /* Make a deep copy of the value */
  154. if(UA_DataValue_copy(value, &newQueueItem->value) != UA_STATUSCODE_GOOD) {
  155. UA_LOG_WARNING_SESSION(server->config.logger, sub->session,
  156. "Subscription %u | MonitoredItem %i | "
  157. "Item for the publishing queue could not be prepared",
  158. sub->subscriptionID, monitoredItem->itemId);
  159. UA_free(newQueueItem);
  160. return false;
  161. }
  162. } else {
  163. newQueueItem->value = *value; /* Just copy the value and do not release it */
  164. }
  165. newQueueItem->clientHandle = monitoredItem->clientHandle;
  166. /* <-- Point of no return --> */
  167. UA_LOG_DEBUG_SESSION(server->config.logger, sub->session,
  168. "Subscription %u | MonitoredItem %u | Sampled a new value",
  169. sub->subscriptionID, monitoredItem->itemId);
  170. /* Replace the encoding for comparison */
  171. UA_ByteString_deleteMembers(&monitoredItem->lastSampledValue);
  172. monitoredItem->lastSampledValue = *valueEncoding;
  173. /* Add the sample to the queue for publication */
  174. ensureSpaceInMonitoredItemQueue(monitoredItem);
  175. TAILQ_INSERT_TAIL(&monitoredItem->queue, newQueueItem, listEntry);
  176. ++monitoredItem->currentQueueSize;
  177. return true;;
  178. }
  179. void
  180. UA_MoniteredItem_SampleCallback(UA_Server *server,
  181. UA_MonitoredItem *monitoredItem) {
  182. UA_Subscription *sub = monitoredItem->subscription;
  183. if(monitoredItem->monitoredItemType != UA_MONITOREDITEMTYPE_CHANGENOTIFY) {
  184. UA_LOG_DEBUG_SESSION(server->config.logger, sub->session,
  185. "Subscription %u | MonitoredItem %i | "
  186. "Not a data change notification",
  187. sub->subscriptionID, monitoredItem->itemId);
  188. return;
  189. }
  190. /* Read the value */
  191. UA_ReadValueId rvid;
  192. UA_ReadValueId_init(&rvid);
  193. rvid.nodeId = monitoredItem->monitoredNodeId;
  194. rvid.attributeId = monitoredItem->attributeID;
  195. rvid.indexRange = monitoredItem->indexRange;
  196. UA_DataValue value;
  197. UA_DataValue_init(&value);
  198. Service_Read_single(server, sub->session, monitoredItem->timestampsToReturn,
  199. &rvid, &value);
  200. /* Stack-allocate some memory for the value encoding. We might heap-allocate
  201. * more memory if needed. This is just enough for scalars and small
  202. * structures. */
  203. UA_Byte *stackValueEncoding = (UA_Byte *)UA_alloca(UA_VALUENCODING_MAXSTACK);
  204. UA_ByteString valueEncoding;
  205. valueEncoding.data = stackValueEncoding;
  206. valueEncoding.length = UA_VALUENCODING_MAXSTACK;
  207. /* Create a sample and compare with the last value */
  208. UA_Boolean newNotification = sampleCallbackWithValue(server, sub, monitoredItem,
  209. &value, &valueEncoding);
  210. /* Clean up */
  211. if(!newNotification) {
  212. if(valueEncoding.data != stackValueEncoding)
  213. UA_ByteString_deleteMembers(&valueEncoding);
  214. UA_DataValue_deleteMembers(&value);
  215. }
  216. }
  217. UA_StatusCode
  218. MonitoredItem_registerSampleCallback(UA_Server *server, UA_MonitoredItem *mon) {
  219. UA_StatusCode retval =
  220. UA_Server_addRepeatedCallback(server, (UA_ServerCallback)UA_MoniteredItem_SampleCallback,
  221. mon, (UA_UInt32)mon->samplingInterval, &mon->sampleCallbackId);
  222. if(retval == UA_STATUSCODE_GOOD)
  223. mon->sampleCallbackIsRegistered = true;
  224. return retval;
  225. }
  226. UA_StatusCode
  227. MonitoredItem_unregisterSampleCallback(UA_Server *server, UA_MonitoredItem *mon) {
  228. if(!mon->sampleCallbackIsRegistered)
  229. return UA_STATUSCODE_GOOD;
  230. mon->sampleCallbackIsRegistered = false;
  231. return UA_Server_removeRepeatedCallback(server, mon->sampleCallbackId);
  232. }
  233. /****************/
  234. /* Subscription */
  235. /****************/
  236. UA_Subscription *
  237. UA_Subscription_new(UA_Session *session, UA_UInt32 subscriptionID) {
  238. /* Allocate the memory */
  239. UA_Subscription *newItem =
  240. (UA_Subscription*)UA_calloc(1, sizeof(UA_Subscription));
  241. if(!newItem)
  242. return NULL;
  243. /* Remaining members are covered by calloc zeroing out the memory */
  244. newItem->session = session;
  245. newItem->subscriptionID = subscriptionID;
  246. newItem->state = UA_SUBSCRIPTIONSTATE_NORMAL; /* The first publish response is sent immediately */
  247. TAILQ_INIT(&newItem->retransmissionQueue);
  248. return newItem;
  249. }
  250. void
  251. UA_Subscription_deleteMembers(UA_Subscription *subscription, UA_Server *server) {
  252. Subscription_unregisterPublishCallback(server, subscription);
  253. /* Delete monitored Items */
  254. UA_MonitoredItem *mon, *tmp_mon;
  255. LIST_FOREACH_SAFE(mon, &subscription->monitoredItems, listEntry, tmp_mon) {
  256. LIST_REMOVE(mon, listEntry);
  257. MonitoredItem_delete(server, mon);
  258. }
  259. /* Delete Retransmission Queue */
  260. UA_NotificationMessageEntry *nme, *nme_tmp;
  261. TAILQ_FOREACH_SAFE(nme, &subscription->retransmissionQueue, listEntry, nme_tmp) {
  262. TAILQ_REMOVE(&subscription->retransmissionQueue, nme, listEntry);
  263. UA_NotificationMessage_deleteMembers(&nme->message);
  264. UA_free(nme);
  265. }
  266. subscription->retransmissionQueueSize = 0;
  267. }
  268. UA_MonitoredItem *
  269. UA_Subscription_getMonitoredItem(UA_Subscription *sub,
  270. UA_UInt32 monitoredItemID) {
  271. UA_MonitoredItem *mon;
  272. LIST_FOREACH(mon, &sub->monitoredItems, listEntry) {
  273. if(mon->itemId == monitoredItemID)
  274. break;
  275. }
  276. return mon;
  277. }
  278. UA_StatusCode
  279. UA_Subscription_deleteMonitoredItem(UA_Server *server, UA_Subscription *sub,
  280. UA_UInt32 monitoredItemID) {
  281. UA_MonitoredItem *mon;
  282. LIST_FOREACH(mon, &sub->monitoredItems, listEntry) {
  283. if(mon->itemId == monitoredItemID) {
  284. LIST_REMOVE(mon, listEntry);
  285. MonitoredItem_delete(server, mon);
  286. return UA_STATUSCODE_GOOD;
  287. }
  288. }
  289. return UA_STATUSCODE_BADMONITOREDITEMIDINVALID;
  290. }
  291. static size_t
  292. countQueuedNotifications(UA_Subscription *sub,
  293. UA_Boolean *moreNotifications) {
  294. if(!sub->publishingEnabled)
  295. return 0;
  296. size_t notifications = 0;
  297. UA_MonitoredItem *mon;
  298. LIST_FOREACH(mon, &sub->monitoredItems, listEntry) {
  299. MonitoredItem_queuedValue *qv;
  300. TAILQ_FOREACH(qv, &mon->queue, listEntry) {
  301. if(notifications >= sub->notificationsPerPublish) {
  302. *moreNotifications = true;
  303. break;
  304. }
  305. ++notifications;
  306. }
  307. }
  308. return notifications;
  309. }
  310. static void
  311. UA_Subscription_addRetransmissionMessage(UA_Server *server, UA_Subscription *sub,
  312. UA_NotificationMessageEntry *entry) {
  313. /* Release the oldest entry if there is not enough space */
  314. if(server->config.maxRetransmissionQueueSize > 0 &&
  315. sub->retransmissionQueueSize >= server->config.maxRetransmissionQueueSize) {
  316. UA_NotificationMessageEntry *lastentry =
  317. TAILQ_LAST(&sub->retransmissionQueue, ListOfNotificationMessages);
  318. TAILQ_REMOVE(&sub->retransmissionQueue, lastentry, listEntry);
  319. --sub->retransmissionQueueSize;
  320. UA_NotificationMessage_deleteMembers(&lastentry->message);
  321. UA_free(lastentry);
  322. }
  323. /* Add entry */
  324. TAILQ_INSERT_HEAD(&sub->retransmissionQueue, entry, listEntry);
  325. ++sub->retransmissionQueueSize;
  326. }
  327. UA_StatusCode
  328. UA_Subscription_removeRetransmissionMessage(UA_Subscription *sub,
  329. UA_UInt32 sequenceNumber) {
  330. UA_NotificationMessageEntry *entry, *entry_tmp;
  331. TAILQ_FOREACH_SAFE(entry, &sub->retransmissionQueue, listEntry, entry_tmp) {
  332. if(entry->message.sequenceNumber != sequenceNumber)
  333. continue;
  334. TAILQ_REMOVE(&sub->retransmissionQueue, entry, listEntry);
  335. --sub->retransmissionQueueSize;
  336. UA_NotificationMessage_deleteMembers(&entry->message);
  337. UA_free(entry);
  338. return UA_STATUSCODE_GOOD;
  339. }
  340. return UA_STATUSCODE_BADSEQUENCENUMBERUNKNOWN;
  341. }
  342. static UA_StatusCode
  343. prepareNotificationMessage(UA_Subscription *sub,
  344. UA_NotificationMessage *message,
  345. size_t notifications) {
  346. /* Array of ExtensionObject to hold different kinds of notifications
  347. (currently only DataChangeNotifications) */
  348. message->notificationData = UA_ExtensionObject_new();
  349. if(!message->notificationData)
  350. return UA_STATUSCODE_BADOUTOFMEMORY;
  351. message->notificationDataSize = 1;
  352. /* Allocate Notification */
  353. UA_DataChangeNotification *dcn = UA_DataChangeNotification_new();
  354. if(!dcn) {
  355. UA_NotificationMessage_deleteMembers(message);
  356. return UA_STATUSCODE_BADOUTOFMEMORY;
  357. }
  358. UA_ExtensionObject *data = message->notificationData;
  359. data->encoding = UA_EXTENSIONOBJECT_DECODED;
  360. data->content.decoded.data = dcn;
  361. data->content.decoded.type = &UA_TYPES[UA_TYPES_DATACHANGENOTIFICATION];
  362. /* Allocate array of notifications */
  363. dcn->monitoredItems = (UA_MonitoredItemNotification *)
  364. UA_Array_new(notifications, &UA_TYPES[UA_TYPES_MONITOREDITEMNOTIFICATION]);
  365. if(!dcn->monitoredItems) {
  366. UA_NotificationMessage_deleteMembers(message);
  367. return UA_STATUSCODE_BADOUTOFMEMORY;
  368. }
  369. dcn->monitoredItemsSize = notifications;
  370. /* Move notifications into the response .. the point of no return */
  371. size_t l = 0;
  372. UA_MonitoredItem *mon;
  373. LIST_FOREACH(mon, &sub->monitoredItems, listEntry) {
  374. MonitoredItem_queuedValue *qv, *qv_tmp;
  375. TAILQ_FOREACH_SAFE(qv, &mon->queue, listEntry, qv_tmp) {
  376. if(l >= notifications)
  377. return UA_STATUSCODE_GOOD;
  378. UA_MonitoredItemNotification *min = &dcn->monitoredItems[l];
  379. min->clientHandle = qv->clientHandle;
  380. min->value = qv->value;
  381. TAILQ_REMOVE(&mon->queue, qv, listEntry);
  382. UA_free(qv);
  383. --mon->currentQueueSize;
  384. ++l;
  385. }
  386. }
  387. return UA_STATUSCODE_GOOD;
  388. }
  389. void
  390. UA_Subscription_publishCallback(UA_Server *server, UA_Subscription *sub) {
  391. UA_LOG_DEBUG_SESSION(server->config.logger, sub->session,
  392. "Subscription %u | Publish Callback",
  393. sub->subscriptionID);
  394. /* Count the available notifications */
  395. UA_Boolean moreNotifications = false;
  396. size_t notifications = countQueuedNotifications(sub, &moreNotifications);
  397. /* Return if nothing to do */
  398. if(notifications == 0) {
  399. ++sub->currentKeepAliveCount;
  400. if(sub->currentKeepAliveCount < sub->maxKeepAliveCount)
  401. return;
  402. UA_LOG_DEBUG_SESSION(server->config.logger, sub->session,
  403. "Subscription %u | Sending a KeepAlive",
  404. sub->subscriptionID)
  405. }
  406. /* Check if the securechannel is valid */
  407. UA_SecureChannel *channel = sub->session->channel;
  408. if(!channel)
  409. return;
  410. /* Dequeue a response */
  411. UA_PublishResponseEntry *pre = SIMPLEQ_FIRST(&sub->session->responseQueue);
  412. /* Cannot publish without a response */
  413. if(!pre) {
  414. UA_LOG_DEBUG_SESSION(server->config.logger, sub->session,
  415. "Subscription %u | Cannot send a publish response "
  416. "since the publish queue is empty", sub->subscriptionID)
  417. if(sub->state != UA_SUBSCRIPTIONSTATE_LATE) {
  418. sub->state = UA_SUBSCRIPTIONSTATE_LATE;
  419. } else {
  420. ++sub->currentLifetimeCount;
  421. if(sub->currentLifetimeCount > sub->lifeTimeCount) {
  422. UA_LOG_DEBUG_SESSION(server->config.logger, sub->session,
  423. "Subscription %u | End of lifetime for subscription",
  424. sub->subscriptionID);
  425. UA_Session_deleteSubscription(server, sub->session, sub->subscriptionID);
  426. }
  427. }
  428. return;
  429. }
  430. UA_PublishResponse *response = &pre->response;
  431. UA_NotificationMessage *message = &response->notificationMessage;
  432. UA_NotificationMessageEntry *retransmission = NULL;
  433. if(notifications > 0) {
  434. /* Allocate the retransmission entry */
  435. retransmission =
  436. (UA_NotificationMessageEntry*)UA_malloc(sizeof(UA_NotificationMessageEntry));
  437. if(!retransmission) {
  438. UA_LOG_WARNING_SESSION(server->config.logger, sub->session,
  439. "Subscription %u | Could not allocate memory "
  440. "for retransmission", sub->subscriptionID);
  441. return;
  442. }
  443. /* Prepare the response */
  444. UA_StatusCode retval =
  445. prepareNotificationMessage(sub, message, notifications);
  446. if(retval != UA_STATUSCODE_GOOD) {
  447. UA_LOG_WARNING_SESSION(server->config.logger, sub->session,
  448. "Subscription %u | Could not prepare the "
  449. "notification message", sub->subscriptionID);
  450. UA_free(retransmission);
  451. return;
  452. }
  453. }
  454. /* <-- The point of no return --> */
  455. /* Remove the response from the response queue */
  456. SIMPLEQ_REMOVE_HEAD(&sub->session->responseQueue, listEntry);
  457. /* Set up the response */
  458. response->responseHeader.timestamp = UA_DateTime_now();
  459. response->subscriptionId = sub->subscriptionID;
  460. response->moreNotifications = moreNotifications;
  461. message->publishTime = response->responseHeader.timestamp;
  462. if(notifications == 0) {
  463. /* Send sequence number for the next notification */
  464. message->sequenceNumber = sub->sequenceNumber + 1;
  465. } else {
  466. /* Increase the sequence number */
  467. message->sequenceNumber = ++sub->sequenceNumber;
  468. /* Put the notification message into the retransmission queue. This needs to
  469. * be done here, so that the message itself is included in the available
  470. * sequence numbers for acknowledgement. */
  471. retransmission->message = response->notificationMessage;
  472. UA_Subscription_addRetransmissionMessage(server, sub, retransmission);
  473. }
  474. /* Get the available sequence numbers from the retransmission queue */
  475. size_t available = sub->retransmissionQueueSize;
  476. if(available > 0) {
  477. response->availableSequenceNumbers =
  478. (UA_UInt32*)UA_alloca(available * sizeof(UA_UInt32));
  479. response->availableSequenceNumbersSize = available;
  480. size_t i = 0;
  481. UA_NotificationMessageEntry *nme;
  482. TAILQ_FOREACH(nme, &sub->retransmissionQueue, listEntry) {
  483. response->availableSequenceNumbers[i] = nme->message.sequenceNumber;
  484. ++i;
  485. }
  486. }
  487. /* Send the response */
  488. UA_LOG_DEBUG_SESSION(server->config.logger, sub->session,
  489. "Subscription %u | Sending out a publish response with %u "
  490. "notifications", sub->subscriptionID, (UA_UInt32)notifications);
  491. UA_SecureChannel_sendBinaryMessage(sub->session->channel, pre->requestId, response,
  492. &UA_TYPES[UA_TYPES_PUBLISHRESPONSE]);
  493. /* Reset subscription state to normal. */
  494. sub->state = UA_SUBSCRIPTIONSTATE_NORMAL;
  495. sub->currentKeepAliveCount = 0;
  496. sub->currentLifetimeCount = 0;
  497. /* Free the response */
  498. UA_Array_delete(response->results, response->resultsSize,
  499. &UA_TYPES[UA_TYPES_UINT32]);
  500. UA_free(pre); /* no need for UA_PublishResponse_deleteMembers */
  501. /* Repeat if there are more notifications to send */
  502. if(moreNotifications)
  503. UA_Subscription_publishCallback(server, sub);
  504. }
  505. UA_StatusCode
  506. Subscription_registerPublishCallback(UA_Server *server, UA_Subscription *sub) {
  507. if(sub->publishCallbackIsRegistered)
  508. return UA_STATUSCODE_GOOD;
  509. UA_LOG_DEBUG_SESSION(server->config.logger, sub->session,
  510. "Subscription %u | Register subscription publishing callback",
  511. sub->subscriptionID);
  512. UA_StatusCode retval =
  513. UA_Server_addRepeatedCallback(server,
  514. (UA_ServerCallback)UA_Subscription_publishCallback,
  515. sub, (UA_UInt32)sub->publishingInterval,
  516. &sub->publishCallbackId);
  517. if(retval == UA_STATUSCODE_GOOD)
  518. sub->publishCallbackIsRegistered = true;
  519. return retval;
  520. }
  521. UA_StatusCode
  522. Subscription_unregisterPublishCallback(UA_Server *server, UA_Subscription *sub) {
  523. if(!sub->publishCallbackIsRegistered)
  524. return UA_STATUSCODE_GOOD;
  525. UA_LOG_DEBUG_SESSION(server->config.logger, sub->session,
  526. "Subscription %u | Unregister subscription "
  527. "publishing callback", sub->subscriptionID);
  528. sub->publishCallbackIsRegistered = false;
  529. return UA_Server_removeRepeatedCallback(server, sub->publishCallbackId);
  530. }
  531. /* When the session has publish requests stored but the last subscription is
  532. deleted... Send out empty responses */
  533. void
  534. UA_Subscription_answerPublishRequestsNoSubscription(UA_Server *server,
  535. UA_NodeId *sessionToken) {
  536. /* Get session */
  537. UA_Session *session =
  538. UA_SessionManager_getSession(&server->sessionManager, sessionToken);
  539. UA_NodeId_delete(sessionToken);
  540. /* No session or there are remaining subscriptions */
  541. if(!session || LIST_FIRST(&session->serverSubscriptions))
  542. return;
  543. /* Send a response for every queued request */
  544. UA_PublishResponseEntry *pre;
  545. while((pre = SIMPLEQ_FIRST(&session->responseQueue))) {
  546. SIMPLEQ_REMOVE_HEAD(&session->responseQueue, listEntry);
  547. UA_PublishResponse *response = &pre->response;
  548. response->responseHeader.serviceResult = UA_STATUSCODE_BADNOSUBSCRIPTION;
  549. response->responseHeader.timestamp = UA_DateTime_now();
  550. UA_SecureChannel_sendBinaryMessage(session->channel, pre->requestId, response,
  551. &UA_TYPES[UA_TYPES_PUBLISHRESPONSE]);
  552. UA_PublishResponse_deleteMembers(response);
  553. UA_free(pre);
  554. }
  555. }
  556. #endif /* UA_ENABLE_SUBSCRIPTIONS */