RDK Documentation (Open Sourced RDK Components)

Description

TR-069 Device.MoCA.Interface.QoS.FlowStats object Getter API

This is the getter group of API for the Device.MoCA.Interface.{i}.QoS.FlowStats.{j} object.

The interface for all functions is identical and is described here.

Parameters
[in]*nameThis is the complete path name of the parameter extracted from soap message, e.g. ::get_Device_MoCA_Interface_QoS_FlowStats_FlowID. In this case, the path is "Device.MoCA.Interface.{i}.QoS.FlowStats.{j}.FlowID".
[in]*typeData type of parameter defined for TR-069. This is same as the data type used in the Xi3 data-model.xml file. (see parameter.h)
[out]*valueThis is the value of the parameter requested by the ACS. (see paramaccess.h)
Returns
The status of the operation.
Return values
OKIf parameter requested was successfully fetched. (Same as NO_ERROR).
NO_ERRORIf parameter requested was successfully fetched. (Same as OK).
DIAG_ERRORDiagnostic error.
ERR_???Appropriate error value otherwise (see dimark_globals.h).

Data Structures

class  MoCAInterfaceQoSFlowStats
 

Data Structure Documentation

◆ MoCAInterfaceQoSFlowStats

class MoCAInterfaceQoSFlowStats

Definition at line 98 of file Device_MoCA_Interface_QoS_FlowStats.h.

Collaboration diagram for MoCAInterfaceQoSFlowStats:
Collaboration graph

Public Member Functions

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. More...
 
int get_PacketDA (HOSTIF_MsgData_t *stMsgData, unsigned int entryNum, bool *pChanged=NULL)
 Get the Destination Address (DA) for the packets in this flow. More...
 
int get_MaxRate (HOSTIF_MsgData_t *stMsgData, unsigned int entryNum, bool *pChanged=NULL)
 Get the maximum required rate in Kbps. More...
 
int get_MaxBurstSize (HOSTIF_MsgData_t *stMsgData, unsigned int entryNum, bool *pChanged=NULL)
 Get Maximum burst size of MoCA interface. More...
 
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. More...
 
int get_LeaseTimeLeft (HOSTIF_MsgData_t *stMsgData, unsigned int entryNum, bool *pChanged=NULL)
 Get the Flow lease time remaining (expressed in seconds). More...
 
int get_FlowPackets (HOSTIF_MsgData_t *stMsgData, unsigned int entryNum, bool *pChanged=NULL)
 Get the number of packets transmitted for this flow. More...
 

Static Public Member Functions

static class MoCAInterfaceQoSFlowStatsgetInstance ()
 

Static Private Attributes

static class MoCAInterfaceQoSFlowStatsInstance = NULL