mirror of
https://github.com/zeek/zeek.git
synced 2025-10-03 07:08:19 +00:00

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.
37 lines
1.3 KiB
ReStructuredText
37 lines
1.3 KiB
ReStructuredText
:tocdepth: 3
|
|
|
|
base/frameworks/netcontrol/plugins/debug.bro
|
|
============================================
|
|
.. bro:namespace:: NetControl
|
|
|
|
Debugging plugin for the NetControl framework, providing insight into
|
|
executed operations.
|
|
|
|
:Namespace: NetControl
|
|
:Imports: :doc:`base/frameworks/netcontrol/main.bro </scripts/base/frameworks/netcontrol/main.bro>`, :doc:`base/frameworks/netcontrol/plugin.bro </scripts/base/frameworks/netcontrol/plugin.bro>`
|
|
|
|
Summary
|
|
~~~~~~~
|
|
Functions
|
|
#########
|
|
======================================================== =========================================================
|
|
:bro:id:`NetControl::create_debug`: :bro:type:`function` Instantiates a debug plugin for the NetControl framework.
|
|
======================================================== =========================================================
|
|
|
|
|
|
Detailed Interface
|
|
~~~~~~~~~~~~~~~~~~
|
|
Functions
|
|
#########
|
|
.. bro:id:: NetControl::create_debug
|
|
|
|
:Type: :bro:type:`function` (do_something: :bro:type:`bool`) : :bro:type:`NetControl::PluginState`
|
|
|
|
Instantiates a debug plugin for the NetControl framework. The debug
|
|
plugin simply logs the operations it receives.
|
|
|
|
|
|
:do_something: If true, the plugin will claim it supports all operations; if
|
|
false, it will indicate it doesn't support any.
|
|
|
|
|