Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.13.1.2
Macros | Enumerations | Functions
openapi_diffserv_policy.h File Reference
#include "openapi_common.h"

Go to the source code of this file.

Macros

#define OPEN_DIFFSERV_POLICY_NAME_MAX   31
 
#define OPEN_DIFFSERV_POLICY_NAME_MIN   1
 

Enumerations

enum  OPEN_BURST_POLICE_TYPE_t {
  OPEN_BURST_POLICE_TWORATE_NONE = 0, OPEN_BURST_POLICE_TWORATE_CBURST, OPEN_BURST_POLICE_TWORATE_PBURST, OPEN_BURST_POLICE_SINGLERATE_CBURST,
  OPEN_BURST_POLICE_SINGLERATE_EBURST, OPEN_BURST_POLICE_SIMPLE_CBURST
}
 
enum  OPEN_DIFFSERV_POLICE_ACT_t {
  OPEN_DIFFSERV_POLICE_ACT_NONE = 0, OPEN_DIFFSERV_POLICE_ACT_DROP, OPEN_DIFFSERV_POLICE_ACT_MARKCOS, OPEN_DIFFSERV_POLICE_ACT_MARKCOS2,
  OPEN_DIFFSERV_POLICE_ACT_MARKCOS_AS_COS2, OPEN_DIFFSERV_POLICE_ACT_MARKDSCP, OPEN_DIFFSERV_POLICE_ACT_MARKPREC, OPEN_DIFFSERV_POLICE_ACT_SEND
}
 
enum  OPEN_DIFFSERV_POLICY_ATTR_TYPE_t {
  OPEN_DIFFSERV_POLICY_ATTR_TYPE_NONE = 0, OPEN_DIFFSERV_POLICY_ATTR_TYPE_ASSIGN_QUEUE, OPEN_DIFFSERV_POLICY_ATTR_TYPE_DROP, OPEN_DIFFSERV_POLICY_ATTR_TYPE_MARK_COSVAL,
  OPEN_DIFFSERV_POLICY_ATTR_TYPE_MARK_COS2VAL, OPEN_DIFFSERV_POLICY_ATTR_TYPE_MARK_COS_AS_COS2, OPEN_DIFFSERV_POLICY_ATTR_TYPE_MARK_IPDSCPVAL, OPEN_DIFFSERV_POLICY_ATTR_TYPE_MARK_IPPRECEDENCEVAL,
  OPEN_DIFFSERV_POLICY_ATTR_TYPE_MIRROR, OPEN_DIFFSERV_POLICY_ATTR_TYPE_POLICE_SIMPLE, OPEN_DIFFSERV_POLICY_ATTR_TYPE_POLICE_SINGLERATE, OPEN_DIFFSERV_POLICY_ATTR_TYPE_POLICE_TWORATE,
  OPEN_DIFFSERV_POLICY_ATTR_TYPE_REDIRECT
}
 
enum  OPEN_DIFFSERV_POLICY_TYPE_t { OPEN_DIFFSERV_POLICY_TYPE_NONE = 0, OPEN_DIFFSERV_POLICY_TYPE_IN, OPEN_DIFFSERV_POLICY_TYPE_OUT }
 
enum  OPEN_DIFFSERV_ROW_STATUS_t {
  OPEN_DIFFSERV_ROW_STATUS_NONE = 0, OPEN_DIFFSERV_ROW_STATUS_ACTIVE, OPEN_DIFFSERV_ROW_STATUS_NOT_IN_SERVICE, OPEN_DIFFSERV_ROW_STATUS_NOT_READY,
  OPEN_DIFFSERV_ROW_STATUS_CREATE_AND_GO, OPEN_DIFFSERV_ROW_STATUS_CREATE_AND_WAIT, OPEN_DIFFSERV_ROW_STATUS_DESTROY
}
 
enum  OPEN_DIFFSERV_STORAGE_TYPE_t {
  OPEN_DIFFSERV_STORAGE_TYPE_NONE = 0, OPEN_DIFFSERV_STORAGE_TYPE_OTHER, OPEN_DIFFSERV_STORAGE_TYPE_VOLATILE, OPEN_DIFFSERV_STORAGE_TYPE_NONVOLATILE,
  OPEN_DIFFSERV_STORAGE_TYPE_READONLY, OPEN_DIFFSERV_STORAGE_TYPE_PERMANENT
}
 

Functions

open_error_t openapiDiffServClassValidForPolicyCheck (openapiClientHandle_t *client_handle, uint32_t classIndex, uint32_t policyIndex)
 Check if class definition is suitable for inclusion by specified policy. More...
 
open_error_t openapiDiffServPolicyAttrCreate (openapiClientHandle_t *client_handle, uint32_t policyIndex, uint32_t policyInstIndex, uint32_t policyAttrIndex, OPEN_BOOL_t activateRow)
 Create a new row in the Policy Attribute Table for the specified index. More...
 
open_error_t openapiDiffServPolicyAttrDelete (openapiClientHandle_t *client_handle, uint32_t policyIndex, uint32_t policyInstIndex, uint32_t policyAttrIndex)
 Delete a row from the Policy Attribute Table for the specified index. More...
 
open_error_t openapiDiffServPolicyAttrGetNext (openapiClientHandle_t *client_handle, uint32_t prevPolicyIndex, uint32_t prevPolicyInstIndex, uint32_t prevPolicyAttrIndex, uint32_t *pPolicyIndex, uint32_t *pPolicyInstIndex, uint32_t *pPolicyAttrIndex)
 Determine next sequential row in the Policy Attribute Table. More...
 
open_error_t openapiDiffServPolicyAttrIndexFind (openapiClientHandle_t *client_handle, uint32_t policyIndex, uint32_t policyInstIndex, OPEN_DIFFSERV_POLICY_ATTR_TYPE_t inEntry, uint32_t *pPolicyAttrIndex)
 Find the Policy Attribute index for the specified attribute. More...
 
open_error_t openapiDiffServPolicyAttrIndexMaxGet (openapiClientHandle_t *client_handle, uint32_t *pIndexMax)
 Retrieve the maximum policy attribute index value allowed for the Policy Attribute Table. More...
 
open_error_t openapiDiffServPolicyAttrIndexNext (openapiClientHandle_t *client_handle, uint32_t policyIndex, uint32_t policyInstIndex, uint32_t *pPolicyAttrIndex)
 Obtain the next available index value to be used when creating a new row in the Policy Attribute Table. More...
 
open_error_t openapiDiffServPolicyAttrRowStatusGet (openapiClientHandle_t *client_handle, uint32_t policyIndex, uint32_t policyInstIndex, uint32_t policyAttrIndex, OPEN_DIFFSERV_ROW_STATUS_t *pValue)
 Get the current status of the specified Policy Attribute Table row. More...
 
open_error_t openapiDiffServPolicyAttrStmtEntryDataGet (openapiClientHandle_t *client_handle, uint32_t policyIndex, uint32_t policyInstIndex, uint32_t policyAttrIndex, OPEN_DIFFSERV_POLICY_ATTR_TYPE_t entryType, uint32_t *data)
 Get the Policy Attribute statement entry associated data. More...
 
open_error_t openapiDiffServPolicyAttrStmtEntryTypeDataSet (openapiClientHandle_t *client_handle, uint32_t policyIndex, uint32_t policyInstIndex, uint32_t policyAttrIndex, OPEN_DIFFSERV_POLICY_ATTR_TYPE_t entryType, uint32_t data)
 Set the Policy Attribute statement entry type and associated data. More...
 
open_error_t openapiDiffServPolicyAttrStmtEntryTypeGet (openapiClientHandle_t *client_handle, uint32_t policyIndex, uint32_t policyInstIndex, uint32_t policyAttrIndex, OPEN_DIFFSERV_POLICY_ATTR_TYPE_t *pEntryType)
 Get the Policy Attribute statement entry type. More...
 
open_error_t openapiDiffServPolicyAttrStmtPoliceBurstGet (openapiClientHandle_t *client_handle, uint32_t policyIndex, uint32_t policyInstIndex, uint32_t policyAttrIndex, OPEN_DIFFSERV_POLICY_ATTR_TYPE_t entryType, OPEN_BURST_POLICE_TYPE_t burstType, uint32_t *burst)
 Get the policing committed burst size attribute statement value. More...
 
open_error_t openapiDiffServPolicyAttrStmtPoliceBurstSet (openapiClientHandle_t *client_handle, uint32_t policyIndex, uint32_t policyInstIndex, uint32_t policyAttrIndex, OPEN_DIFFSERV_POLICY_ATTR_TYPE_t entryType, OPEN_BURST_POLICE_TYPE_t burstType, uint32_t burst)
 Set the policing committed burst size attribute statement value. More...
 
open_error_t openapiDiffServPolicyAttrStmtPoliceColorAwareClassValidate (openapiClientHandle_t *client_handle, uint32_t policyIndex, uint32_t policyInstIndex, uint32_t classIndex)
 Determine if a DiffServ class is valid for use as a policing color aware designation. More...
 
open_error_t openapiDiffServPolicyAttrStmtPoliceColorConformIndexGet (openapiClientHandle_t *client_handle, uint32_t policyIndex, uint32_t policyInstIndex, uint32_t policyAttrIndex, uint32_t *pClassIndex)
 Get the policing color conform attribute class index value. More...
 
open_error_t openapiDiffServPolicyAttrStmtPoliceColorConformIndexSet (openapiClientHandle_t *client_handle, uint32_t policyIndex, uint32_t policyInstIndex, uint32_t policyAttrIndex, uint32_t classIndex)
 Set the policing color conform attribute class index value. More...
 
open_error_t openapiDiffServPolicyAttrStmtPoliceColorConformValGet (openapiClientHandle_t *client_handle, uint32_t policyIndex, uint32_t policyInstIndex, uint32_t policyAttrIndex, uint32_t *pVal)
 Get the policing color conform value attribute statement value. More...
 
open_error_t openapiDiffServPolicyAttrStmtPoliceColorExceedIndexGet (openapiClientHandle_t *client_handle, uint32_t policyIndex, uint32_t policyInstIndex, uint32_t policyAttrIndex, uint32_t *pClassIndex)
 Get the policing color exceed attribute class index value. More...
 
open_error_t openapiDiffServPolicyAttrStmtPoliceColorExceedIndexSet (openapiClientHandle_t *client_handle, uint32_t policyIndex, uint32_t policyInstIndex, uint32_t policyAttrIndex, uint32_t classIndex)
 Set the policing color exceed attribute class index value. More...
 
open_error_t openapiDiffServPolicyAttrStmtPoliceConformActGet (openapiClientHandle_t *client_handle, uint32_t policyIndex, uint32_t policyInstIndex, uint32_t policyAttrIndex, OPEN_DIFFSERV_POLICE_ACT_t *action)
 Get the policing conform action attribute statement value. More...
 
open_error_t openapiDiffServPolicyAttrStmtPoliceConformActSet (openapiClientHandle_t *client_handle, uint32_t policyIndex, uint32_t policyInstIndex, uint32_t policyAttrIndex, OPEN_DIFFSERV_POLICE_ACT_t action)
 Set the policing conform action attribute statement value. More...
 
open_error_t openapiDiffServPolicyAttrStmtPoliceConformValGet (openapiClientHandle_t *client_handle, uint32_t policyIndex, uint32_t policyInstIndex, uint32_t policyAttrIndex, uint32_t *value)
 Get the policing conform value attribute statement value. More...
 
open_error_t openapiDiffServPolicyAttrStmtPoliceConformValSet (openapiClientHandle_t *client_handle, uint32_t policyIndex, uint32_t policyInstIndex, uint32_t policyAttrIndex, uint32_t value)
 Set the policing conform value attribute statement value. More...
 
open_error_t openapiDiffServPolicyAttrStmtPoliceDataRatePercentGet (openapiClientHandle_t *client_handle, uint32_t policyIndex, uint32_t policyInstIndex, uint32_t policyAttrIndex, OPEN_DIFFSERV_POLICY_ATTR_TYPE_t entryType, uint32_t *pRate_percent)
 Get the policing committed rate attribute statement value. More...
 
open_error_t openapiDiffServPolicyAttrStmtPoliceDataRateSet (openapiClientHandle_t *client_handle, uint32_t policyIndex, uint32_t policyInstIndex, uint32_t policyAttrIndex, OPEN_DIFFSERV_POLICY_ATTR_TYPE_t entryType, OPEN_RATE_UNIT_t rate_unit, uint32_t rate)
 Set the simple policing committed rate attribute statement value. More...
 
open_error_t openapiDiffServPolicyAttrStmtPoliceDataRateUnitGet (openapiClientHandle_t *client_handle, uint32_t policyIndex, uint32_t policyInstIndex, uint32_t policyAttrIndex, OPEN_DIFFSERV_POLICY_ATTR_TYPE_t entryType, OPEN_RATE_UNIT_t *pRate_unit)
 Get the policing committed rate unit attribute statement value. More...
 
open_error_t openapiDiffServPolicyAttrStmtPoliceExceedActGet (openapiClientHandle_t *client_handle, uint32_t policyIndex, uint32_t policyInstIndex, uint32_t policyAttrIndex, OPEN_DIFFSERV_POLICE_ACT_t *action)
 Get the policing exceed action attribute statement value. More...
 
open_error_t openapiDiffServPolicyAttrStmtPoliceExceedActSet (openapiClientHandle_t *client_handle, uint32_t policyIndex, uint32_t policyInstIndex, uint32_t policyAttrIndex, OPEN_DIFFSERV_POLICE_ACT_t action)
 Set the policing exceed action attribute statement value. More...
 
open_error_t openapiDiffServPolicyAttrStmtPoliceExceedValGet (openapiClientHandle_t *client_handle, uint32_t policyIndex, uint32_t policyInstIndex, uint32_t policyAttrIndex, uint32_t *pValue)
 Get the policing exceed value attribute statement value. More...
 
open_error_t openapiDiffServPolicyAttrStmtPoliceExceedValSet (openapiClientHandle_t *client_handle, uint32_t policyIndex, uint32_t policyInstIndex, uint32_t policyAttrIndex, uint32_t value)
 Set the policing exceed value attribute statement value. More...
 
open_error_t openapiDiffServPolicyAttrStmtPoliceNonconformActGet (openapiClientHandle_t *client_handle, uint32_t policyIndex, uint32_t policyInstIndex, uint32_t policyAttrIndex, OPEN_DIFFSERV_POLICE_ACT_t *action)
 Get the policing nonconform action attribute statement value. More...
 
open_error_t openapiDiffServPolicyAttrStmtPoliceNonconformActSet (openapiClientHandle_t *client_handle, uint32_t policyIndex, uint32_t policyInstIndex, uint32_t policyAttrIndex, OPEN_DIFFSERV_POLICE_ACT_t action)
 Set the policing nonconform action attribute statement value. More...
 
open_error_t openapiDiffServPolicyAttrStmtPoliceNonconformValGet (openapiClientHandle_t *client_handle, uint32_t policyIndex, uint32_t policyInstIndex, uint32_t policyAttrIndex, uint32_t *value)
 Get the policing nonconform value attribute statement value. More...
 
open_error_t openapiDiffServPolicyAttrStmtPoliceNonconformValSet (openapiClientHandle_t *client_handle, uint32_t policyIndex, uint32_t policyInstIndex, uint32_t policyAttrIndex, uint32_t value)
 Set the policing nonconform value attribute statement value. More...
 
open_error_t openapiDiffServPolicyAttrStmtPolicePdataRatePercentGet (openapiClientHandle_t *client_handle, uint32_t policyIndex, uint32_t policyInstIndex, uint32_t policyAttrIndex, OPEN_DIFFSERV_POLICY_ATTR_TYPE_t entryType, uint32_t *pRate_percent)
 Get the policing peak rate attribute statement value. More...
 
open_error_t openapiDiffServPolicyAttrStmtPoliceSimpleCrateGet (openapiClientHandle_t *client_handle, uint32_t policyIndex, uint32_t policyInstIndex, uint32_t policyAttrIndex, uint32_t *rate)
 Get the simple policing committed rate attribute statement value. More...
 
open_error_t openapiDiffServPolicyAttrStmtPoliceSimpleCrateSet (openapiClientHandle_t *client_handle, uint32_t policyIndex, uint32_t policyInstIndex, uint32_t policyAttrIndex, uint32_t rate)
 Set the simple policing committed rate attribute statement value. More...
 
open_error_t openapiDiffServPolicyAttrStmtPoliceTworateCrateGet (openapiClientHandle_t *client_handle, uint32_t policyIndex, uint32_t policyInstIndex, uint32_t policyAttrIndex, uint32_t *pRate)
 Get the two-rate policing committed rate attribute statement value. More...
 
open_error_t openapiDiffServPolicyAttrStmtPoliceTworateCrateSet (openapiClientHandle_t *client_handle, uint32_t policyIndex, uint32_t policyInstIndex, uint32_t policyAttrIndex, uint32_t rate)
 Set the two-rate policing committed rate attribute statement value. More...
 
open_error_t openapiDiffServPolicyAttrStmtPoliceTworatePdataRateSet (openapiClientHandle_t *client_handle, uint32_t policyIndex, uint32_t policyInstIndex, uint32_t policyAttrIndex, OPEN_RATE_UNIT_t rate_unit, uint32_t rate)
 Set the two-rate policing peak rate attribute statement value as per unit. More...
 
open_error_t openapiDiffServPolicyAttrStmtPoliceTworatePrateGet (openapiClientHandle_t *client_handle, uint32_t policyIndex, uint32_t policyInstIndex, uint32_t policyAttrIndex, uint32_t *rate)
 Get the two-rate policing peak rate attribute statement value. More...
 
open_error_t openapiDiffServPolicyAttrStmtPoliceTworatePrateSet (openapiClientHandle_t *client_handle, uint32_t policyIndex, uint32_t policyInstIndex, uint32_t policyAttrIndex, uint32_t rate)
 Set the two-rate policing peak rate attribute statement value. More...
 
open_error_t openapiDiffServPolicyAttrStorageTypeGet (openapiClientHandle_t *client_handle, uint32_t policyIndex, uint32_t policyInstIndex, uint32_t policyAttrIndex, OPEN_DIFFSERV_STORAGE_TYPE_t *pValue)
 Get the storage type for the specified Policy Attribute Table row. More...
 
open_error_t openapiDiffServPolicyCreate (openapiClientHandle_t *client_handle, uint32_t policyIndex, OPEN_BOOL_t activateRow)
 Create a new row in the Policy Table for the specified index. More...
 
open_error_t openapiDiffServPolicyDelete (openapiClientHandle_t *client_handle, uint32_t policyIndex)
 Delete a row from the Policy Table for the specified index. More...
 
open_error_t openapiDiffServPolicyGetNext (openapiClientHandle_t *client_handle, uint32_t prevPolicyIndex, uint32_t *pPolicyIndex)
 Determine next sequential row in the Policy Table. More...
 
open_error_t openapiDiffServPolicyIndexNext (openapiClientHandle_t *client_handle, uint32_t *pPolicyIndex)
 Obtain the next available index value to be used when creating a new row in the Policy Table. More...
 
open_error_t openapiDiffServPolicyInstClassIndexGet (openapiClientHandle_t *client_handle, uint32_t policyIndex, uint32_t policyInstIndex, uint32_t *pClassIndex)
 Get the class index referenced as the policy class instance. More...
 
open_error_t openapiDiffServPolicyInstClassIndexSet (openapiClientHandle_t *client_handle, uint32_t policyIndex, uint32_t policyInstIndex, uint32_t classIndex)
 Set the class index referenced as the policy class instance. More...
 
open_error_t openapiDiffServPolicyInstCreate (openapiClientHandle_t *client_handle, uint32_t policyIndex, uint32_t policyInstIndex, OPEN_BOOL_t activateRow)
 Create a new row in the Policy-Class Instance Table for the specified index. More...
 
open_error_t openapiDiffServPolicyInstDelete (openapiClientHandle_t *client_handle, uint32_t policyIndex, uint32_t policyInstIndex)
 Delete a row from the Policy-Class Instance Table for the specified index. More...
 
open_error_t openapiDiffServPolicyInstGetNext (openapiClientHandle_t *client_handle, uint32_t prevPolicyIndex, uint32_t prevPolicyInstIndex, uint32_t *pPolicyIndex, uint32_t *pPolicyInstIndex)
 Determine next sequential row in the Policy-Class Instance Table. More...
 
open_error_t openapiDiffServPolicyInstIndexFromClass (openapiClientHandle_t *client_handle, uint32_t policyIndex, uint32_t classIndex, uint32_t *pPolicyInstIndex)
 Find the policy instance index from the policy and class indexes. More...
 
open_error_t openapiDiffServPolicyInstIndexNext (openapiClientHandle_t *client_handle, uint32_t policyIndex, uint32_t *pPolicyInstIndex)
 Obtain the next available index value to be used when creating a new row in the Policy-Class Instance Table. More...
 
open_error_t openapiDiffServPolicyInstRowStatusGet (openapiClientHandle_t *client_handle, uint32_t policyIndex, uint32_t policyInstIndex, OPEN_DIFFSERV_ROW_STATUS_t *pValue)
 Get the current status of the specified Policy-Class Instance Table row. More...
 
open_error_t openapiDiffServPolicyNameGet (openapiClientHandle_t *client_handle, uint32_t policyIndex, open_buffdesc *bufd)
 Get the policy name. More...
 
open_error_t openapiDiffServPolicyNameSet (openapiClientHandle_t *client_handle, uint32_t policyIndex, open_buffdesc *bufd)
 Set the policy name. More...
 
open_error_t openapiDiffServPolicyNameToIndex (openapiClientHandle_t *client_handle, open_buffdesc *stringPtr, uint32_t *pPolicyIndex)
 Translate a policy name into its associated Policy Table index. More...
 
open_error_t openapiDiffServPolicyRowStatusGet (openapiClientHandle_t *client_handle, uint32_t policyIndex, OPEN_DIFFSERV_ROW_STATUS_t *pValue)
 Get the current status of the specified Policy Table row. More...
 
open_error_t openapiDiffServPolicyTypeGet (openapiClientHandle_t *client_handle, uint32_t policyIndex, OPEN_DIFFSERV_POLICY_TYPE_t *pPolicyType)
 Get the type of policy definition. More...
 
open_error_t openapiDiffServPolicyTypeSet (openapiClientHandle_t *client_handle, uint32_t policyIndex, OPEN_DIFFSERV_POLICY_TYPE_t policyType)
 Set the type of policy definition. More...