RDK Documentation (Open Sourced RDK Components)
Device_MoCA_Interface_QoS_FlowStats.cpp
1 /*
2  * If not stated otherwise in this file or this component's Licenses.txt file the
3  * following copyright and licenses apply:
4  *
5  * Copyright 2018 RDK Management
6  * Copyright 2018 Broadcom Inc.
7  *
8  * Licensed under the Apache License, Version 2.0 (the "License");
9  * you may not use this file except in compliance with the License.
10  * You may obtain a copy of the License at
11  *
12  * http://www.apache.org/licenses/LICENSE-2.0
13  *
14  * Unless required by applicable law or agreed to in writing, software
15  * distributed under the License is distributed on an "AS IS" BASIS,
16  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17  * See the License for the specific language governing permissions and
18  * limitations under the License.
19 */
20 
21 /**
22  * @file Device_MoCA_Interface_QoS_FlowStats.c
23  *
24  * @brief MoCA_Interface_QoS_FlowStats API Implementation.
25  *
26  * This is the implementation of the MoCA_Interface_QoS_FlowStats API.
27  *
28  * @par Document
29  * TBD Relevant design or API documentation.
30  *
31  */
32 
33 /** @addtogroup MoCA_Interface_QoS_FlowStats Implementation
34  * This is the implementation of the Device Public API.
35  * @{
36  */
37 
38 /*****************************************************************************
39  * STANDARD INCLUDE FILES
40  *****************************************************************************/
41 
43 
44 MoCAInterfaceQoSFlowStats* MoCAInterfaceQoSFlowStats::Instance = NULL;
45 
46 
47 /****************************************************************************************************************************************************/
48 // Device.MoCA.Interface.QoS.FlowStats Table Profile. Getters:
49 /****************************************************************************************************************************************************/
50 MoCAInterfaceQoSFlowStats* MoCAInterfaceQoSFlowStats::getInstance()
51 {
52  if(!Instance)
53  {
54  Instance = new MoCAInterfaceQoSFlowStats();
55  }
56  return Instance;
57 }
58 
59 int MoCAInterfaceQoSFlowStats::get_FlowID(HOSTIF_MsgData_t *stMsgData,unsigned int entryNum,bool *pChanged)
60 {
61  /*Retrieving value */
62  // Implementation for SOC vendor
63  // value->out_cval =
64 
65  return NOK;
66 }
67 int MoCAInterfaceQoSFlowStats::get_PacketDA(HOSTIF_MsgData_t *stMsgData,unsigned int entryNum,bool *pChanged)
68 {
69  /*Retrieving value */
70  // Implementation for SOC vendor
71  // value->out_cval =
72 
73  return NOK;
74 }
75 
76 int MoCAInterfaceQoSFlowStats::get_MaxRate(HOSTIF_MsgData_t *stMsgData,unsigned int entryNum,bool *pChanged)
77 {
78  /*Retrieving value */
79  // Implementation for SOC vendor
80  // value->out_cval =
81 
82  return NOK;
83 }
84 int MoCAInterfaceQoSFlowStats::get_MaxBurstSize(HOSTIF_MsgData_t *stMsgData,unsigned int entryNum,bool *pChanged)
85 {
86  /*Retrieving value */
87  // Implementation for SOC vendor
88  // value->out_cval =
89  return NOK;
90 }
91 int MoCAInterfaceQoSFlowStats::get_LeaseTime(HOSTIF_MsgData_t *stMsgData,unsigned int entryNum,bool *pChanged)
92 {
93  /*Retrieving value */
94  // Implementation for SOC vendor
95  // value->out_cval =
96  return NOK;
97 }
98 int MoCAInterfaceQoSFlowStats::get_LeaseTimeLeft(HOSTIF_MsgData_t *stMsgData,unsigned int entryNum,bool *pChanged)
99 {
100  /*Retrieving value */
101  // Implementation for SOC vendor
102  // value->out_cval =
103  return NOK;
104 }
105 int MoCAInterfaceQoSFlowStats::get_FlowPackets(HOSTIF_MsgData_t *stMsgData,unsigned int entryNum,bool *pChanged)
106 {
107  /*Retrieving value */
108  // Implementation for SOC vendor
109  // value->out_cval =
110  return NOK;
111 }
112 /* End of doxygen group */
113 /**
114  * @}
115  */
116 
117 /* End of file xxx_api.c. */
MoCAInterfaceQoSFlowStats::get_MaxRate
int get_MaxRate(HOSTIF_MsgData_t *stMsgData, unsigned int entryNum, bool *pChanged=NULL)
Get the maximum required rate in Kbps.
Definition: Device_MoCA_Interface_QoS_FlowStats.cpp:76
MoCAInterfaceQoSFlowStats::get_FlowID
int get_FlowID(HOSTIF_MsgData_t *stMsgData, unsigned int entryNum, bool *pChanged=NULL)
Get the flow ID used to identify a flow in the network.
Definition: Device_MoCA_Interface_QoS_FlowStats.cpp:59
_HostIf_MsgData_t
Definition: hostIf_tr69ReqHandler.h:170
MoCAInterfaceQoSFlowStats::get_FlowPackets
int get_FlowPackets(HOSTIF_MsgData_t *stMsgData, unsigned int entryNum, bool *pChanged=NULL)
Get the number of packets transmitted for this flow.
Definition: Device_MoCA_Interface_QoS_FlowStats.cpp:105
Device_MoCA_Interface_QoS_FlowStats.h
MoCAInterfaceQoSFlowStats::get_LeaseTimeLeft
int get_LeaseTimeLeft(HOSTIF_MsgData_t *stMsgData, unsigned int entryNum, bool *pChanged=NULL)
Get the Flow lease time remaining (expressed in seconds).
Definition: Device_MoCA_Interface_QoS_FlowStats.cpp:98
MoCAInterfaceQoSFlowStats::get_LeaseTime
int get_LeaseTime(HOSTIF_MsgData_t *stMsgData, unsigned int entryNum, bool *pChanged=NULL)
Get the flow lease time (expressed in seconds). A LeaseTime of 0 means unlimited lease time.
Definition: Device_MoCA_Interface_QoS_FlowStats.cpp:91
MoCAInterfaceQoSFlowStats
Definition: Device_MoCA_Interface_QoS_FlowStats.h:98
MoCAInterfaceQoSFlowStats::get_MaxBurstSize
int get_MaxBurstSize(HOSTIF_MsgData_t *stMsgData, unsigned int entryNum, bool *pChanged=NULL)
Get Maximum burst size of MoCA interface.
Definition: Device_MoCA_Interface_QoS_FlowStats.cpp:84
MoCAInterfaceQoSFlowStats::get_PacketDA
int get_PacketDA(HOSTIF_MsgData_t *stMsgData, unsigned int entryNum, bool *pChanged=NULL)
Get the Destination Address (DA) for the packets in this flow.
Definition: Device_MoCA_Interface_QoS_FlowStats.cpp:67