Include dependency graph for doca_sta_task.h:
This graph shows which files directly or indirectly include this file:
Go to the source code of this file.
Typedefs | |
| typedef void(* | doca_sta_task_completion_cb_t) (struct doca_sta_producer_task_send *task, union doca_data task_user_data) |
| Function to execute on STA task completion. More... | |
Functions | |
| DOCA_EXPERIMENTAL struct doca_task * | doca_sta_producer_send_task_as_task (struct doca_sta_producer_task_send *task) |
Typedef Documentation
◆ doca_sta_task_completion_cb_t
| typedef void(* doca_sta_task_completion_cb_t) (struct doca_sta_producer_task_send *task, union doca_data task_user_data) |
Function to execute on STA task completion.
This function is called by doca_pe_progress() when related task identified as completed successfully. When this function called the ownership of the task object passed from DOCA back to user. Inside this callback user may decide on the task object:
- re-submit task with doca_task_submit(); task object ownership passed to DOCA
- release task with doca_task_free(); task object ownership passed to DOCA
- keep the task object for future re-use; user keeps the ownership on the task object Inside this callback the user shouldn't call doca_pe_progress(). Please see doca_pe_progress for details.
Any failure/error inside this function should be handled internally or deferred; due to the mode of nested in doca_pe_progress() execution this callback doesn't return error.
NOTE: this callback type utilized for both successful & failed task completions.
- Parameters
-
[in] task STA disconnect task. [in] task_user_data The task user data
Definition at line 53 of file doca_sta_task.h.
Function Documentation
◆ doca_sta_producer_send_task_as_task()
| DOCA_EXPERIMENTAL struct doca_task* doca_sta_producer_send_task_as_task | ( | struct doca_sta_producer_task_send * | task | ) |
