summaryrefslogtreecommitdiffstats
path: root/src/libnetfilter_log.c
diff options
context:
space:
mode:
authorPablo Neira Ayuso <pablo@netfilter.org>2010-11-04 00:18:14 +0100
committerPablo Neira Ayuso <pablo@netfilter.org>2010-11-04 00:18:14 +0100
commit1812fca3ae635ec209a7aa047e7157cb762f60a4 (patch)
tree8bd4588e70a85086465a9a7a9aea2b1f255d86e1 /src/libnetfilter_log.c
parentb472e11be65855088bbe144acfc779ae5a3a66f2 (diff)
doc: discourage the use of nflog_set_nlbufsiz()
The default buffer size (which is one memory page) provides the best results in terms of performance. For that reason, noone should use nflog_set_nlbufsiz() to set up a higher buffer in the applications (even if this is supported by the nfnetlink_log). Davem spotted this during the Netfilter Workshop 2010. Signed-off-by: Pablo Neira Ayuso <pablo@netfilter.org>
Diffstat (limited to 'src/libnetfilter_log.c')
-rw-r--r--src/libnetfilter_log.c4
1 files changed, 4 insertions, 0 deletions
diff --git a/src/libnetfilter_log.c b/src/libnetfilter_log.c
index 7ca36a8..76ed436 100644
--- a/src/libnetfilter_log.c
+++ b/src/libnetfilter_log.c
@@ -541,6 +541,10 @@ int nflog_set_qthresh(struct nflog_g_handle *gh, u_int32_t qthresh)
* This function sets the size (in bytes) of the buffer that is used to
* stack log messages in nflog.
*
+ * NOTE: The use of this function is strongly discouraged. The default
+ * buffer size (which is one memory page) provides the optimum results
+ * in terms of performance. Do not use this function in your applications.
+ *
* \return -1 in case of error and errno is explicity set.
*/
int nflog_set_nlbufsiz(struct nflog_g_handle *gh, u_int32_t nlbufsiz)