openapi_diffserv_service.h

Go to the documentation of this file.

/**********************************************************************
*
*  Copyright 2023 Broadcom.
*
*  Licensed under the Apache License, Version 2.0 (the "License");
*  you may not use this file except in compliance with the License.
*  You may obtain a copy of the License at
*
*      http://www.apache.org/licenses/LICENSE-2.0
*
*  Unless required by applicable law or agreed to in writing, software
*  distributed under the License is distributed on an "AS IS" BASIS,
*  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
*  See the License for the specific language governing permissions and
*  limitations under the License.
*
***********************************************************************
*
* @filename  openapi_diffserv_serv.h
*
* @purpose   This code implements the OpEN Diff services  API
*
* @component OPEN
*
* @create    05/19/2023
*
* @end
*
*********************************************************************/
#ifndef OPENAPI_DIFFSERV_SERVICE_H_INCLUDED
#define OPENAPI_DIFFSERV_SERVICE_H_INCLUDED

#include "openapi_common.h"

typedef enum
{
  OPEN_MIB_DIFFSERV_IF_DIRECTION_NONE = 0,
  OPEN_MIB_DIFFSERV_IF_DIRECTION_IN,        
  OPEN_MIB_DIFFSERV_IF_DIRECTION_OUT,       
} OPEN_MIB_DIFFSERV_IF_DIRECTION_t;

typedef enum
{
  OPEN_MIB_DIFFSERV_IF_OPER_STATUS_NONE = 0, 
  OPEN_MIB_DIFFSERV_IF_OPER_STATUS_UP,       
  OPEN_MIB_DIFFSERV_IF_OPER_STATUS_DOWN,     
} OPEN_MIB_DIFFSERV_IF_OPER_STATUS_t;

typedef enum
{
  OPEN_MIB_DIFFSERV_ROW_STATUS_NONE = 0,        
  OPEN_MIB_DIFFSERV_ROW_STATUS_ACTIVE,          
  OPEN_MIB_DIFFSERV_ROW_STATUS_NOT_IN_SERVICE,  
  OPEN_MIB_DIFFSERV_ROW_STATUS_NOT_READY,       
  OPEN_MIB_DIFFSERV_ROW_STATUS_CREATE_AND_GO,   
  OPEN_MIB_DIFFSERV_ROW_STATUS_CREATE_AND_WAIT, 
  OPEN_MIB_DIFFSERV_ROW_STATUS_DESTROY,         
} OPEN_MIB_DIFFSERV_ROW_STATUS_t;

/*************************************************************************/
open_error_t
openapiDiffServServiceCreate(openapiClientHandle_t *client_handle,
                             uint32_t intIfNum,
                             OPEN_MIB_DIFFSERV_IF_DIRECTION_t ifDir,
                             OPEN_BOOL_t activateRow);

/*************************************************************************/
open_error_t
openapiDiffServServiceDelete(openapiClientHandle_t *client_handle,
                             uint32_t intIfNum,
                             OPEN_MIB_DIFFSERV_IF_DIRECTION_t ifDir);

/*************************************************************************/
open_error_t
openapiDiffServServiceGet(openapiClientHandle_t *client_handle,
                          uint32_t intIfNum,
                          OPEN_MIB_DIFFSERV_IF_DIRECTION_t ifDir);

/*************************************************************************/
open_error_t
openapiDiffServServiceGetNext(openapiClientHandle_t *client_handle,
                              uint32_t intIfNum,
                              OPEN_MIB_DIFFSERV_IF_DIRECTION_t ifDir,
                              uint32_t *pNxtIntIfNum,
                              OPEN_MIB_DIFFSERV_IF_DIRECTION_t *pNxtIfDir);

/*************************************************************************/
open_error_t
openapiDiffServServicePolicyIndexSet(openapiClientHandle_t *client_handle,
                                     uint32_t intIfNum,
                                     OPEN_MIB_DIFFSERV_IF_DIRECTION_t ifDir,
                                     uint32_t policyIndex);

/*************************************************************************/
open_error_t
openapiDiffServServicePolicyIndexGet(openapiClientHandle_t *client_handle,
                                     uint32_t intIfNum,
                                     OPEN_MIB_DIFFSERV_IF_DIRECTION_t ifDir,
                                     uint32_t *pPolicyIndex);

/*************************************************************************/
open_error_t
openapiDiffServServiceIfOperStatusGet(openapiClientHandle_t *client_handle,
                                      uint32_t intIfNum,
                                      OPEN_MIB_DIFFSERV_IF_DIRECTION_t ifDir,
                                      OPEN_MIB_DIFFSERV_IF_OPER_STATUS_t *pIfOperStatus);

/*************************************************************************/
open_error_t
openapiDiffServIsAclIntfInUse(openapiClientHandle_t *client_handle,
                              uint32_t intIfNum,
                              OPEN_MIB_DIFFSERV_IF_DIRECTION_t ifDir,
                              OPEN_BOOL_t *pIsAclIntfInUse);

/*************************************************************************/
open_error_t
openapiDiffServServiceRowStatusSet(openapiClientHandle_t *client_handle,
                                   uint32_t intIfNum,
                                   OPEN_MIB_DIFFSERV_IF_DIRECTION_t ifDir,
                                   OPEN_MIB_DIFFSERV_ROW_STATUS_t status);

/*************************************************************************/
open_error_t
openapiDiffServServiceRowStatusGet(openapiClientHandle_t *client_handle,
                                   uint32_t intIfNum,
                                   OPEN_MIB_DIFFSERV_IF_DIRECTION_t ifDir,
                                   OPEN_MIB_DIFFSERV_ROW_STATUS_t *pStatus);

/*************************************************************************/
open_error_t
openapiDiffServServiceRowStatusVerify(openapiClientHandle_t *client_handle,
                                      uint32_t intIfNum,
                                      OPEN_MIB_DIFFSERV_IF_DIRECTION_t ifDir,
                                      OPEN_MIB_DIFFSERV_ROW_STATUS_t status);

/*************************************************************************/
open_error_t
openapiDiffServPolicyPerfInOfferedPacketsGet(openapiClientHandle_t *client_handle,
                                             uint32_t policyIndex,
                                             uint32_t policyInstIndex,
                                             uint32_t intIfNum,
                                             uint64_t *pPacktCount);

/*************************************************************************/
open_error_t
openapiDiffServPolicyPerfOutOfferedPacketsGet(openapiClientHandle_t *client_handle,
                                              uint32_t policyIndex,
                                              uint32_t policyInstIndex,
                                              uint32_t intIfNum,
                                              uint64_t *pPacktCount);

/*************************************************************************/
open_error_t
openapiDiffServPolicyPerfInDiscardedPacketsGet(openapiClientHandle_t *client_handle,
                                               uint32_t policyIndex,
                                               uint32_t policyInstIndex,
                                               uint32_t intIfNum,
                                               uint64_t *pPacktCount);

/*************************************************************************/
open_error_t
openapiDiffServPolicyPerfOutDiscardedPacketsGet(openapiClientHandle_t *client_handle,
                                                uint32_t policyIndex,
                                                uint32_t policyInstIndex,
                                                uint32_t intIfNum,
                                                uint64_t *pPacktCount);
#endif /* OPENAPI_DIFFSERV_SERVICE_H_INCLUDED */