diff options
| author | YAMAMOTO Takashi <yamamoto@valinux.co.jp> | 2014-06-18 11:37:06 +0900 |
|---|---|---|
| committer | FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp> | 2014-06-18 12:13:14 +0900 |
| commit | a2fc54bd797e09649d82b78c84aea2bb35f746a7 (patch) | |
| tree | 5f689eb1c91f61c0df6c180285bb6fd6eb1fcd7b /doc/source/app | |
| parent | e1f9e1e0a7c3c764ad38c414461fb56d01dde538 (diff) | |
document ryu.app.ofctl
Signed-off-by: YAMAMOTO Takashi <yamamoto@valinux.co.jp>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
Diffstat (limited to 'doc/source/app')
| -rw-r--r-- | doc/source/app/ofctl.rst | 30 |
1 files changed, 30 insertions, 0 deletions
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: |