ua_subscription.c 24 KB

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