Improve documentation for zeek_init event scheduling pitfalls

This commit is contained in:
Jon Siwek 2020-10-12 17:43:15 -07:00
parent 38af38beae
commit d827e8b2d2
4 changed files with 10 additions and 6 deletions

View file

@ -41,10 +41,10 @@
##
## When a ``zeek_init`` handler executes, Zeek has not yet seen any input
## packets and therefore :zeek:id:`network_time` is not initialized yet. An
## artifact of that is that any timer installed in a ``zeek_init`` handler
## will fire immediately with the first packet. The standard way to work
## around that is to ignore the first time the timer fires and immediately
## reschedule.
## artifact of that is that any timer installed in a ``zeek_init`` handler,
## like with :zeek:keyword:`schedule`, will fire immediately with the first
## packet. The standard way to work around that is to ignore the first time
## the timer fires and immediately reschedule.
##
event zeek_init%(%);