From: Thierry FOURNIER <thierry.fournier@ozon.io>
Date: Sun, 10 Dec 2017 16:14:07 +0000 (+0100)
Subject: DOC: notifications: add precisions about thread usage
X-Git-Tag: v1.9-dev1~596
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=d5b79835f8095cce3bb3f32374b571af46973112;p=thirdparty%2Fhaproxy.git

DOC: notifications: add precisions about thread usage

Precise the terms of use the notification functions.
---

diff --git a/include/proto/task.h b/include/proto/task.h
index 429148244e..1422bf2428 100644
--- a/include/proto/task.h
+++ b/include/proto/task.h
@@ -304,6 +304,9 @@ static inline struct notification *notification_new(struct list *purge, struct l
 /* This function purge all the pending signals when the LUA execution
  * is finished. This prevent than a coprocess try to wake a deleted
  * task. This function remove the memory associated to the signal.
+ * The purge list is not locked because it is owned by only one
+ * process. before browsing this list, the caller must ensure to be
+ * the only one browser.
  */
 static inline void notification_purge(struct list *purge)
 {
@@ -325,7 +328,9 @@ static inline void notification_purge(struct list *purge)
 
 /* This function sends signals. It wakes all the tasks attached
  * to a list head, and remove the signal, and free the used
- * memory.
+ * memory. The wake list is not locked because it is owned by
+ * only one process. before browsing this list, the caller must
+ * ensure to be the only one browser.
  */
 static inline void notification_wake(struct list *wake)
 {