API Reference Manual  1.45.1
odp_queue_capability_t Struct Reference

Queue capabilities. More...

#include <queue_types.h>

Data Fields

uint32_t max_queues
 Maximum number of event queues of any type (default size). More...
 
struct {
   uint32_t   max_num
 Maximum number of plain (ODP_BLOCKING) queues of the default size.
 
   uint32_t   max_size
 Maximum number of events a plain (ODP_BLOCKING) queue can store simultaneously. More...
 
   struct {
      uint32_t   max_num
 Maximum number of queues. More...
 
      uint32_t   max_size
 Maximum queue size. More...
 
   }   lockfree
 Lock-free (ODP_NONBLOCKING_LF) implementation capabilities. More...
 
   struct {
      uint32_t   max_num
 Maximum number of queues. More...
 
      uint32_t   max_size
 Maximum queue size. More...
 
   }   waitfree
 Wait-free (ODP_NONBLOCKING_WF) implementation capabilities. More...
 
plain
 Plain queue capabilities.
 

Detailed Description

Queue capabilities.

Examples
odp_queue_perf.c, odp_simple_pipeline.c, and odp_sysinfo.c.

Definition at line 171 of file api/spec/queue_types.h.

Field Documentation

◆ max_queues

uint32_t odp_queue_capability_t::max_queues

Maximum number of event queues of any type (default size).

Use this in addition to queue type specific 'max_num', if both queue types are used simultaneously.

Examples
odp_sysinfo.c.

Definition at line 175 of file api/spec/queue_types.h.

◆ max_num

uint32_t odp_queue_capability_t::max_num

Maximum number of plain (ODP_BLOCKING) queues of the default size.

Maximum number of queues.

Lock-free queues are not supported when zero.

Wait-free queues are not supported when zero.

Examples
odp_queue_perf.c, odp_simple_pipeline.c, and odp_sysinfo.c.

Definition at line 181 of file api/spec/queue_types.h.

◆ max_size

uint32_t odp_queue_capability_t::max_size

Maximum number of events a plain (ODP_BLOCKING) queue can store simultaneously.

Maximum queue size.

The value of zero means that plain queues do not have a size limit, but a single queue can store all available events.

The value of zero means that there is no size limit.

Examples
odp_queue_perf.c, odp_simple_pipeline.c, and odp_sysinfo.c.

Definition at line 187 of file api/spec/queue_types.h.

◆ 

struct { ... } odp_queue_capability_t::lockfree

Lock-free (ODP_NONBLOCKING_LF) implementation capabilities.

The specification is the same as for the blocking implementation.

Examples
odp_queue_perf.c, and odp_sysinfo.c.

◆ 

struct { ... } odp_queue_capability_t::waitfree

Wait-free (ODP_NONBLOCKING_WF) implementation capabilities.

The specification is the same as for the blocking implementation.

Examples
odp_queue_perf.c, and odp_sysinfo.c.

The documentation for this struct was generated from the following file: