Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.6.0.3
Macros | Functions
Switch Cosq Statistics [OPENAPI_COS_STATS]

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...
 

Detailed Description

Function Documentation

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.

Parameters
[in]client_handleOpEN client handle
[in]qIndexCoS queue index
-Minimum value 0
-Maximum value openapiCosQueueNumQueuesGet() - 1. Or, use OPEN_COS_ALL_QUEUES to read all queues.
[out]dataVector 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]countHow many elements returned in data
Return values
OPEN_E_NONESuccess.
OPEN_E_FAILOther failure occurred.
OPEN_E_PARAMInvalid argument.
OPEN_E_NOT_FOUNDCosq not available.

OpEN API Version: 1.14

Examples:
cosq_stats_example.c.
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.

Parameters
[in]client_handleOpEN client handle
[in]qIndexCoS queue index
-Minimum value 0
-Maximum value openapiCosQueueNumQueuesGet() - 1. Or, use OPEN_COS_ALL_QUEUES to read all queues.
[out]dataVector 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]countHow many elements returned in data
Return values
OPEN_E_NONESuccess.
OPEN_E_FAILOther failure occurred.
OPEN_E_PARAMInvalid argument.
OPEN_E_NOT_FOUNDCosq not available.

OpEN API Version: 1.14

Examples:
cosq_stats_example.c.
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.

Parameters
[in]client_handleOpEN client handle
[in]intIfNumInterface number
[in]qIndexCoS queue index
-Minimum value 0
-Maximum value openapiCosQueueNumQueuesGet() - 1. Or, use OPEN_COS_ALL_QUEUES to read all queues.
[out]dataVector 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]countHow many elements returned in data
Return values
OPEN_E_NONESuccess.
OPEN_E_FAILOther failure occurred.
OPEN_E_PARAMInvalid argument.
OPEN_E_NOT_FOUNDEither interface or cosq not available.

OpEN API Version: 1.14

Examples:
cosq_stats_example.c.
open_error_t openapiCosQueueNumQueuesGet ( openapiClientHandle_t client_handle,
uint32_t  intIfNum,
uint32_t *  count 
)

Get the number of CoS queues per interface.

Parameters
[in]client_handleOpEN client handle
[in]intIfNumInterface number
[out]countNumber of CoS queues per unit.
Return values
OPEN_E_NONESuccess.
OPEN_E_PARAMInvalid argument.
OPEN_E_FAILFailure occurred.

OpEN API Version: 1.14

Examples:
cosq_stats_example.c.
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.

Parameters
[in]client_handleOpEN client handle
[in]intIfNumInterface number
[in]qIndexCoS queue index
-Minimum value 0
-Maximum value openapiCosQueueNumQueuesGet() - 1. Or, use OPEN_COS_ALL_QUEUES to read all queues.
[out]dataVector 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]countHow many elements returned in data
Return values
OPEN_E_NONESuccess.
OPEN_E_PARAMInvalid argument.
OPEN_E_FAILOther failure occurred.
OPEN_E_NOT_FOUNDEither interface or cosq not available.

OpEN API Version: 1.14

Examples:
cosq_stats_example.c.