ryu/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 ryu.ofproto.ofproto_v1_5
  78 ------------------------
  79 .. automodule:: ryu.ofproto.ofproto_v1_5
  80
  81 ryu.ofproto.ofproto_v1_5_parser
  82 -------------------------------
  83 .. automodule:: ryu.ofproto.ofproto_v1_5_parser
  84
  85
  86 Ryu applications
  87 ================
  88
  89 ryu.app.cbench
  90 --------------
  91 .. automodule:: ryu.app.cbench
  92
  93 ryu.app.simple_switch
  94 ---------------------
  95 .. automodule:: ryu.app.simple_switch
  96
  97 ryu.topology
  98 ------------
  99 .. automodule:: ryu.topology
 100
 101
 102 Libraries
 103 =========
 104
 105 ryu.lib.packet
 106 --------------
 107 .. automodule:: ryu.lib.packet
 108
 109 ryu.lib.ovs
 110 -----------
 111 .. automodule:: ryu.lib.ovs
 112
 113 ryu.lib.of_config
 114 -----------------
 115 .. automodule:: ryu.lib.of_config
 116
 117 ryu.lib.netconf
 118 ---------------
 119 .. automodule:: ryu.lib.netconf
 120
 121 ryu.lib.xflow
 122 -------------
 123 .. automodule:: ryu.lib.xflow
 124
 125
 126 Third party libraries
 127 =====================
 128
 129 ryu.contrib.ovs
 130 ---------------
 131
 132 Open vSwitch python binding. Used by ryu.lib.ovs.
 133
 134 ryu.contrib.oslo.config
 135 -----------------------
 136
 137 Oslo configuration library. Used for ryu-manager's command-line options
 138 and configuration files.
 139
 140 ryu.contrib.ncclient
 141 --------------------
 142
 143 Python library for NETCONF client. Used by ryu.lib.of_config.
 144