diff mbox series

[API-NEXT,v2,2/5] api: ipsec: note that soft_exp bits are set only once

Message ID 1494288006-2185-3-git-send-email-odpbot@yandex.ru
State Superseded
Headers show
Series [API-NEXT,v2,1/5] api: ipsec: move soft limits expiration to flags, rather than errors | expand

Commit Message

Github ODP bot May 9, 2017, midnight UTC 
From: Dmitry Eremin-Solenikov <dmitry.ereminsolenikov@linaro.org>


Add an explicit note telling that soft_exp bits are set only once, for
the packet actually crossing the boundary. They will not be set for
further packets.

Signed-off-by: Dmitry Eremin-Solenikov <dmitry.ereminsolenikov@linaro.org>

---
/** Email created from pull request 22 (lumag:ipsec-limits)
 ** https://github.com/Linaro/odp/pull/22
 ** Patch: https://github.com/Linaro/odp/pull/22.patch
 ** Base sha: 3ea9c1dac34e0fb4785b0d643056c731daa55e85
 ** Merge commit sha: 85b927011c941f816b853da7284c0c3a939c5efb
 **/
 include/odp/api/spec/ipsec.h | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)
diff mbox series

Patch

diff --git a/include/odp/api/spec/ipsec.h b/include/odp/api/spec/ipsec.h
index c4fe6cb..26b3389 100644
--- a/include/odp/api/spec/ipsec.h
+++ b/include/odp/api/spec/ipsec.h
@@ -481,8 +481,10 @@  typedef struct odp_ipsec_sa_opt_t {
  *
  * These limits are used for setting up SA lifetime. IPSEC operations check
  * against the limits and output a status code (e.g. soft_exp_bytes) when
- * a limit is crossed. Any number of limits may be used simultaneously.
- * Use zero when there is no limit.
+ * a limit is crossed. The soft_exp_* bits will be set only for the first
+ * packet crossing the boundary. Any further packets will not have those bits
+ * set. Any number of limits may be used simultaneously.  Use zero when there
+ * is no limit.
  */
 typedef struct odp_ipsec_lifetime_t {
 	/** Soft expiry limits for the session */