From: Eric Leblond <el@stamus-networks.com>
Date: Sat, 14 Aug 2021 21:08:01 +0000 (+0200)
Subject: flow: document FlowBypassedTimeout
X-Git-Tag: suricata-7.0.0-beta1~1481
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=9c89bc80d07cd5dbc5fddf30222a0bd5076eb093;p=thirdparty%2Fsuricata.git

flow: document FlowBypassedTimeout

Main point is to document it is interacting with the capture
layer.
---

diff --git a/src/flow-manager.c b/src/flow-manager.c
index 40654f813e..2abc8c817f 100644
--- a/src/flow-manager.c
+++ b/src/flow-manager.c
@@ -208,6 +208,16 @@ static int FlowManagerFlowTimeout(Flow *f, struct timeval *ts, int32_t *next_ts,
     return 1;
 }
 
+/** \internal
+ *  \brief check timeout of captured bypassed flow by querying capture method
+ *
+ *  \param f Flow
+ *  \param ts timestamp
+ *  \param counters Flow timeout counters
+ *
+ *  \retval 0 not timeout
+ *  \retval 1 timeout (or not capture bypassed)
+ */
 static inline int FlowBypassedTimeout(Flow *f, struct timeval *ts,
                                       FlowTimeoutCounters *counters)
 {