zeek/doc/scripts/base/frameworks/sumstats/plugins/last.bro.rst
Jon Siwek 7e9d48f532 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.
2018-12-18 10:15:22 -06:00

39 lines
1.2 KiB
ReStructuredText

:tocdepth: 3
base/frameworks/sumstats/plugins/last.bro
=========================================
.. bro:namespace:: SumStats
Keep the last X observations.
:Namespace: SumStats
:Imports: :doc:`base/frameworks/sumstats </scripts/base/frameworks/sumstats/index>`, :doc:`base/utils/queue.bro </scripts/base/utils/queue.bro>`
Summary
~~~~~~~
Redefinitions
#############
=================================================== =
:bro:type:`SumStats::Calculation`: :bro:type:`enum`
:bro:type:`SumStats::Reducer`: :bro:type:`record`
:bro:type:`SumStats::ResultVal`: :bro:type:`record`
=================================================== =
Functions
#########
================================================== ================================================
:bro:id:`SumStats::get_last`: :bro:type:`function` Get a vector of element values from a ResultVal.
================================================== ================================================
Detailed Interface
~~~~~~~~~~~~~~~~~~
Functions
#########
.. bro:id:: SumStats::get_last
:Type: :bro:type:`function` (rv: :bro:type:`SumStats::ResultVal`) : :bro:type:`vector` of :bro:type:`SumStats::Observation`
Get a vector of element values from a ResultVal.