summaryrefslogtreecommitdiffhomepage
path: root/doc/source/app/ofctl.rst
blob: b293f3421803efc6eac0a896caa6a85b905c4d47 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
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: