mirror of
https://github.com/zeek/zeek.git
synced 2025-10-03 23:28:20 +00:00
Remove broxygen Sphinx integration
The broxygen-generated files now live in the git repo, have tests that check that they are up-to-date, and a script to re-generate them on-demand.
This commit is contained in:
Jon Siwek
parent
9e5e9d04b7
commit
7e9d48f532
549 changed files with 89909 additions and 100 deletions
|
|
@ -0,0 +1,14 @@
|
|||
:tocdepth: 3
|
||||
|
||||
base/frameworks/openflow/plugins/__load__.bro
|
||||
=============================================
|
||||
|
||||
|
||||
:Imports: :doc:`base/frameworks/openflow/plugins/broker.bro </scripts/base/frameworks/openflow/plugins/broker.bro>`, :doc:`base/frameworks/openflow/plugins/log.bro </scripts/base/frameworks/openflow/plugins/log.bro>`, :doc:`base/frameworks/openflow/plugins/ryu.bro </scripts/base/frameworks/openflow/plugins/ryu.bro>`
|
||||
|
||||
Summary
|
||||
~~~~~~~
|
||||
|
||||
Detailed Interface
|
||||
~~~~~~~~~~~~~~~~~~
|
||||
|
||||
72
doc/scripts/base/frameworks/openflow/plugins/broker.bro.rst
Normal file
72
doc/scripts/base/frameworks/openflow/plugins/broker.bro.rst
Normal file
|
|
@ -0,0 +1,72 @@
|
|||
:tocdepth: 3
|
||||
|
||||
base/frameworks/openflow/plugins/broker.bro
|
||||
===========================================
|
||||
.. bro:namespace:: OpenFlow
|
||||
|
||||
OpenFlow plugin for interfacing to controllers via Broker.
|
||||
|
||||
:Namespace: OpenFlow
|
||||
:Imports: :doc:`base/frameworks/broker </scripts/base/frameworks/broker/index>`, :doc:`base/frameworks/openflow </scripts/base/frameworks/openflow/index>`
|
||||
|
||||
Summary
|
||||
~~~~~~~
|
||||
Redefinitions
|
||||
#############
|
||||
============================================================================ =
|
||||
:bro:type:`OpenFlow::ControllerState`: :bro:type:`record` :bro:attr:`&redef`
|
||||
:bro:type:`OpenFlow::Plugin`: :bro:type:`enum`
|
||||
============================================================================ =
|
||||
|
||||
Events
|
||||
######
|
||||
======================================================== =
|
||||
:bro:id:`OpenFlow::broker_flow_clear`: :bro:type:`event`
|
||||
:bro:id:`OpenFlow::broker_flow_mod`: :bro:type:`event`
|
||||
======================================================== =
|
||||
|
||||
Functions
|
||||
#########
|
||||
==================================================== ==============================
|
||||
:bro:id:`OpenFlow::broker_new`: :bro:type:`function` Broker controller constructor.
|
||||
==================================================== ==============================
|
||||
|
||||
|
||||
Detailed Interface
|
||||
~~~~~~~~~~~~~~~~~~
|
||||
Events
|
||||
######
|
||||
.. bro:id:: OpenFlow::broker_flow_clear
|
||||
|
||||
:Type: :bro:type:`event` (name: :bro:type:`string`, dpid: :bro:type:`count`)
|
||||
|
||||
|
||||
.. bro:id:: OpenFlow::broker_flow_mod
|
||||
|
||||
:Type: :bro:type:`event` (name: :bro:type:`string`, dpid: :bro:type:`count`, match: :bro:type:`OpenFlow::ofp_match`, flow_mod: :bro:type:`OpenFlow::ofp_flow_mod`)
|
||||
|
||||
|
||||
Functions
|
||||
#########
|
||||
.. bro:id:: OpenFlow::broker_new
|
||||
|
||||
:Type: :bro:type:`function` (name: :bro:type:`string`, host: :bro:type:`addr`, host_port: :bro:type:`port`, topic: :bro:type:`string`, dpid: :bro:type:`count`) : :bro:type:`OpenFlow::Controller`
|
||||
|
||||
Broker controller constructor.
|
||||
|
||||
|
||||
:host: Controller ip.
|
||||
|
||||
|
||||
:host_port: Controller listen port.
|
||||
|
||||
|
||||
:topic: Broker topic to send messages to.
|
||||
|
||||
|
||||
:dpid: OpenFlow switch datapath id.
|
||||
|
||||
|
||||
:returns: OpenFlow::Controller record.
|
||||
|
||||
|
||||
23
doc/scripts/base/frameworks/openflow/plugins/index.rst
Normal file
23
doc/scripts/base/frameworks/openflow/plugins/index.rst
Normal file
|
|
@ -0,0 +1,23 @@
|
|||
:orphan:
|
||||
|
||||
Package: base/frameworks/openflow/plugins
|
||||
=========================================
|
||||
|
||||
Plugins for the OpenFlow framework.
|
||||
|
||||
:doc:`/scripts/base/frameworks/openflow/plugins/__load__.bro`
|
||||
|
||||
|
||||
:doc:`/scripts/base/frameworks/openflow/plugins/ryu.bro`
|
||||
|
||||
OpenFlow plugin for the Ryu controller.
|
||||
|
||||
:doc:`/scripts/base/frameworks/openflow/plugins/log.bro`
|
||||
|
||||
OpenFlow plugin that outputs flow-modification commands
|
||||
to a Bro log file.
|
||||
|
||||
:doc:`/scripts/base/frameworks/openflow/plugins/broker.bro`
|
||||
|
||||
OpenFlow plugin for interfacing to controllers via Broker.
|
||||
|
||||
91
doc/scripts/base/frameworks/openflow/plugins/log.bro.rst
Normal file
91
doc/scripts/base/frameworks/openflow/plugins/log.bro.rst
Normal file
|
|
@ -0,0 +1,91 @@
|
|||
:tocdepth: 3
|
||||
|
||||
base/frameworks/openflow/plugins/log.bro
|
||||
========================================
|
||||
.. bro:namespace:: OpenFlow
|
||||
|
||||
OpenFlow plugin that outputs flow-modification commands
|
||||
to a Bro log file.
|
||||
|
||||
:Namespace: OpenFlow
|
||||
:Imports: :doc:`base/frameworks/logging </scripts/base/frameworks/logging/index>`, :doc:`base/frameworks/openflow </scripts/base/frameworks/openflow/index>`
|
||||
|
||||
Summary
|
||||
~~~~~~~
|
||||
Types
|
||||
#####
|
||||
============================================== =================================================================
|
||||
:bro:type:`OpenFlow::Info`: :bro:type:`record` The record type which contains column fields of the OpenFlow log.
|
||||
============================================== =================================================================
|
||||
|
||||
Redefinitions
|
||||
#############
|
||||
============================================================================ =
|
||||
:bro:type:`Log::ID`: :bro:type:`enum`
|
||||
:bro:type:`OpenFlow::ControllerState`: :bro:type:`record` :bro:attr:`&redef`
|
||||
:bro:type:`OpenFlow::Plugin`: :bro:type:`enum`
|
||||
============================================================================ =
|
||||
|
||||
Events
|
||||
######
|
||||
=================================================== ==================================================================
|
||||
:bro:id:`OpenFlow::log_openflow`: :bro:type:`event` Event that can be handled to access the :bro:type:`OpenFlow::Info`
|
||||
record as it is sent on to the logging framework.
|
||||
=================================================== ==================================================================
|
||||
|
||||
Functions
|
||||
#########
|
||||
================================================= ===========================
|
||||
:bro:id:`OpenFlow::log_new`: :bro:type:`function` Log controller constructor.
|
||||
================================================= ===========================
|
||||
|
||||
|
||||
Detailed Interface
|
||||
~~~~~~~~~~~~~~~~~~
|
||||
Types
|
||||
#####
|
||||
.. bro:type:: OpenFlow::Info
|
||||
|
||||
:Type: :bro:type:`record`
|
||||
|
||||
ts: :bro:type:`time` :bro:attr:`&log`
|
||||
Network time.
|
||||
|
||||
dpid: :bro:type:`count` :bro:attr:`&log`
|
||||
OpenFlow switch datapath id.
|
||||
|
||||
match: :bro:type:`OpenFlow::ofp_match` :bro:attr:`&log`
|
||||
OpenFlow match fields.
|
||||
|
||||
flow_mod: :bro:type:`OpenFlow::ofp_flow_mod` :bro:attr:`&log`
|
||||
OpenFlow modify flow entry message.
|
||||
|
||||
The record type which contains column fields of the OpenFlow log.
|
||||
|
||||
Events
|
||||
######
|
||||
.. bro:id:: OpenFlow::log_openflow
|
||||
|
||||
:Type: :bro:type:`event` (rec: :bro:type:`OpenFlow::Info`)
|
||||
|
||||
Event that can be handled to access the :bro:type:`OpenFlow::Info`
|
||||
record as it is sent on to the logging framework.
|
||||
|
||||
Functions
|
||||
#########
|
||||
.. bro:id:: OpenFlow::log_new
|
||||
|
||||
:Type: :bro:type:`function` (dpid: :bro:type:`count`, success_event: :bro:type:`bool` :bro:attr:`&default` = ``T`` :bro:attr:`&optional`) : :bro:type:`OpenFlow::Controller`
|
||||
|
||||
Log controller constructor.
|
||||
|
||||
|
||||
:dpid: OpenFlow switch datapath id.
|
||||
|
||||
|
||||
:success_event: If true, flow_mod_success is raised for each logged line.
|
||||
|
||||
|
||||
:returns: OpenFlow::Controller record.
|
||||
|
||||
|
||||
50
doc/scripts/base/frameworks/openflow/plugins/ryu.bro.rst
Normal file
50
doc/scripts/base/frameworks/openflow/plugins/ryu.bro.rst
Normal file
|
|
@ -0,0 +1,50 @@
|
|||
:tocdepth: 3
|
||||
|
||||
base/frameworks/openflow/plugins/ryu.bro
|
||||
========================================
|
||||
.. bro:namespace:: OpenFlow
|
||||
|
||||
OpenFlow plugin for the Ryu controller.
|
||||
|
||||
:Namespace: OpenFlow
|
||||
:Imports: :doc:`base/frameworks/openflow </scripts/base/frameworks/openflow/index>`, :doc:`base/utils/active-http.bro </scripts/base/utils/active-http.bro>`, :doc:`base/utils/exec.bro </scripts/base/utils/exec.bro>`, :doc:`base/utils/json.bro </scripts/base/utils/json.bro>`
|
||||
|
||||
Summary
|
||||
~~~~~~~
|
||||
Redefinitions
|
||||
#############
|
||||
============================================================================ =
|
||||
:bro:type:`OpenFlow::ControllerState`: :bro:type:`record` :bro:attr:`&redef`
|
||||
:bro:type:`OpenFlow::Plugin`: :bro:type:`enum`
|
||||
============================================================================ =
|
||||
|
||||
Functions
|
||||
#########
|
||||
================================================= ===========================
|
||||
:bro:id:`OpenFlow::ryu_new`: :bro:type:`function` Ryu controller constructor.
|
||||
================================================= ===========================
|
||||
|
||||
|
||||
Detailed Interface
|
||||
~~~~~~~~~~~~~~~~~~
|
||||
Functions
|
||||
#########
|
||||
.. bro:id:: OpenFlow::ryu_new
|
||||
|
||||
:Type: :bro:type:`function` (host: :bro:type:`addr`, host_port: :bro:type:`count`, dpid: :bro:type:`count`) : :bro:type:`OpenFlow::Controller`
|
||||
|
||||
Ryu controller constructor.
|
||||
|
||||
|
||||
:host: Controller ip.
|
||||
|
||||
|
||||
:host_port: Controller listen port.
|
||||
|
||||
|
||||
:dpid: OpenFlow switch datapath id.
|
||||
|
||||
|
||||
:returns: OpenFlow::Controller record.
|
||||
|
||||
|
||||
Loading…
Add table
Add a link
Reference in a new issue