mirror of
https://github.com/zeek/zeek.git
synced 2025-10-02 22:58:20 +00:00
5a2cd265ab
Added an additional master TOC index for Bro script packages that automatically gets filled in at ``make doc`` time. The master TOC links to per-package indexes which contains links to all the scripts contained within it along with their summary. The per-package index is also now automatically generated/derived from the path component of the script passed into the rest_target() macro.
118 lines
1.5 KiB
ReStructuredText
118 lines
1.5 KiB
ReStructuredText
Builtin Types and Attributes
|
|
============================
|
|
|
|
Types
|
|
-----
|
|
|
|
The Bro scripting language supports the following built-in types.
|
|
|
|
.. TODO: add documentation
|
|
|
|
.. bro:type:: void
|
|
|
|
.. bro:type:: bool
|
|
|
|
.. bro:type:: int
|
|
|
|
.. bro:type:: count
|
|
|
|
.. bro:type:: counter
|
|
|
|
.. bro:type:: double
|
|
|
|
.. bro:type:: time
|
|
|
|
.. bro:type:: interval
|
|
|
|
.. bro:type:: string
|
|
|
|
.. bro:type:: pattern
|
|
|
|
.. bro:type:: enum
|
|
|
|
.. bro:type:: timer
|
|
|
|
.. bro:type:: port
|
|
|
|
.. bro:type:: addr
|
|
|
|
.. bro:type:: net
|
|
|
|
.. bro:type:: subnet
|
|
|
|
.. bro:type:: any
|
|
|
|
.. bro:type:: table
|
|
|
|
.. bro:type:: union
|
|
|
|
.. bro:type:: record
|
|
|
|
.. bro:type:: types
|
|
|
|
.. bro:type:: func
|
|
|
|
.. bro:type:: file
|
|
|
|
.. bro:type:: vector
|
|
|
|
.. TODO: below are kind of "special cases" that bro knows about?
|
|
|
|
.. bro:type:: set
|
|
|
|
.. bro:type:: function
|
|
|
|
.. bro:type:: event
|
|
|
|
Attributes
|
|
----------
|
|
|
|
The Bro scripting language supports the following built-in attributes.
|
|
|
|
.. TODO: add documentation
|
|
|
|
.. bro:attr:: &optional
|
|
|
|
.. bro:attr:: &default
|
|
|
|
.. bro:attr:: &redef
|
|
|
|
.. bro:attr:: &rotate_interval
|
|
|
|
.. bro:attr:: &rotate_size
|
|
|
|
.. bro:attr:: &add_func
|
|
|
|
.. bro:attr:: &delete_func
|
|
|
|
.. bro:attr:: &expire_func
|
|
|
|
.. bro:attr:: &read_expire
|
|
|
|
.. bro:attr:: &write_expire
|
|
|
|
.. bro:attr:: &create_expire
|
|
|
|
.. bro:attr:: &persistent
|
|
|
|
.. bro:attr:: &synchronized
|
|
|
|
.. bro:attr:: &postprocessor
|
|
|
|
.. bro:attr:: &encrypt
|
|
|
|
.. bro:attr:: &match
|
|
|
|
.. bro:attr:: &disable_print_hook
|
|
|
|
.. bro:attr:: &raw_output
|
|
|
|
.. bro:attr:: &mergeable
|
|
|
|
.. bro:attr:: &priority
|
|
|
|
.. bro:attr:: &group
|
|
|
|
.. bro:attr:: &log
|
|
|
|
.. bro:attr:: (&tracked)
|