This Code Implements The OpEN Flow Control API [OPENAPI_FLOW_CONTROL]

Enumerations
enum	OPEN_FLOWCONTROL_OPER_t { OPEN_FLOWCTRL_INACTIVE = 0, OPEN_FLOWCTRL_ACTIVE }
enum	OPEN_FLOWCONTROL_t { OPEN_FLOWCTRL_OFF = 0, OPEN_FLOWCTRL_SYMM, OPEN_FLOWCTRL_ASYMM }

Functions
open_error_t	openapiFlowControlIfModeGet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_FLOWCONTROL_t *mode)
	Get the Flow Control mode of the interafce. More...
open_error_t	openapiFlowControlIfModeSet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_FLOWCONTROL_t mode)
	Set the Flow Control mode of the interafce. More...
open_error_t	openapiFlowControlIfOperModeGet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_FLOWCONTROL_OPER_t *mode)
	Get the Flow Control operational mode of the interafce. More...
open_error_t	openapiFlowControlIfPauseFramesRxGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *rxCount)
	Get the pause frames receive count of the interafce. More...
open_error_t	openapiFlowControlIfPauseFramesTxGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *txCount)
	Get the pause frames transmit count of the interafce. More...
open_error_t	openapiFlowControlModeGet (openapiClientHandle_t *client_handle, OPEN_FLOWCONTROL_t *mode)
	Get the Flow Control mode of the system. More...
open_error_t	openapiFlowControlModeSet (openapiClientHandle_t *client_handle, OPEN_FLOWCONTROL_t mode)
	Set the Flow Control mode of the system. More...

Detailed Description

Enumeration Type Documentation

enum OPEN_FLOWCONTROL_OPER_t

Enumerator
OPEN_FLOWCTRL_INACTIVE	Inactive.
OPEN_FLOWCTRL_ACTIVE	Active.

Definition at line 50 of file openapi_flow_control.h.

enum OPEN_FLOWCONTROL_t

Enumerator
OPEN_FLOWCTRL_OFF	Disable.
OPEN_FLOWCTRL_SYMM	Symmetric.
OPEN_FLOWCTRL_ASYMM	Asymmetric.

Definition at line 43 of file openapi_flow_control.h.

Function Documentation

open_error_t openapiFlowControlIfModeGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		OPEN_FLOWCONTROL_t *	mode
	)

Get the Flow Control mode of the interafce.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	interface
[out]	mode	Flow control mode

Return values

OPEN_E_UNAVAIL	Parameter/feature is not supported.
OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.26

Examples:

flow_control_example.c.

open_error_t openapiFlowControlIfModeSet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		OPEN_FLOWCONTROL_t	mode
	)

Set the Flow Control mode of the interafce.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	interface
[in]	mode	Flow control mode

Return values

OPEN_E_UNAVAIL	Parameter/feature is not supported.
OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note

Calling this API will change the running configuration of the switch

OpEN API Version: 1.26

Examples:

flow_control_example.c.

open_error_t openapiFlowControlIfOperModeGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		OPEN_FLOWCONTROL_OPER_t *	mode
	)

Get the Flow Control operational mode of the interafce.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	interface
[out]	mode	Flow control operational mode

Return values

OPEN_E_UNAVAIL	Parameter/feature is not supported.
OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.26

Examples:

flow_control_example.c.

open_error_t openapiFlowControlIfPauseFramesRxGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		uint32_t *	rxCount
	)

Get the pause frames receive count of the interafce.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	interface
[out]	rxCount	Pause frames receive count

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.26

Examples:

flow_control_example.c.

open_error_t openapiFlowControlIfPauseFramesTxGet	(	openapiClientHandle_t *	client_handle,
		uint32_t	ifNum,
		uint32_t *	txCount
	)

Get the pause frames transmit count of the interafce.

Parameters

[in]	client_handle	client handle from registration API
[in]	ifNum	interface
[out]	txCount	Pause frames transmit count

Return values

OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.26

Examples:

flow_control_example.c.

open_error_t openapiFlowControlModeGet	(	openapiClientHandle_t *	client_handle,
		OPEN_FLOWCONTROL_t *	mode
	)

Get the Flow Control mode of the system.

Parameters

[in]	client_handle	client handle from registration API
[out]	mode	Flow control mode

Return values

OPEN_E_UNAVAIL	Parameter/feature is not supported.
OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

OpEN API Version: 1.26

Examples:

flow_control_example.c.

open_error_t openapiFlowControlModeSet	(	openapiClientHandle_t *	client_handle,
		OPEN_FLOWCONTROL_t	mode
	)

Set the Flow Control mode of the system.

Parameters

[in]	client_handle	client handle from registration API
[in]	mode	Flow control mode

Return values

OPEN_E_UNAVAIL	Parameter/feature is not supported.
OPEN_E_NONE	On success.
OPEN_E_FAIL	On failure.
OPEN_E_PARAM	Invalid argument.

Note

Calling this API will change the running configuration of the switch

OpEN API Version: 1.26

Examples:

flow_control_example.c.