diff options
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: |