TM queue parameters. More...

#include <traffic_mngr.h>

Data Fields
void *	user_context
	The user_context field is an generic pointer that the user can associate with a tm_queue and then get this same value back using the odp_tm_queue_context() call.

odp_tm_shaper_t	shaper_profile
	The shaper profile to be associated with this tm_queue. More...

odp_tm_threshold_t	threshold_profile
	The threshold profile to be used in setting the max queue fullness for WRED and/or tail drop. More...

odp_tm_wred_t	wred_profile [ODP_NUM_PACKET_COLORS]
	The WRED profile(s) to be associated with this tm_queue. More...

uint8_t	priority
	The strict priority level assigned to packets in this tm_queue - in other words all packets associated with a given tm_queue MUST have the same single strict priority level and this level must be in the range 0..max_priority. More...

odp_bool_t	ordered_enqueue
	Maintain original packet order of the source queue when enqueuing packets to this queue while holding ordered or atomic queue synchronization context. More...

Detailed Description

TM queue parameters.

Use odp_tm_queue_params_init() to initialize parameters into their default values.

Examples: odp_traffic_mgmt.c.

Definition at line 1749 of file api/spec/traffic_mngr.h.

Field Documentation

◆ shaper_profile

odp_tm_shaper_t odp_tm_queue_params_t::shaper_profile

The shaper profile to be associated with this tm_queue.

Can be ODP_TM_INVALID and can also be set and changed post-creation via odp_tm_queue_shaper_config(). The default value is ODP_TM_INVALID.

Examples: odp_traffic_mgmt.c.

Definition at line 1758 of file api/spec/traffic_mngr.h.

◆ threshold_profile

odp_tm_threshold_t odp_tm_queue_params_t::threshold_profile

The threshold profile to be used in setting the max queue fullness for WRED and/or tail drop.

Can be ODP_TM_INVALID and can also be set and changed post-creation via odp_tm_queue_threshold_config(). The default value is ODP_TM_INVALID.

One can specify the maximum queue limits either as a maximum number of packets in the queue or as a maximum number of bytes in the queue, or if both are specified, then whichever limit is hit first.

Examples: odp_traffic_mgmt.c.

Definition at line 1768 of file api/spec/traffic_mngr.h.

◆ wred_profile

odp_tm_wred_t odp_tm_queue_params_t::wred_profile[ODP_NUM_PACKET_COLORS]

The WRED profile(s) to be associated with this tm_queue.

Any or all array elements can be ODP_TM_INVALID and can also be set and changed post-creation via odp_tm_queue_wred_config(). The default value is ODP_TM_INVALID for every color.

Examples: odp_traffic_mgmt.c.

Definition at line 1774 of file api/spec/traffic_mngr.h.

◆ priority

uint8_t odp_tm_queue_params_t::priority

The strict priority level assigned to packets in this tm_queue - in other words all packets associated with a given tm_queue MUST have the same single strict priority level and this level must be in the range 0..max_priority.

The default value is 0.

Examples: odp_traffic_mgmt.c.

Definition at line 1780 of file api/spec/traffic_mngr.h.

◆ ordered_enqueue

odp_bool_t odp_tm_queue_params_t::ordered_enqueue

Maintain original packet order of the source queue when enqueuing packets to this queue while holding ordered or atomic queue synchronization context.

Default value of this flag is true.

Definition at line 1786 of file api/spec/traffic_mngr.h.

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

api/spec/traffic_mngr.h