diff options
Diffstat (limited to 'src/vpp-api/vapi/vapi.h')
| -rw-r--r-- | src/vpp-api/vapi/vapi.h | 41 |
1 files changed, 27 insertions, 14 deletions
diff --git a/src/vpp-api/vapi/vapi.h b/src/vpp-api/vapi/vapi.h index f4e060b0180..c131920a88f 100644 --- a/src/vpp-api/vapi/vapi.h +++ b/src/vpp-api/vapi/vapi.h @@ -208,7 +208,7 @@ vapi_error_e vapi_wait (vapi_ctx_t ctx); * * @return VAPI_OK on success, other error code on error */ - vapi_error_e vapi_dispatch_one (vapi_ctx_t ctx); +vapi_error_e vapi_dispatch_one (vapi_ctx_t ctx); /** * @brief loop vapi_dispatch_one until responses to all currently outstanding @@ -224,11 +224,11 @@ vapi_error_e vapi_wait (vapi_ctx_t ctx); * * @return VAPI_OK on success, other error code on error */ - vapi_error_e vapi_dispatch (vapi_ctx_t ctx); +vapi_error_e vapi_dispatch (vapi_ctx_t ctx); /** generic vapi event callback */ - typedef vapi_error_e (*vapi_event_cb) (vapi_ctx_t ctx, void *callback_ctx, - void *payload); +typedef vapi_error_e (*vapi_event_cb) (vapi_ctx_t ctx, void *callback_ctx, + void *payload); /** * @brief set event callback to call when message with given id is dispatched @@ -238,8 +238,8 @@ vapi_error_e vapi_wait (vapi_ctx_t ctx); * @param callback callback * @param callback_ctx context pointer stored and passed to callback */ - void vapi_set_event_cb (vapi_ctx_t ctx, vapi_msg_id_t id, - vapi_event_cb callback, void *callback_ctx); +void vapi_set_event_cb (vapi_ctx_t ctx, vapi_msg_id_t id, + vapi_event_cb callback, void *callback_ctx); /** * @brief clear event callback for given message id @@ -247,12 +247,12 @@ vapi_error_e vapi_wait (vapi_ctx_t ctx); * @param ctx opaque vapi context * @param id message id */ - void vapi_clear_event_cb (vapi_ctx_t ctx, vapi_msg_id_t id); +void vapi_clear_event_cb (vapi_ctx_t ctx, vapi_msg_id_t id); /** generic vapi event callback */ - typedef vapi_error_e (*vapi_generic_event_cb) (vapi_ctx_t ctx, - void *callback_ctx, - vapi_msg_id_t id, void *msg); +typedef vapi_error_e (*vapi_generic_event_cb) (vapi_ctx_t ctx, + void *callback_ctx, + vapi_msg_id_t id, void *msg); /** * @brief set generic event callback * @@ -263,16 +263,29 @@ vapi_error_e vapi_wait (vapi_ctx_t ctx); * @param callback callback * @param callback_ctx context pointer stored and passed to callback */ - void vapi_set_generic_event_cb (vapi_ctx_t ctx, - vapi_generic_event_cb callback, - void *callback_ctx); +void vapi_set_generic_event_cb (vapi_ctx_t ctx, vapi_generic_event_cb callback, + void *callback_ctx); /** * @brief clear generic event callback * * @param ctx opaque vapi context */ - void vapi_clear_generic_event_cb (vapi_ctx_t ctx); +void vapi_clear_generic_event_cb (vapi_ctx_t ctx); + +/** + * @brief signal RX thread to exit + * + * @note This adds a message to the client input queue that indicates that + * an RX thread should stop processing incoming messages and exit. If an + * application has an RX thread which sleeps while waiting for incoming + * messages using vapi_wait(), this call will allow the application to + * wake up from the vapi_wait() call and figure out that it should stop + * running. + * + * @param ctx opaque vapi context + */ +void vapi_stop_rx_thread (vapi_ctx_t ctx); #ifdef __cplusplus } |