Open Ethernet Networking (OpEN) API Guide and Reference Manual
3.6.0.3
|
Functions | |
open_error_t | openapiVoipGlobalVlanIdGet (openapiClientHandle_t *client_handle, uint32_t *vlanId) |
Gets the VLAN ID for voip traffic on switch. More... | |
open_error_t | openapiVoipGlobalVlanIdReset (openapiClientHandle_t *client_handle) |
Resets the VLAN ID for voip traffic on switch. More... | |
open_error_t | openapiVoipGlobalVlanIdSet (openapiClientHandle_t *client_handle, uint32_t vlanId) |
Sets the VLAN ID for voip traffic on switch. More... | |
open_error_t | openapiVoipIntfModeGet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_QOS_VOIP_TYPE_t type, OPEN_CONTROL_t *mode) |
Gets the VOIP profile mode on interface. More... | |
open_error_t | openapiVoipIntfModeSet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_QOS_VOIP_TYPE_t type, OPEN_CONTROL_t mode) |
Sets the VOIP profile mode on interface. More... | |
open_error_t | openapiVoipIntfOUIStatusGet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_LINK_STATE_t *val) |
Gets VoIP OUI mode operational port status. More... | |
open_error_t | openapiVoipIntfProtocolStatusGet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_LINK_STATE_t *val) |
Gets VoIP Protocol mode operational port status. More... | |
open_error_t | openapiVoipMaxCallsGet (openapiClientHandle_t *client_handle, uint32_t *maxCalls) |
Get the maximum number of Auto-VoIP calls supported. More... | |
open_error_t | openapiVoipNumActiveProtocolSessionsGet (openapiClientHandle_t *client_handle, uint32_t *sessions) |
Gets VoIP Protocol Mode Active Sessions. More... | |
open_error_t | openapiVoipOUIPriorityGet (openapiClientHandle_t *client_handle, uint32_t *priority) |
Gets the priority for voip traffic on switch. More... | |
open_error_t | openapiVoipOUIPrioritySet (openapiClientHandle_t *client_handle, uint32_t priority) |
Sets the priority for voip traffic on switch. More... | |
open_error_t | openapiVoipProfileCosQueueGet (openapiClientHandle_t *client_handle, OPEN_VOIP_PRI_SCHEME_t *pType, uint32_t *pTypeVal) |
Gets the VOIP profile Cos Queue. More... | |
open_error_t | openapiVoipProfileCosQueueSet (openapiClientHandle_t *client_handle, OPEN_VOIP_PRI_SCHEME_t pType, uint32_t pTypeVal) |
Sets the VOIP profile cos queue. More... | |
open_error_t openapiVoipGlobalVlanIdGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t * | vlanId | ||
) |
Gets the VLAN ID for voip traffic on switch.
[in] | client_handle | client handle from registration API |
[out] | vlanId | VLAN ID |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_INTERNAL | Other Internal Failure. |
OpEN API Version: 1.19
open_error_t openapiVoipGlobalVlanIdReset | ( | openapiClientHandle_t * | client_handle | ) |
Resets the VLAN ID for voip traffic on switch.
[in] | client_handle | client handle from registration API |
OPEN_E_NONE | Set successful. |
OPEN_E_FAIL | Set failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_INTERNAL | Other Internal Failure. |
OpEN API Version: 1.19
open_error_t openapiVoipGlobalVlanIdSet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | vlanId | ||
) |
Sets the VLAN ID for voip traffic on switch.
[in] | client_handle | client handle from registration API |
[in] | vlanId | VLAN ID |
OPEN_E_NONE | Set successful. |
OPEN_E_FAIL | Set failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_INTERNAL | Other Internal Failure. |
OpEN API Version: 1.19
open_error_t openapiVoipIntfModeGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | ifNum, | ||
OPEN_QOS_VOIP_TYPE_t | type, | ||
OPEN_CONTROL_t * | mode | ||
) |
Gets the VOIP profile mode on interface.
[in] | client_handle | client handle from registration API |
[in] | ifNum | interface to be configured |
[in] | type | Auto VoIP type (protocol/OUI based) |
[out] | mode | Mode value |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_INTERNAL | Other Internal Failure. |
OpEN API Version: 1.19
open_error_t openapiVoipIntfModeSet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | ifNum, | ||
OPEN_QOS_VOIP_TYPE_t | type, | ||
OPEN_CONTROL_t | mode | ||
) |
Sets the VOIP profile mode on interface.
[in] | client_handle | client handle from registration API |
[in] | ifNum | interface to be configured |
[in] | type | Auto VoIP type (protocol/OUI based) |
[in] | mode | Mode value |
OPEN_E_NONE | Set successful. |
OPEN_E_FAIL | Set failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_INTERNAL | Other Internal Failure. |
OpEN API Version: 1.19
open_error_t openapiVoipIntfOUIStatusGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | ifNum, | ||
OPEN_LINK_STATE_t * | val | ||
) |
Gets VoIP OUI mode operational port status.
[in] | client_handle | client handle from registration API |
[in] | ifNum | Interface to be configured |
[out] | val | Operational status (UP or DOWN) |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_INTERNAL | Other Internal Failure. |
OpEN API Version: 1.19
open_error_t openapiVoipIntfProtocolStatusGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | ifNum, | ||
OPEN_LINK_STATE_t * | val | ||
) |
Gets VoIP Protocol mode operational port status.
[in] | client_handle | client handle from registration API |
[in] | ifNum | Interface to be configured |
[out] | val | Operational status (UP or DOWN) |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_INTERNAL | Other Internal Failure. |
OpEN API Version: 1.19
open_error_t openapiVoipMaxCallsGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t * | maxCalls | ||
) |
Get the maximum number of Auto-VoIP calls supported.
[in] | client_handle | client handle from registration API |
[out] | maxCalls | maximum number of Auto-VoIP calls |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_INTERNAL | Other Internal Failure. |
OpEN API Version: 1.19
open_error_t openapiVoipNumActiveProtocolSessionsGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t * | sessions | ||
) |
Gets VoIP Protocol Mode Active Sessions.
[in] | client_handle | client handle from registration API |
[out] | sessions | number of Auto-VoIP sessions |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_INTERNAL | Other Internal Failure. |
OpEN API Version: 1.19
open_error_t openapiVoipOUIPriorityGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t * | priority | ||
) |
Gets the priority for voip traffic on switch.
[in] | client_handle | client handle from registration API |
[out] | priority | priority value |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_INTERNAL | Other Internal Failure. |
OpEN API Version: 1.19
open_error_t openapiVoipOUIPrioritySet | ( | openapiClientHandle_t * | client_handle, |
uint32_t | priority | ||
) |
Sets the priority for voip traffic on switch.
[in] | client_handle | client handle from registration API |
[in] | priority | priority value |
OPEN_E_NONE | Set successful. |
OPEN_E_FAIL | Set failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_INTERNAL | Other Internal Failure. |
OpEN API Version: 1.19
open_error_t openapiVoipProfileCosQueueGet | ( | openapiClientHandle_t * | client_handle, |
OPEN_VOIP_PRI_SCHEME_t * | pType, | ||
uint32_t * | pTypeVal | ||
) |
Gets the VOIP profile Cos Queue.
[in] | client_handle | client handle from registration API |
[out] | pType | priScheme (remark or traffic-class) |
[out] | pTypeVal | value |
OPEN_E_NONE | Get successful. |
OPEN_E_FAIL | Get failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_INTERNAL | Other Internal Failure. |
OpEN API Version: 1.19
open_error_t openapiVoipProfileCosQueueSet | ( | openapiClientHandle_t * | client_handle, |
OPEN_VOIP_PRI_SCHEME_t | pType, | ||
uint32_t | pTypeVal | ||
) |
Sets the VOIP profile cos queue.
[in] | client_handle | client handle from registration API |
[in] | pType | priScheme (remark or traffic-class) |
[in] | pTypeVal | value |
OPEN_E_NONE | Set successful. |
OPEN_E_FAIL | Set failed. |
OPEN_E_PARAM | Error in parameter passed. |
OPEN_E_INTERNAL | Other Internal Failure. |
OpEN API Version: 1.19