|
Open Ethernet Networking (OpEN) API Guide and Reference Manual
3.13.1.2
|
Functions | |
| open_error_t | openapiDiffServClassCreate (openapiClientHandle_t *client_handle, open_buffdesc *className, OPEN_DIFFSERV_CLASS_TYPE_t classType, OPEN_DIFFSERV_CLASS_L3PROTOCOL_t classL3Protocol) |
| Create the DiffServ class. More... | |
| open_error_t | openapiDiffServClassDelete (openapiClientHandle_t *client_handle, uint32_t classIndex) |
| Delete the DiffServ class. More... | |
| open_error_t | openapiDiffServClassGetNext (openapiClientHandle_t *client_handle, uint32_t classIndex, uint32_t *classIndexNext) |
| Determine next sequential row in the Class Table. More... | |
| open_error_t | openapiDiffServClassL3ProtoGet (openapiClientHandle_t *client_handle, uint32_t classIndex, OPEN_DIFFSERV_CLASS_L3PROTOCOL_t *classProtoType) |
| Get the class L3 protocol. More... | |
| open_error_t | openapiDiffServClassNameGet (openapiClientHandle_t *client_handle, uint32_t classIndex, open_buffdesc *className) |
| Get the class name for the given class index. More... | |
| open_error_t | openapiDiffServClassNameToIndex (openapiClientHandle_t *client_handle, open_buffdesc *className, uint32_t *classIndex) |
| Translate a class name into its associated Class Table index. More... | |
| open_error_t | openapiDiffServClassRuleCountGet (openapiClientHandle_t *client_handle, uint32_t classIndex, uint32_t *ruleCount) |
| Get the number of match rules in the Class. More... | |
| open_error_t | openapiDiffServClassRuleCreate (openapiClientHandle_t *client_handle, uint32_t classIndex, OPEN_DIFFSERV_CLASS_RULE_TYPE_t ruleType, open_buffdesc *ruleVal1, open_buffdesc *ruleVal2) |
| Create a new rule in the Class Rule Table for the specified indexes. More... | |
| open_error_t | openapiDiffServClassRuleGetNext (openapiClientHandle_t *client_handle, uint32_t classIndex, uint32_t classRuleIndex, uint32_t *nextClassIndex, uint32_t *nextClassRuleIndex) |
| Determine next sequential row in the Class rule Table. More... | |
| open_error_t | openapiDiffServClassRuleMatchEntryTypeGet (openapiClientHandle_t *client_handle, uint32_t classIndex, uint32_t classRuleIndex, OPEN_DIFFSERV_CLASS_RULE_TYPE_t *ruleType) |
| Get the Class Rule match entry type. More... | |
| open_error_t | openapiDiffServClassRuleMatchEntryValueGet (openapiClientHandle_t *client_handle, uint32_t classIndex, uint32_t classRuleIndex, OPEN_DIFFSERV_CLASS_RULE_TYPE_t ruleType, open_buffdesc *ruleVal1, open_buffdesc *ruleVal2) |
| Get the Class Rule match entry type value. More... | |
| open_error_t | openapiDiffServClassRuleMatchRefClassRemove (openapiClientHandle_t *client_handle, uint32_t classIndex, open_buffdesc *refClassName) |
| Remove the referenced class from the specified class. More... | |
| open_error_t | openapiDiffServClassTypeGet (openapiClientHandle_t *client_handle, uint32_t classIndex, OPEN_DIFFSERV_CLASS_TYPE_t *classType) |
| Get the class type. More... | |
Values for DiffServ Class Layer3 Protocol type.
| Enumerator | |
|---|---|
| OPEN_DIFFSERV_CLASS_L3PROTOCOL_IPV4 |
Class Protocol type : IPV4. |
| OPEN_DIFFSERV_CLASS_L3PROTOCOL_IPV6 |
Class Protocol type : IPV6. |
Definition at line 53 of file openapi_diffserv_class_conf.h.
Values for DiffServ Class Rule types supported as match conditions.
Definition at line 61 of file openapi_diffserv_class_conf.h.
Values for DiffServ Class type.
| Enumerator | |
|---|---|
| OPEN_DIFFSERV_CLASS_TYPE_ALL |
Class Type : Match Any. |
| OPEN_DIFFSERV_CLASS_TYPE_ANY |
Class Type : Match All. |
Definition at line 45 of file openapi_diffserv_class_conf.h.
QOS Ethertype keyword list.
Definition at line 93 of file openapi_diffserv_class_conf.h.
| open_error_t openapiDiffServClassCreate | ( | openapiClientHandle_t * | client_handle, |
| open_buffdesc * | className, | ||
| OPEN_DIFFSERV_CLASS_TYPE_t | classType, | ||
| OPEN_DIFFSERV_CLASS_L3PROTOCOL_t | classL3Protocol | ||
| ) |
Create the DiffServ class.
| [in] | client_handle | Client handle from registration API |
| [in] | className | class name |
| [in] | classType | class type |
| [in] | classL3Protocol | class L3 protocol |
| OPEN_E_NONE | if class is created successfully |
| OPEN_E_FAIL | if failed to create class |
| OPEN_E_PARAM | if invalid parameter is passed |
| OPEN_E_ERROR | if invalid configuration |
| OPEN_E_EXISTS | if class name already exists |
| OPEN_E_FULL | if class table is full |
| OPEN_E_UNAVAIL | if feature is not supported |
OpEN API Version: 1.26
| open_error_t openapiDiffServClassDelete | ( | openapiClientHandle_t * | client_handle, |
| uint32_t | classIndex | ||
| ) |
Delete the DiffServ class.
| [in] | client_handle | Client handle from registration API |
| [in] | classIndex | class index |
| OPEN_E_NONE | if class is deleted successfully |
| OPEN_E_FAIL | if failed to create class |
| OPEN_E_PARAM | if invalid parameter is passed |
OpEN API Version: 1.26
| open_error_t openapiDiffServClassGetNext | ( | openapiClientHandle_t * | client_handle, |
| uint32_t | classIndex, | ||
| uint32_t * | classIndexNext | ||
| ) |
Determine next sequential row in the Class Table.
| [in] | client_handle | Client handle from registration API |
| [in] | classIndex | Class index to begin search |
| [out] | classIndexNext | Pointer to next sequential class index value |
| OPEN_E_NONE | if next class index is retrieved |
| OPEN_E_FAIL | if failed to get class index |
| OPEN_E_PARAM | if invalid parameter is passed |
OpEN API Version: 1.26
| open_error_t openapiDiffServClassL3ProtoGet | ( | openapiClientHandle_t * | client_handle, |
| uint32_t | classIndex, | ||
| OPEN_DIFFSERV_CLASS_L3PROTOCOL_t * | classProtoType | ||
| ) |
Get the class L3 protocol.
| [in] | client_handle | Client handle from registration API |
| [in] | classIndex | Class index |
| [out] | classProtoType | Class L3 protocol |
| OPEN_E_NONE | if class protocol is retrieved |
| OPEN_E_FAIL | if failed to get class protocol |
| OPEN_E_PARAM | if invalid parameter is passed |
OpEN API Version: 1.26
| open_error_t openapiDiffServClassNameGet | ( | openapiClientHandle_t * | client_handle, |
| uint32_t | classIndex, | ||
| open_buffdesc * | className | ||
| ) |
Get the class name for the given class index.
| [in] | client_handle | Client handle from registration API |
| [in] | classIndex | Class index |
| [out] | className | Class name |
| OPEN_E_NONE | if class name is retrieved |
| OPEN_E_FAIL | if failed to get class name |
| OPEN_E_PARAM | if invalid parameter is passed |
OpEN API Version: 1.26
| open_error_t openapiDiffServClassNameToIndex | ( | openapiClientHandle_t * | client_handle, |
| open_buffdesc * | className, | ||
| uint32_t * | classIndex | ||
| ) |
Translate a class name into its associated Class Table index.
| [in] | client_handle | Client handle from registration API |
| [in] | className | class name |
| [out] | classIndex | class index |
| OPEN_E_NONE | if class name is translated to class index |
| OPEN_E_FAIL | if failed to translate class name |
| OPEN_E_PARAM | if invalid parameter is passed |
OpEN API Version: 1.26
| open_error_t openapiDiffServClassRuleCountGet | ( | openapiClientHandle_t * | client_handle, |
| uint32_t | classIndex, | ||
| uint32_t * | ruleCount | ||
| ) |
Get the number of match rules in the Class.
| [in] | client_handle | Client handle from registration API |
| [in] | classIndex | class index |
| [out] | ruleCount | class rule count |
| OPEN_E_NONE | if rule count is retrieved successfully |
| OPEN_E_FAIL | if failed to get class rule count |
| OPEN_E_PARAM | if invalid parameter is passed |
OpEN API Version: 1.26
| open_error_t openapiDiffServClassRuleCreate | ( | openapiClientHandle_t * | client_handle, |
| uint32_t | classIndex, | ||
| OPEN_DIFFSERV_CLASS_RULE_TYPE_t | ruleType, | ||
| open_buffdesc * | ruleVal1, | ||
| open_buffdesc * | ruleVal2 | ||
| ) |
Create a new rule in the Class Rule Table for the specified indexes.
| [in] | client_handle | Client handle from registration API |
| [in] | classIndex | Class index |
| [in] | ruleType | Class rule type |
| [in] | ruleVal1 | Rule Value 1 |
| [in] | ruleVal2 | Rule value 2 |
| OPEN_E_NONE | if class rule is created successfully |
| OPEN_E_FAIL | if failed to create class rule |
| OPEN_E_PARAM | if invalid parameter is passed |
| OPEN_E_FULL | if class rule table is full |
OpEN API Version: 1.26
| open_error_t openapiDiffServClassRuleGetNext | ( | openapiClientHandle_t * | client_handle, |
| uint32_t | classIndex, | ||
| uint32_t | classRuleIndex, | ||
| uint32_t * | nextClassIndex, | ||
| uint32_t * | nextClassRuleIndex | ||
| ) |
Determine next sequential row in the Class rule Table.
| [in] | client_handle | Client handle from registration API |
| [in] | classIndex | Class index to begin search |
| [in] | classRuleIndex | Class rule index to begin search |
| [out] | nextClassIndex | Pointer to next sequential class index value |
| [out] | nextClassRuleIndex | Pointer to next sequential class rule index value |
| OPEN_E_NONE | if next class index is retrieved |
| OPEN_E_FAIL | if failed to get class index |
| OPEN_E_PARAM | if invalid parameter is passed |
OpEN API Version: 1.26
| open_error_t openapiDiffServClassRuleMatchEntryTypeGet | ( | openapiClientHandle_t * | client_handle, |
| uint32_t | classIndex, | ||
| uint32_t | classRuleIndex, | ||
| OPEN_DIFFSERV_CLASS_RULE_TYPE_t * | ruleType | ||
| ) |
Get the Class Rule match entry type.
| [in] | client_handle | Client handle from registration API |
| [in] | classIndex | class index |
| [in] | classRuleIndex | class rule index |
| [out] | ruleType | class rule type |
| OPEN_E_NONE | if class rule match entry type is retrieved |
| OPEN_E_FAIL | if failed to get rule match entry type |
| OPEN_E_PARAM | if invalid parameter is passed |
OpEN API Version: 1.26
| open_error_t openapiDiffServClassRuleMatchEntryValueGet | ( | openapiClientHandle_t * | client_handle, |
| uint32_t | classIndex, | ||
| uint32_t | classRuleIndex, | ||
| OPEN_DIFFSERV_CLASS_RULE_TYPE_t | ruleType, | ||
| open_buffdesc * | ruleVal1, | ||
| open_buffdesc * | ruleVal2 | ||
| ) |
Get the Class Rule match entry type value.
| [in] | client_handle | Client handle from registration API |
| [in] | classIndex | class index |
| [in] | classRuleIndex | class rule index |
| [in] | ruleType | class rule type |
| [out] | ruleVal1 | Rule Value 1 |
| [out] | ruleVal2 | Rule value 2 |
| OPEN_E_NONE | if class rule match entry type value is retrieved |
| OPEN_E_FAIL | if failed to get rule match entry type value |
| OPEN_E_PARAM | if invalid parameter is passed |
OpEN API Version: 1.26
| open_error_t openapiDiffServClassRuleMatchRefClassRemove | ( | openapiClientHandle_t * | client_handle, |
| uint32_t | classIndex, | ||
| open_buffdesc * | refClassName | ||
| ) |
Remove the referenced class from the specified class.
| [in] | client_handle | Client handle from registration API |
| [in] | classIndex | class index |
| [in] | refClassName | reference class name |
| OPEN_E_NONE | if reference class rule is deleted successfully |
| OPEN_E_FAIL | if failed to create class rule |
| OPEN_E_PARAM | if invalid parameter is passed |
OpEN API Version: 1.26
| open_error_t openapiDiffServClassTypeGet | ( | openapiClientHandle_t * | client_handle, |
| uint32_t | classIndex, | ||
| OPEN_DIFFSERV_CLASS_TYPE_t * | classType | ||
| ) |
Get the class type.
| [in] | client_handle | Client handle from registration API |
| [in] | classIndex | Class index |
| [out] | classType | Class type |
| OPEN_E_NONE | if class type is retrieved |
| OPEN_E_FAIL | if failed to get class type |
| OPEN_E_PARAM | if invalid parameter is passed |
OpEN API Version: 1.26