ryu/doc/source/app/ofctl.rst

   1 *************
   2 ryu.app.ofctl
   3 *************
   4
   5 ryu.app.ofctl provides a convenient way to use OpenFlow messages
   6 synchronously.
   7
   8 OfctlService ryu application is automatically loaded if your
   9 Ryu application imports ofctl.api module.
  10
  11 Example::
  12
  13     import ryu.app.ofctl.api
  14
  15 OfctlService application internally uses OpenFlow barrier messages
  16 to ensure message boundaries.  As OpenFlow messages are asynchronous
  17 and some of messages does not have any replies on success, barriers
  18 are necessary for correct error handling.
  19
  20 api module
  21 ==========
  22
  23 .. automodule:: ryu.app.ofctl.api
  24    :members:
  25
  26 exceptions
  27 ==========
  28
  29 .. automodule:: ryu.app.ofctl.exception
  30    :members: