API Reference Manual 1.51.0
Loading...
Searching...
No Matches
queue.h File Reference

ODP queue. More...

#include <odp/visibility_begin.h>
#include <odp/api/event_types.h>
#include <odp/api/queue_types.h>
#include <odp/api/std_types.h>
#include <odp/visibility_end.h>
Include dependency graph for api/spec/queue.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions

odp_queue_t odp_queue_create (const char *name, const odp_queue_param_t *param)
 Queue create.
 
int odp_queue_create_multi (const char *name[], const odp_queue_param_t param[], odp_bool_t share_param, odp_queue_t queue[], int num)
 Create multiple queues.
 
int odp_queue_destroy (odp_queue_t queue)
 Destroy ODP queue.
 
int odp_queue_destroy_multi (odp_queue_t queue[], int num)
 Destroy multiple queues.
 
odp_queue_t odp_queue_lookup (const char *name)
 Find a queue by name.
 
int odp_queue_capability (odp_queue_capability_t *capa)
 Query queue capabilities.
 
int odp_queue_context_set (odp_queue_t queue, void *context, uint32_t len)
 Set queue context.
 
void * odp_queue_context (odp_queue_t queue)
 Get queue context.
 
odp_queue_t odp_queue_aggr (odp_queue_t queue, uint32_t aggr_index)
 Get a queue handle of an event aggregator associated with a queue.
 
int odp_queue_enq (odp_queue_t queue, odp_event_t ev)
 Enqueue an event to a queue.
 
int odp_queue_enq_multi (odp_queue_t queue, const odp_event_t events[], int num)
 Enqueue multiple events to a queue.
 
int odp_queue_enq_aggr (odp_queue_t queue, odp_event_t ev, const odp_aggr_enq_param_t *param)
 Enqueue an event with event aggregation hints.
 
void odp_aggr_enq_param_init (odp_aggr_enq_param_t *param)
 Initialize aggregator enqueue parameters to their default values.
 
odp_event_t odp_queue_deq (odp_queue_t queue)
 Dequeue an event from a queue.
 
int odp_queue_deq_multi (odp_queue_t queue, odp_event_t events[], int num)
 Dequeue multiple events from a queue.
 
uint32_t odp_queue_len (odp_queue_t queue)
 Queue length.
 
odp_queue_type_t odp_queue_type (odp_queue_t queue)
 Queue type.
 
odp_schedule_sync_t odp_queue_sched_type (odp_queue_t queue)
 Queue schedule type.
 
odp_schedule_prio_t odp_queue_sched_prio (odp_queue_t queue)
 Queue priority.
 
odp_schedule_group_t odp_queue_sched_group (odp_queue_t queue)
 Queue group.
 
uint32_t odp_queue_lock_count (odp_queue_t queue)
 Queue lock count.
 
uint64_t odp_queue_to_u64 (odp_queue_t hdl)
 Get printable value for an odp_queue_t.
 
void odp_queue_param_init (odp_queue_param_t *param)
 Initialize queue params.
 
int odp_queue_info (odp_queue_t queue, odp_queue_info_t *info)
 Retrieve information about a queue.
 
void odp_queue_print (odp_queue_t queue)
 Print queue info.
 
void odp_queue_print_all (void)
 Print debug info about all queues.
 

Detailed Description

ODP queue.

Definition in file api/spec/queue.h.