API Reference Manual  1.45.0
api/spec/buffer.h File Reference

ODP buffer. More...

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

Go to the source code of this file.

Functions

odp_buffer_t odp_buffer_from_event (odp_event_t ev)
 Get buffer handle from event. More...
 
void odp_buffer_from_event_multi (odp_buffer_t buf[], const odp_event_t ev[], int num)
 Convert multiple buffer events to buffer handles. More...
 
odp_event_t odp_buffer_to_event (odp_buffer_t buf)
 Convert buffer handle to event. More...
 
void odp_buffer_to_event_multi (const odp_buffer_t buf[], odp_event_t ev[], int num)
 Convert multiple buffer handles to events. More...
 
void * odp_buffer_addr (odp_buffer_t buf)
 Buffer start address. More...
 
uint32_t odp_buffer_size (odp_buffer_t buf)
 Buffer maximum data size. More...
 
void * odp_buffer_user_area (odp_buffer_t buf)
 Buffer user area. More...
 
int odp_buffer_is_valid (odp_buffer_t buf)
 Check that buffer is valid. More...
 
odp_pool_t odp_buffer_pool (odp_buffer_t buf)
 Buffer pool of the buffer. More...
 
odp_buffer_t odp_buffer_alloc (odp_pool_t pool)
 Buffer alloc. More...
 
int odp_buffer_alloc_multi (odp_pool_t pool, odp_buffer_t buf[], int num)
 Allocate multiple buffers. More...
 
void odp_buffer_free (odp_buffer_t buf)
 Buffer free. More...
 
void odp_buffer_free_multi (const odp_buffer_t buf[], int num)
 Free multiple buffers. More...
 
void odp_buffer_print (odp_buffer_t buf)
 Print buffer metadata to STDOUT. More...
 
uint64_t odp_buffer_to_u64 (odp_buffer_t hdl)
 Get printable value for an odp_buffer_t. More...
 

Detailed Description

ODP buffer.

Definition in file api/spec/buffer.h.