|author||Pablo Neira Ayuso <email@example.com>||2014-01-30 13:05:12 +0100|
|committer||Pablo Neira Ayuso <firstname.lastname@example.org>||2014-01-30 13:12:03 +0100|
src: fix documentation regarding nfct_catch() and nfexp_catch()
Stefan reported that the *_catch() functions documentation was imprecise on some aspects. Reported-by: Stefan Nicolae Stancu <Stefan.Stancu@cern.ch> Signed-off-by: Pablo Neira Ayuso <email@example.com>
Diffstat (limited to 'src/conntrack')
1 files changed, 8 insertions, 2 deletions
diff --git a/src/conntrack/api.c b/src/conntrack/api.c
index cad860e..09270ee 100644
@@ -1006,9 +1006,15 @@ int nfct_send(struct nfct_handle *h,
* nfct_catch - catch events
* \param h library handler
- * On error, -1 is returned and errno is set appropiately. On success,
+ * This function receives the event from the kernel and it invokes the
+ * callback that was registered to this handle.
+ * On error, -1 is returned and errno is set appropiately. On success,
* a value greater or equal to 0 is returned indicating the callback
- * verdict: NFCT_CB_STOP, NFCT_CB_CONTINUE or NFCT_CB_STOLEN
+ * verdict: NFCT_CB_STOP, NFCT_CB_CONTINUE or NFCT_CB_STOLEN.
+ * Beware that this function also handles expectation events, in case they are
+ * received through this handle.
int nfct_catch(struct nfct_handle *h)