API Reference Manual  1.45.0
api/spec/queue.h
Go to the documentation of this file.
1 /* SPDX-License-Identifier: BSD-3-Clause
2  * Copyright (c) 2013-2018 Linaro Limited
3  * Copyright (c) 2023 Nokia
4  */
5 
12 #ifndef ODP_API_SPEC_QUEUE_H_
13 #define ODP_API_SPEC_QUEUE_H_
14 #include <odp/visibility_begin.h>
15 
16 #ifdef __cplusplus
17 extern "C" {
18 #endif
19 
20 #include <odp/api/event_types.h>
21 #include <odp/api/queue_types.h>
22 #include <odp/api/std_types.h>
23 
45 odp_queue_t odp_queue_create(const char *name, const odp_queue_param_t *param);
46 
71 int odp_queue_create_multi(const char *name[], const odp_queue_param_t param[],
72  odp_bool_t share_param, odp_queue_t queue[],
73  int num);
74 
89 
102 int odp_queue_destroy_multi(odp_queue_t queue[], int num);
103 
112 odp_queue_t odp_queue_lookup(const char *name);
113 
125 
140 int odp_queue_context_set(odp_queue_t queue, void *context, uint32_t len);
141 
157 
177 
194 int odp_queue_enq_multi(odp_queue_t queue, const odp_event_t events[], int num);
195 
214 
229 int odp_queue_deq_multi(odp_queue_t queue, odp_event_t events[], int num);
230 
239 
248 
259 
270 
284 
297 
308 
322 
332 
340 
345 #ifdef __cplusplus
346 }
347 #endif
348 
349 #include <odp/visibility_end.h>
350 #endif
ODP event API type definitions.
ODP queue.
Standard C language types and definitions for ODP.
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.
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.
uint32_t odp_queue_lock_count(odp_queue_t queue)
Queue lock count.
int odp_queue_context_set(odp_queue_t queue, void *context, uint32_t len)
Set queue context.
int odp_queue_enq_multi(odp_queue_t queue, const odp_event_t events[], int num)
Enqueue multiple events to a queue.
void odp_queue_param_init(odp_queue_param_t *param)
Initialize queue params.
int odp_queue_capability(odp_queue_capability_t *capa)
Query queue capabilities.
odp_event_t odp_queue_deq(odp_queue_t queue)
Dequeue an event from a queue.
odp_queue_type_t
Queue type.
void * odp_queue_context(odp_queue_t queue)
Get queue context.
int odp_queue_enq(odp_queue_t queue, odp_event_t ev)
Enqueue an event to a queue.
void odp_queue_print_all(void)
Print debug info about all queues.
odp_schedule_group_t odp_queue_sched_group(odp_queue_t queue)
Queue group.
odp_queue_t odp_queue_create(const char *name, const odp_queue_param_t *param)
Queue create.
odp_queue_type_t odp_queue_type(odp_queue_t queue)
Queue type.
void odp_queue_print(odp_queue_t queue)
Print queue info.
int odp_queue_destroy(odp_queue_t queue)
Destroy ODP queue.
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_info(odp_queue_t queue, odp_queue_info_t *info)
Retrieve information about a queue.
int odp_queue_deq_multi(odp_queue_t queue, odp_event_t events[], int num)
Dequeue multiple events from a queue.
uint64_t odp_queue_to_u64(odp_queue_t hdl)
Get printable value for an odp_queue_t.
int odp_schedule_sync_t
Scheduler synchronization method.
int odp_schedule_prio_t
Scheduling priority level.
int odp_schedule_group_t
Scheduler thread group.
int odp_bool_t
Use odp boolean type to have it well-defined and known size, regardless which compiler is used as thi...
Queue information Retrieve information about a queue with odp_queue_info()
ODP Queue parameters.