mirror of
https://github.com/zeek/zeek.git
synced 2025-10-04 07:38:19 +00:00
Improve file analysis doxygen comments.
This commit is contained in:
parent
705a84d688
commit
f82167d067
8 changed files with 421 additions and 24 deletions
|
@ -13,11 +13,20 @@ namespace file_analysis {
|
|||
*/
|
||||
class FileTimer : public Timer {
|
||||
public:
|
||||
|
||||
/**
|
||||
* Constructor, nothing interesting about it.
|
||||
* @param t unix time at which the timer should start ticking.
|
||||
* @param id the file identifier which will be checked for inactivity.
|
||||
* @param interval amount of time after \a t to check for inactivity.
|
||||
*/
|
||||
FileTimer(double t, const string& id, double interval);
|
||||
|
||||
/**
|
||||
* Check inactivity of file_analysis::File corresponding to #file_id,
|
||||
* reschedule if active, else call file_analysis::Manager::Timeout.
|
||||
* @param t current unix time
|
||||
* @param is_expire true if all pending timers are being expired.
|
||||
*/
|
||||
void Dispatch(double t, int is_expire);
|
||||
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue