This document provides a brief description of the FlowControl OpEN APIs. It provides the following services:

Get the Flow Control mode of the system.
Set the Flow Control mode of the system.
Get the Flow Control mode of the interafce.
Set the Flow Control mode of the interafce.
Get the Flow Control operational mode of the interafce.
Get the pause frames receive count of the interafce.
Get the pause frames transmit count of the interafce.

Example C Application flow_control_example

Initialization

In the main function, the sample application initializes the OpEN API RPC service by calling openapiClientRegister() and waits for the RPC service in switchdrvr to start. A Client Handle is returned by openapiClientRegister() which is used while invoking the OpEN APIs. The application then exercises the associated OpEN APIs and logs informational and/or error messages on the console. The example application runs to its completion and exits.

flow_control_example

flow_control_example.c is a sample application that demonstrates the use of OpEN's FlowControl APIs. flow_control_example is started from the command line and can be used to exercise the various APIs by specifying arguments on the command line.

Sample Output

Usage: ./flow_control_example <test#> <arg1> <arg2> ...
Test 1: Get the Flow Control mode of the system: flow_control_example 1
Test 2: Set the Flow Control mode of the system: flow_control_example 2 <mode>
Test 3: Get the Flow Control mode of the interafce: flow_control_example 3 <ifNum>
Test 4: Set the Flow Control mode of the interafce: flow_control_example 4 <ifNum> <mode>
Test 5: Get the Flow Control operational mode of the interafce: flow_control_example 5 <ifNum>
Test 6: Get the pause frames receive count of the interafce: flow_control_example 6 <ifNum>
Test 7: Get the pause frames transmit count of the interafce: flow_control_example 7 <ifNum>

FlowControl CLI/API Cross Reference

CLI Command	OpEN API Reference
(Priv-User Mode)# show flowcontrol	openapiFlowControlModeGet() openapiFlowControlIfModeGet() openapiFlowControlIfOperModeGet() openapiFlowControlIfPauseFramesRxGet() openapiFlowControlIfPauseFramesTxGet()
(Config)# [no] flowcontrol {asymmetric \| symmetric}	openapiFlowControlModeSet()
(Interface-Config Mode)# [no] storm-control flowcontrol {asymmetric \| symmetric}	openapiFlowControlIfModeSet()