← Back to branch summary

~ubuntu-branches/ubuntu/wily/ryu/wily-proposed

« back to all changes in this revision

Viewing changes to doc/source/components.rst

  • Committer: Package Import Robot
  • Author(s): Dariusz Dwornikowski
  • Date: 2014-08-18 16:58:52 UTC
  • Revision ID: package-import@ubuntu.com-20140818165852-i0qck3g5mw7rtxt0
Tags: upstream-3.12
Import upstream version 3.12

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/source/components.rst
 
1
*****************
 
2
Components of Ryu
 
3
*****************
 
4
 
 
5
Executables
 
6
===========
 
7
 
 
8
bin/ryu-manager
 
9
---------------
 
10
 
 
11
The main executable.
 
12
 
 
13
 
 
14
Base components
 
15
===============
 
16
 
 
17
ryu.base.app_manager
 
18
--------------------
 
19
.. automodule:: ryu.base.app_manager
 
20
 
 
21
 
 
22
OpenFlow controller
 
23
===================
 
24
 
 
25
ryu.controller.controller
 
26
-------------------------
 
27
.. automodule:: ryu.controller.controller
 
28
 
 
29
ryu.controller.dpset
 
30
--------------------
 
31
.. automodule:: ryu.controller.dpset
 
32
 
 
33
ryu.controller.ofp_event
 
34
------------------------
 
35
.. automodule:: ryu.controller.ofp_event
 
36
 
 
37
ryu.controller.ofp_handler
 
38
--------------------------
 
39
.. automodule:: ryu.controller.ofp_handler
 
40
 
 
41
 
 
42
OpenFlow wire protocol encoder and decoder
 
43
==========================================
 
44
 
 
45
ryu.ofproto.ofproto_v1_0
 
46
------------------------
 
47
.. automodule:: ryu.ofproto.ofproto_v1_0
 
48
 
 
49
ryu.ofproto.ofproto_v1_0_parser
 
50
-------------------------------
 
51
.. automodule:: ryu.ofproto.ofproto_v1_0_parser
 
52
 
 
53
ryu.ofproto.ofproto_v1_2
 
54
------------------------
 
55
.. automodule:: ryu.ofproto.ofproto_v1_2
 
56
 
 
57
ryu.ofproto.ofproto_v1_2_parser
 
58
-------------------------------
 
59
.. automodule:: ryu.ofproto.ofproto_v1_2_parser
 
60
 
 
61
ryu.ofproto.ofproto_v1_3
 
62
------------------------
 
63
.. automodule:: ryu.ofproto.ofproto_v1_3
 
64
 
 
65
ryu.ofproto.ofproto_v1_3_parser
 
66
-------------------------------
 
67
.. automodule:: ryu.ofproto.ofproto_v1_3_parser
 
68
 
 
69
ryu.ofproto.ofproto_v1_4
 
70
------------------------
 
71
.. automodule:: ryu.ofproto.ofproto_v1_4
 
72
 
 
73
ryu.ofproto.ofproto_v1_4_parser
 
74
-------------------------------
 
75
.. automodule:: ryu.ofproto.ofproto_v1_4_parser
 
76
 
 
77
 
 
78
Ryu applications
 
79
================
 
80
 
 
81
ryu.app.cbench
 
82
--------------
 
83
.. automodule:: ryu.app.cbench
 
84
 
 
85
ryu.app.simple_switch
 
86
---------------------
 
87
.. automodule:: ryu.app.simple_switch
 
88
 
 
89
ryu.app.simple_isolation
 
90
------------------------
 
91
.. automodule:: ryu.app.simple_isolation
 
92
 
 
93
ryu.app.simple_vlan
 
94
-------------------
 
95
.. automodule:: ryu.app.simple_vlan
 
96
 
 
97
ryu.app.gre_tunnel
 
98
------------------
 
99
.. automodule:: ryu.app.gre_tunnel
 
100
 
 
101
ryu.app.tunnel_port_updater
 
102
---------------------------
 
103
.. automodule:: ryu.app.tunnel_port_updater
 
104
 
 
105
ryu.app.quantum_adapter
 
106
-----------------------
 
107
.. automodule:: ryu.app.quantum_adapter
 
108
 
 
109
ryu.app.rest
 
110
------------
 
111
.. automodule:: ryu.app.rest
 
112
 
 
113
ryu.app.rest_conf_switch
 
114
------------------------
 
115
.. automodule:: ryu.app.rest_conf_switch
 
116
 
 
117
ryu.app.rest_quantum
 
118
--------------------
 
119
.. automodule:: ryu.app.rest_quantum
 
120
 
 
121
ryu.app.rest_tunnel
 
122
-------------------
 
123
.. automodule:: ryu.app.rest_tunnel
 
124
 
 
125
ryu.topology
 
126
------------
 
127
.. automodule:: ryu.topology
 
128
 
 
129
 
 
130
Libraries
 
131
=========
 
132
 
 
133
ryu.lib.packet
 
134
--------------
 
135
.. automodule:: ryu.lib.packet
 
136
 
 
137
ryu.lib.ovs
 
138
-----------
 
139
.. automodule:: ryu.lib.ovs
 
140
 
 
141
ryu.lib.of_config
 
142
-----------------
 
143
.. automodule:: ryu.lib.of_config
 
144
 
 
145
ryu.lib.netconf
 
146
---------------
 
147
.. automodule:: ryu.lib.netconf
 
148
 
 
149
ryu.lib.xflow
 
150
-------------
 
151
.. automodule:: ryu.lib.xflow
 
152
 
 
153
 
 
154
Third party libraries
 
155
=====================
 
156
 
 
157
ryu.contrib.ovs
 
158
---------------
 
159
 
 
160
Open vSwitch python binding. Used by ryu.lib.ovs.
 
161
 
 
162
ryu.contrib.oslo.config
 
163
-----------------------
 
164
 
 
165
Oslo configuration library. Used for ryu-manager's command-line options
 
166
and configuration files.
 
167
 
 
168
ryu.contrib.ncclient
 
169
--------------------
 
170
 
 
171
Python library for NETCONF client. Used by ryu.lib.of_config.
 
172