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

Message ID 1494950422-11135-3-git-send-email-odpbot@yandex.ru
State New
Headers show
Series
  • [API-NEXT,v5,1/11] api: ipsec: add soft limit expiration event
Related show

Commit Message

Github ODP bot May 16, 2017, 4 p.m.
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 28 (lumag:ipsec)
 ** https://github.com/Linaro/odp/pull/28
 ** Patch: https://github.com/Linaro/odp/pull/28.patch
 ** Base sha: f4c213cccc49b4b28557506ad19fba49b872d24f
 ** Merge commit sha: e6ef5a70e5261ee32e5edb33fc7710d103010d95
 **/
 include/odp/api/spec/ipsec.h | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)

Patch

diff --git a/include/odp/api/spec/ipsec.h b/include/odp/api/spec/ipsec.h
index 03742c6..b1c81b1 100644
--- a/include/odp/api/spec/ipsec.h
+++ b/include/odp/api/spec/ipsec.h
@@ -493,8 +493,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 */