summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorDavanum Srinivas <davanum@gmail.com>2015-09-24 11:20:35 -0400
committerDavanum Srinivas <davanum@gmail.com>2015-09-25 10:07:05 -0400
commit1893c495f6e9ba53c7d93ad99f679f44f66837ef (patch)
tree84e35e20b9c28c95137f235a50a2ea61c75a12ec /doc
parentb1af9c25c2850af066846477a4f300ec3cfe828c (diff)
downloadoslo-messaging-1893c495f6e9ba53c7d93ad99f679f44f66837ef.tar.gz
Allow custom notification drivers
Our class hierarchy hides classes and modules that so its hard for folks to write a custom Notification driver. We should make these public and document them Closes-Bug: #1426046 Change-Id: Ifb96c2ae9868426cac2700bf4917c27c02c90b15
Diffstat (limited to 'doc')
-rw-r--r--doc/source/index.rst1
-rw-r--r--doc/source/notification_driver.rst15
2 files changed, 16 insertions, 0 deletions
diff --git a/doc/source/index.rst b/doc/source/index.rst
index 5aa0b47..5f45af8 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -16,6 +16,7 @@ Contents
server
rpcclient
notifier
+ notification_driver
notification_listener
serializer
exceptions
diff --git a/doc/source/notification_driver.rst b/doc/source/notification_driver.rst
new file mode 100644
index 0000000..d7368d8
--- /dev/null
+++ b/doc/source/notification_driver.rst
@@ -0,0 +1,15 @@
+-------------------
+Notification Driver
+-------------------
+
+.. automodule:: oslo_messaging.notify.messaging
+
+.. autoclass:: MessagingDriver
+
+.. autoclass:: MessagingV2Driver
+
+.. currentmodule:: oslo_messaging.notify.notifier
+
+.. autoclass:: Driver
+ :members:
+ :noindex: