API Reference Manual  1.45.0
api/spec/event.h
Go to the documentation of this file.
1 /* SPDX-License-Identifier: BSD-3-Clause
2  * Copyright (c) 2015-2018 Linaro Limited
3  * Copyright (c) 2022-2024 Nokia
4  */
5 
12 #ifndef ODP_API_SPEC_EVENT_H_
13 #define ODP_API_SPEC_EVENT_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/packet_types.h>
22 #include <odp/api/pool_types.h>
23 
39 
51 
63  odp_event_subtype_t *subtype);
64 
79  odp_event_subtype_t subtype[], int num);
80 
94 int odp_event_type_multi(const odp_event_t event[], int num,
95  odp_event_type_t *type);
96 
109 
123 
145 
159 
178  odp_packet_t packet[],
179  odp_event_t remain[], int num);
180 
193 
207 
218 
228 void odp_event_free_multi(const odp_event_t event[], int num);
229 
239 void odp_event_free_sp(const odp_event_t event[], int num);
240 
262 
277 void odp_event_flow_id_set(odp_event_t event, uint32_t flow_id);
278 
283 #ifdef __cplusplus
284 }
285 #endif
286 
287 #include <odp/visibility_end.h>
288 #endif
ODP event API type definitions.
ODP packet.
ODP pool.
void odp_event_free_sp(const odp_event_t event[], int num)
Free multiple events to the same pool.
void odp_event_free_multi(const odp_event_t event[], int num)
Free multiple events.
odp_event_subtype_t odp_event_subtype(odp_event_t event)
Event subtype of an event.
void odp_event_free(odp_event_t event)
Free event.
odp_pool_t odp_event_pool(odp_event_t event)
Event pool.
void odp_event_types_multi(const odp_event_t event[], odp_event_type_t type[], odp_event_subtype_t subtype[], int num)
Event types and subtypes of multiple events.
int odp_event_type_multi(const odp_event_t event[], int num, odp_event_type_t *type)
Event type of multiple events.
odp_event_type_t odp_event_type(odp_event_t event)
Event type of an event.
void odp_event_user_flag_set(odp_event_t event, int val)
Set event user flag.
int odp_event_filter_packet(const odp_event_t event[], odp_packet_t packet[], odp_event_t remain[], int num)
Filter and convert packet events.
uint64_t odp_event_to_u64(odp_event_t hdl)
Get printable value for an odp_event_t.
odp_event_subtype_t
Event subtype.
odp_event_type_t
Event type.
void odp_event_flow_id_set(odp_event_t event, uint32_t flow_id)
Set event flow id value.
uint32_t odp_event_flow_id(odp_event_t event)
Event flow id value.
void * odp_event_user_area(odp_event_t event)
Event user area.
odp_event_type_t odp_event_types(odp_event_t event, odp_event_subtype_t *subtype)
Event type and subtype of an event.
void * odp_event_user_area_and_flag(odp_event_t event, int *flag)
Event user area and flag.
int odp_event_is_valid(odp_event_t event)
Check that event is valid.