diff options
| author | Petri Savolainen <petri.savolainen@nokia.com> | 2019-04-16 15:40:52 +0300 |
|---|---|---|
| committer | Petri Savolainen <petri.savolainen@nokia.com> | 2019-04-30 14:07:06 +0300 |
| commit | 0c2ac5119b3015e223357d168b00515a822728cc (patch) | |
| tree | 91e2e76aed96a3773998433d8e478c7e148fe62e /include | |
| parent | a45047e728ca1cc0c97e0201eb9900daae5730b6 (diff) | |
api: queue: context default value NULL
Highlight that queue context default value is NULL. This was
defined already in odp_queue_param_t specification.
Signed-off-by: Petri Savolainen <petri.savolainen@nokia.com>
Reviewed-by: Matias Elo <matias.elo@nokia.com>
Diffstat (limited to 'include')
| -rw-r--r-- | include/odp/api/spec/queue.h | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/include/odp/api/spec/queue.h b/include/odp/api/spec/queue.h index 605831c50..f40eb7afa 100644 --- a/include/odp/api/spec/queue.h +++ b/include/odp/api/spec/queue.h @@ -116,10 +116,16 @@ int odp_queue_context_set(odp_queue_t queue, void *context, uint32_t len); /** * Get queue context * + * Returns previously stored queue context pointer. The context pointer may + * be set with odp_queue_context_set() or during queue creation + * (see odp_queue_param_t). The pointer value is set to NULL by default. + * * @param queue Queue handle * * @return pointer to the queue context * @retval NULL on failure + * + * @see odp_queue_context_set(), odp_queue_create() */ void *odp_queue_context(odp_queue_t queue); |