From: Nikhil Agarwal <nikhil.agar...@linaro.org> IPSEC events may be delivered synchronous or ansynchrous depending on implementation. Application will know based on return value of odp_ipsec_sa_disable API.
Signed-off-by: Nikhil Agarwal <nikhil.agar...@linaro.org> --- /** Email created from pull request 109 (NikhilA-Linaro:disable_event) ** https://github.com/Linaro/odp/pull/109 ** Patch: https://github.com/Linaro/odp/pull/109.patch ** Base sha: e420668cd3886f003c8bd6022e210bf08a0ee3b5 ** Merge commit sha: 60340859600e926a2666640fbdd6840640c2b8a6 **/ include/odp/api/spec/ipsec.h | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/include/odp/api/spec/ipsec.h b/include/odp/api/spec/ipsec.h index 7085bc0d..0a799ff4 100644 --- a/include/odp/api/spec/ipsec.h +++ b/include/odp/api/spec/ipsec.h @@ -831,16 +831,17 @@ odp_ipsec_sa_t odp_ipsec_sa_create(const odp_ipsec_sa_param_t *param); * before calling disable. Packets in progress during the call may still match * the SA and be processed successfully. * - * When in synchronous operation mode, the call will return when it's possible - * to destroy the SA. In asynchronous mode, the same is indicated by an - * ODP_EVENT_IPSEC_STATUS event sent to the queue specified for the SA. The - * status event is guaranteed to be the last event for the SA, i.e. all - * in-progress operations have completed and resulting events (including status - * events) have been enqueued before it. + * When SA is disabled synchronously, the call will return when it's possible + * to destroy the SA indicated by return value 0. If the return value is 1,same + * is indicated by an ODP_EVENT_IPSEC_STATUS event sent to the queue specified + * for the SA. The status event is guaranteed to be the last event for the SA, + * i.e. all in-progress operations have completed and resulting events + * (including status events) have been enqueued before it. * * @param sa IPSEC SA to be disabled * - * @retval 0 On success + * @retval 0 When SA is disabled successfully. + * @retval 1 Disable event will be posted on SA queue. * @retval <0 On failure * * @see odp_ipsec_sa_destroy()
