RDK Documentation (Open Sourced RDK Components)

Description

TR-069 Device.MoCA.Interface.Stats object Getter API

This is the getter group of API for the Device.MoCA.Interface.{i}.Stats 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_Stats_BytesSent. In this case, the path is "Device.MoCA.Interface.{i}.Stats.BytesSent".
[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  MoCAInterfaceStats
 

Data Structure Documentation

◆ MoCAInterfaceStats

class MoCAInterfaceStats

Definition at line 109 of file Device_MoCA_Interface_Stats.h.

Collaboration diagram for MoCAInterfaceStats:
Collaboration graph

Public Member Functions

int get_BytesSent (HOSTIF_MsgData_t *stMsgData, bool *pChanged=NULL)
 Get the total number of bytes transmitted out of the MoCA interface, including framing characters. More...
 
int get_BytesReceived (HOSTIF_MsgData_t *stMsgData, bool *pChanged=NULL)
 Get the total number of bytes received on the MoCA interface, including framing characters. More...
 
int get_PacketsSent (HOSTIF_MsgData_t *stMsgData, bool *pChanged=NULL)
 Get the total number of packets transmitted out of the MoCA interface. More...
 
int get_PacketsReceived (HOSTIF_MsgData_t *stMsgData, bool *pChanged=NULL)
 Get the total number of packets received on the MoCA interface. More...
 
int get_ErrorsSent (HOSTIF_MsgData_t *stMsgData, bool *pChanged=NULL)
 Get the total number of outbound packets that could not be transmitted because of errors. More...
 
int get_ErrorsReceived (HOSTIF_MsgData_t *stMsgData, bool *pChanged=NULL)
 Get the total number of inbound packets that contained errors preventing them from being delivered to a higher-layer protocol. More...
 
int get_UnicastPacketsSent (HOSTIF_MsgData_t *stMsgData, bool *pChanged=NULL)
 Get the total number of packets requested for transmission which were not addressed to a multicast or broadcast address at this layer, including those that were discarded or not sent. More...
 
int get_UnicastPacketsReceived (HOSTIF_MsgData_t *stMsgData, bool *pChanged=NULL)
 Get the total number of received packets, delivered by this layer to a higher layer, which were not addressed to a multicast or broadcast address at this layer. More...
 
int get_DiscardPacketsSent (HOSTIF_MsgData_t *stMsgData, bool *pChanged=NULL)
 Get the total number of outbound packets which were chosen to be discarded even though no errors had been detected to prevent their being transmitted. One possible reason for discarding such a packet could be to free up buffer space. More...
 
int get_DiscardPacketsReceived (HOSTIF_MsgData_t *stMsgData, bool *pChanged=NULL)
 Get the total number of inbound packets which were chosen to be discarded even though no errors had been detected to prevent their being delivered. One possible reason for discarding such a packet could be to free up buffer space. More...
 
int get_MulticastPacketsSent (HOSTIF_MsgData_t *stMsgData, bool *pChanged=NULL)
 Get the total number of packets that higher-level protocols requested for transmission and which were addressed to a multicast address at this layer, including those that were discarded or not sent. More...
 
int get_MulticastPacketsReceived (HOSTIF_MsgData_t *stMsgData, bool *pChanged=NULL)
 Get the total number of received packets, delivered by this layer to a higher layer, which were addressed to a multicast address at this layer. More...
 
int get_BroadcastPacketsSent (HOSTIF_MsgData_t *stMsgData, bool *pChanged=NULL)
 Get the total number of packets that higher-level protocols requested for transmission and which were addressed to a broadcast address at this layer, including those that were discarded or not sent. More...
 
int get_BroadcastPacketsReceived (HOSTIF_MsgData_t *stMsgData, bool *pChanged=NULL)
 Get the total number of received packets, delivered by this layer to a higher layer, which were addressed to a broadcast address at this layer. More...
 
int get_UnknownProtoPacketsReceived (HOSTIF_MsgData_t *stMsgData, bool *pChanged=NULL)
 Get the total number of packets received via the MoCA interface which were discarded because of an unknown or unsupported protocol. More...
 

Static Public Member Functions

static class MoCAInterfaceStatsgetInstance ()
 

Private Member Functions

 MoCAInterfaceStats (int _dev_id)
 

Private Attributes

int m_i32DevID
 
unsigned long m_ulBytesSent
 
unsigned long m_ulBytesReceived
 
unsigned long m_ulPacketsSent
 
unsigned long m_ulPacketsReceived
 
unsigned int m_ulErrorsSent
 
unsigned int m_ulErrorsReceived
 
unsigned long m_ulUnicastPacketsSent
 
unsigned long m_ulUnicastPacketsReceived
 
unsigned int m_ulDiscardPacketsSent
 
unsigned int m_ulDiscardPacketsReceived
 
unsigned long m_ulMulticastPacketsSent
 
unsigned long m_ulMulticastPacketsReceived
 
unsigned long m_ulBroadcastPacketsSent
 
unsigned long m_ulBroadcastPacketsReceived
 
unsigned int m_ui32UnknownProtoPacketsReceived
 

Static Private Attributes

static class MoCAInterfaceStatspInstance = NULL