[master] a728b14 clarify how to use VSLQ_Flush()

Nils Goroll nils.goroll at uplex.de
Sat Jun 27 15:14:16 CEST 2015


commit a728b148c168637f0986b3d6745c332452384c8a
Author: Nils Goroll <nils.goroll at uplex.de>
Date:   Sat Jun 27 15:14:04 2015 +0200

    clarify how to use VSLQ_Flush()

diff --git a/include/vapi/vsl.h b/include/vapi/vsl.h
index cebbb46..dd2f6af 100644
--- a/include/vapi/vsl.h
+++ b/include/vapi/vsl.h
@@ -518,12 +518,13 @@ int VSLQ_Dispatch(struct VSLQ *vslq, VSLQ_dispatch_f *func, void *priv);
 
 int VSLQ_Flush(struct VSLQ *vslq, VSLQ_dispatch_f *func, void *priv);
 	/*
-	 * Flush any pending record sets from the query.
+	 * Flush any pending record sets from the query until func
+	 * (if given) returns non-zero.
 	 *
 	 * Arguments:
 	 *  vslq: The VSL context
 	 *  func: The callback function to call. Pass NULL to discard the
-	 *        pending messages
+	 *        pending messages or call repeatedly until 0 is returned.
 	 *  priv: An argument passed to func
 	 *
 	 * Return values:



More information about the varnish-commit mailing list