mirror of
https://github.com/zeek/zeek.git
synced 2025-10-03 07:08:19 +00:00
ded98cd373
This is based on commit 2731def9159247e6da8a3191783c89683363689c from the zeek-docs repo.
64 lines
2.5 KiB
ReStructuredText
64 lines
2.5 KiB
ReStructuredText
:tocdepth: 3
|
|
|
|
base/utils/dir.zeek
|
|
===================
|
|
.. zeek:namespace:: Dir
|
|
|
|
|
|
:Namespace: Dir
|
|
:Imports: :doc:`base/frameworks/reporter </scripts/base/frameworks/reporter/index>`, :doc:`base/utils/exec.zeek </scripts/base/utils/exec.zeek>`, :doc:`base/utils/paths.zeek </scripts/base/utils/paths.zeek>`
|
|
|
|
Summary
|
|
~~~~~~~
|
|
Runtime Options
|
|
###############
|
|
=========================================================================== =====================================================================
|
|
:zeek:id:`Dir::polling_interval`: :zeek:type:`interval` :zeek:attr:`&redef` The default interval this module checks for files in directories when
|
|
using the :zeek:see:`Dir::monitor` function.
|
|
=========================================================================== =====================================================================
|
|
|
|
Functions
|
|
#########
|
|
============================================== ==============================================================
|
|
:zeek:id:`Dir::monitor`: :zeek:type:`function` Register a directory to monitor with a callback that is called
|
|
every time a previously unseen file is seen.
|
|
============================================== ==============================================================
|
|
|
|
|
|
Detailed Interface
|
|
~~~~~~~~~~~~~~~~~~
|
|
Runtime Options
|
|
###############
|
|
.. zeek:id:: Dir::polling_interval
|
|
:source-code: base/utils/dir.zeek 10 10
|
|
|
|
:Type: :zeek:type:`interval`
|
|
:Attributes: :zeek:attr:`&redef`
|
|
:Default: ``30.0 secs``
|
|
|
|
The default interval this module checks for files in directories when
|
|
using the :zeek:see:`Dir::monitor` function.
|
|
|
|
Functions
|
|
#########
|
|
.. zeek:id:: Dir::monitor
|
|
:source-code: base/utils/dir.zeek 60 63
|
|
|
|
:Type: :zeek:type:`function` (dir: :zeek:type:`string`, callback: :zeek:type:`function` (fname: :zeek:type:`string`) : :zeek:type:`void`, poll_interval: :zeek:type:`interval` :zeek:attr:`&default` = :zeek:see:`Dir::polling_interval` :zeek:attr:`&optional`) : :zeek:type:`void`
|
|
|
|
Register a directory to monitor with a callback that is called
|
|
every time a previously unseen file is seen. If a file is deleted
|
|
and seen to be gone, then the file is available for being seen again
|
|
in the future.
|
|
|
|
|
|
:param dir: The directory to monitor for files.
|
|
|
|
|
|
:param callback: Callback that gets executed with each file name
|
|
that is found. Filenames are provided with the full path.
|
|
|
|
|
|
:param poll_interval: An interval at which to check for new files.
|
|
|
|
|