Open Ethernet Networking (OpEN) API Guide and Reference Manual
3.6.0.3
|
Macros | |
#define | OPEN_COS_ALL_QUEUES 0xffffffff |
read all queues, not just one | |
Functions | |
open_error_t | openapiCosQueueCpuDropPacketsGet (openapiClientHandle_t *client_handle, uint32_t qIndex, open_buffdesc *data, uint32_t *count) |
Get the number of CPU packets dropped for a given CoS queue. More... | |
open_error_t | openapiCosQueueCpuTxPacketsGet (openapiClientHandle_t *client_handle, uint32_t qIndex, open_buffdesc *data, uint32_t *count) |
Get the number of CPU packets tx for a given CoS queue. More... | |
open_error_t | openapiCosQueueMcTxPacketsGet (openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t qIndex, open_buffdesc *data, uint32_t *count) |
Get the number of MC packets tx for an interface and CoS queue. More... | |
open_error_t | openapiCosQueueNumQueuesGet (openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t *count) |
Get the number of CoS queues per interface. More... | |
open_error_t | openapiCosQueueUcTxPacketsGet (openapiClientHandle_t *client_handle, uint32_t intIfNum, uint32_t qIndex, open_buffdesc *data, uint32_t *count) |
Get the number of UC packets tx for an interface and CoS queue. More... | |
open_error_t openapiCosQueueCpuDropPacketsGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | qIndex, | ||
open_buffdesc * | data, | ||
uint32_t * | count | ||
) |
Get the number of CPU packets dropped for a given CoS queue.
[in] | client_handle | OpEN client handle |
[in] | qIndex | CoS queue index |
- | Minimum value 0 | |
- | Maximum value openapiCosQueueNumQueuesGet() - 1. Or, use OPEN_COS_ALL_QUEUES to read all queues. | |
[out] | data | Vector containing number of MC packets transmitted for specified interface, queue. Element type is uint64_t. Number of elements is either 1 or return value of openapiCosQueueNumQueuesGet (when qIndex is OPEN_COS_ALL_QUEUES) for the interface the data is being requested. Vector is indexed by CoS queue index. |
[out] | count | How many elements returned in data |
OPEN_E_NONE | Success. |
OPEN_E_FAIL | Other failure occurred. |
OPEN_E_PARAM | Invalid argument. |
OPEN_E_NOT_FOUND | Cosq not available. |
OpEN API Version: 1.14
open_error_t openapiCosQueueCpuTxPacketsGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | qIndex, | ||
open_buffdesc * | data, | ||
uint32_t * | count | ||
) |
Get the number of CPU packets tx for a given CoS queue.
[in] | client_handle | OpEN client handle |
[in] | qIndex | CoS queue index |
- | Minimum value 0 | |
- | Maximum value openapiCosQueueNumQueuesGet() - 1. Or, use OPEN_COS_ALL_QUEUES to read all queues. | |
[out] | data | Vector containing number of MC packets transmitted for specified interface, queue. Element type is uint64_t. Number of elements is either 1 or return value of openapiCosQueueNumQueuesGet (when qIndex is OPEN_COS_ALL_QUEUES) for the interface the data is being requested. Vector is indexed by CoS queue index. |
[out] | count | How many elements returned in data |
OPEN_E_NONE | Success. |
OPEN_E_FAIL | Other failure occurred. |
OPEN_E_PARAM | Invalid argument. |
OPEN_E_NOT_FOUND | Cosq not available. |
OpEN API Version: 1.14
open_error_t openapiCosQueueMcTxPacketsGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | intIfNum, | ||
uint32_t | qIndex, | ||
open_buffdesc * | data, | ||
uint32_t * | count | ||
) |
Get the number of MC packets tx for an interface and CoS queue.
[in] | client_handle | OpEN client handle |
[in] | intIfNum | Interface number |
[in] | qIndex | CoS queue index |
- | Minimum value 0 | |
- | Maximum value openapiCosQueueNumQueuesGet() - 1. Or, use OPEN_COS_ALL_QUEUES to read all queues. | |
[out] | data | Vector containing number of MC packets transmitted for specified interface, queue. Element type is uint64_t. Number of elements is either 1 or return value of openapiCosQueueNumQueuesGet (when qIndex is OPEN_COS_ALL_QUEUES) for the interface the data is being requested. Vector is indexed by CoS queue index. |
[out] | count | How many elements returned in data |
OPEN_E_NONE | Success. |
OPEN_E_FAIL | Other failure occurred. |
OPEN_E_PARAM | Invalid argument. |
OPEN_E_NOT_FOUND | Either interface or cosq not available. |
OpEN API Version: 1.14
open_error_t openapiCosQueueNumQueuesGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | intIfNum, | ||
uint32_t * | count | ||
) |
Get the number of CoS queues per interface.
[in] | client_handle | OpEN client handle |
[in] | intIfNum | Interface number |
[out] | count | Number of CoS queues per unit. |
OPEN_E_NONE | Success. |
OPEN_E_PARAM | Invalid argument. |
OPEN_E_FAIL | Failure occurred. |
OpEN API Version: 1.14
open_error_t openapiCosQueueUcTxPacketsGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | intIfNum, | ||
uint32_t | qIndex, | ||
open_buffdesc * | data, | ||
uint32_t * | count | ||
) |
Get the number of UC packets tx for an interface and CoS queue.
[in] | client_handle | OpEN client handle |
[in] | intIfNum | Interface number |
[in] | qIndex | CoS queue index |
- | Minimum value 0 | |
- | Maximum value openapiCosQueueNumQueuesGet() - 1. Or, use OPEN_COS_ALL_QUEUES to read all queues. | |
[out] | data | Vector containing number of UC packets transmitted for specified interface, queue. Element type is uint64_t. Number of elements is either 1 or return value of openapiCosQueueNumQueuesGet (when qIndex is OPEN_COS_ALL_QUEUES) for the interface the data is being requested. Vector is indexed by CoS queue index. |
[out] | count | How many elements returned in data |
OPEN_E_NONE | Success. |
OPEN_E_PARAM | Invalid argument. |
OPEN_E_FAIL | Other failure occurred. |
OPEN_E_NOT_FOUND | Either interface or cosq not available. |
OpEN API Version: 1.14