document ryu.app.ofctl

Signed-off-by: YAMAMOTO Takashi <yamamoto@valinux.co.jp>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>

3 files changed, 43 insertions, 0 deletions

diff --git a/doc/source/app.rst b/doc/source/app.rst
new file mode 100644
index 00000000..c20b0bf0
--- /dev/null
+++ b/doc/source/app.rst
@@ -0,0 +1,12 @@
+*************************
+Built-in Ryu applications
+*************************
+
+Ryu has some built-in Ryu applications.
+Some of them are examples.
+Others provide some functionalities to other Ryu applications.
+
+.. toctree::
+   :maxdepth: 1
+
+   app/ofctl.rst
diff --git a/doc/source/app/ofctl.rst b/doc/source/app/ofctl.rst
new file mode 100644
index 00000000..b293f342
--- /dev/null
+++ b/doc/source/app/ofctl.rst
@@ -0,0 +1,30 @@
+*************
+ryu.app.ofctl
+*************
+
+ryu.app.ofctl provides a convenient way to use OpenFlow messages
+synchronously.
+
+OfctlService ryu application is automatically loaded if your
+Ryu application imports ofctl.api module.
+
+Example::
+
+    import ryu.app.ofctl.api
+
+OfctlService application internally uses OpenFlow barrier messages
+to ensure message boundaries.  As OpenFlow messages are asynchronous
+and some of messages does not have any replies on success, barriers
+are necessary for correct error handling.
+
+api module
+==========
+
+.. automodule:: ryu.app.ofctl.api
+   :members:
+
+exceptions
+==========
+
+.. automodule:: ryu.app.ofctl.exception
+   :members:
diff --git a/doc/source/index.rst b/doc/source/index.rst
index c9a0cb46..cfe256b8 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -17,6 +17,7 @@ Contents:
    configuration.rst
    tests.rst
    using_with_openstack.rst
+   app.rst
 
 Indices and tables
 ==================