Merge pull request #177 from zhmcclient/andy/notifications-experimental

Updated change log; Declared NotificationReceiver as experimental
zhmcclient · Feb 1, 2017 · 587ee2e · 587ee2e
2 parents 1fc5f89 + 4a60979
commit 587ee2e
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 0 deletions.
diff --git a/docs/changes.rst b/docs/changes.rst
@@ -64,6 +64,14 @@ Released: not yet
 * Documented the authorization requirements for each method, and in total
   in a new section "Setting up the HMC".
 
+* Added a method `open_os_message_channel()` on Partition and Lpar objects,
+  that returns a notification token for receiving operating system messages
+  as HMC notifications.
+
+* Experimental: Added a class `NotificationReceiver` that supports receiving
+  and iterating through HMC notificationsi for a notification token, e.g.
+  those produced by `open_os_message_channel()`.
+
 **Known Issues:**
 
 * See `list of open issues`_.

diff --git a/zhmcclient/_notification.py b/zhmcclient/_notification.py
@@ -80,6 +80,9 @@ class NotificationReceiver(object):
     A class for receiving HMC notifications that are published to a particular
     single HMC notification topic.
 
+    **Experimental:** This class is considered experimental at this point, and
+    its API may change incompatibly as long as it is experimental.
+
     Creating an object of this class establishes a JMS session with the
     HMC and subscribes for a particular HMC notification topic.