RDK Documentation (Open Sourced RDK Components)

Description

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

This is the getter group of API for the Device.Ethernet.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_Ethernet_Interface_Stats_BytesSent. In this case, the path is "Device.Ethernet.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  hostIf_EthernetInterfaceStats
 This class provides the interface for getting Device ethernet interface status information. More...
 

Data Structure Documentation

◆ hostIf_EthernetInterfaceStats

class hostIf_EthernetInterfaceStats

This class provides the interface for getting Device ethernet interface status information.

Definition at line 174 of file Device_Ethernet_Interface_Stats.h.

Collaboration diagram for hostIf_EthernetInterfaceStats:
Collaboration graph

Public Member Functions

int get_Device_Ethernet_Interface_Stats_BytesSent (HOSTIF_MsgData_t *, bool *pChanged=NULL)
 This function provides the total number of bytes transmitted out of this Ethernet interface, including framing characters. More...
 
int get_Device_Ethernet_Interface_Stats_BytesReceived (HOSTIF_MsgData_t *, bool *pChanged=NULL)
 This function provides the total number of bytes received on this Ethernet interface, including framing characters. More...
 
int get_Device_Ethernet_Interface_Stats_PacketsSent (HOSTIF_MsgData_t *, bool *pChanged=NULL)
 This function provides the total number of packets transmitted out of this Ethernet interface. More...
 
int get_Device_Ethernet_Interface_Stats_PacketsReceived (HOSTIF_MsgData_t *, bool *pChanged=NULL)
 This function provides the total number of packets received on this Ethernet interface. More...
 
int get_Device_Ethernet_Interface_Stats_ErrorsSent (HOSTIF_MsgData_t *, bool *pChanged=NULL)
 This function provides the total number of outbound packets that could not be transmitted because of errors. More...
 
int get_Device_Ethernet_Interface_Stats_ErrorsReceived (HOSTIF_MsgData_t *, bool *pChanged=NULL)
 This function provides the total number of inbound packets that contained errors preventing them from being delivered to a higher-layer protocol. More...
 
int get_Device_Ethernet_Interface_Stats_UnicastPacketsSent (HOSTIF_MsgData_t *, bool *pChanged=NULL)
 This function get the number of unicast packets for which a request is send on the IP Interface was received. This function provides 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_Device_Ethernet_Interface_Stats_UnicastPacketsReceived (HOSTIF_MsgData_t *, bool *pChanged=NULL)
 Get the number of unicast packets received on an Ethernet Interface. More...
 
int get_Device_Ethernet_Interface_Stats_DiscardPacketsSent (HOSTIF_MsgData_t *, bool *pChanged=NULL)
 This function get the number of discarded outbound packets on an Ethernet Interface. This function provides the total number of outbound packets which were chosen to be discarded even though no errors had been detected to prevent their being transmitted. More...
 
int get_Device_Ethernet_Interface_Stats_DiscardPacketsReceived (HOSTIF_MsgData_t *, bool *pChanged=NULL)
 Get the number of discarded inbound packets on an Ethernet Interface. More...
 
int get_Device_Ethernet_Interface_Stats_MulticastPacketsSent (HOSTIF_MsgData_t *, bool *pChanged=NULL)
 Get the number of Multicast Packets sent on an Ethernet Interface. More...
 
int get_Device_Ethernet_Interface_Stats_MulticastPacketsReceived (HOSTIF_MsgData_t *, bool *pChanged=NULL)
 Get the number of Multicast Packets received on an Ethernet Interface. More...
 
int get_Device_Ethernet_Interface_Stats_BroadcastPacketsSent (HOSTIF_MsgData_t *, bool *pChanged=NULL)
 This function get the number of Broadcast Packets sent on an Ethernet Interface. This function provides 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_Device_Ethernet_Interface_Stats_BroadcastPacketsReceived (HOSTIF_MsgData_t *, bool *pChanged=NULL)
 This function get the number of Broadcast Packets received on an Ethernet Interface. This function provides 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_Device_Ethernet_Interface_Stats_UnknownProtoPacketsReceived (HOSTIF_MsgData_t *, bool *pChanged=NULL)
 This function get the number of Packets of unidentified protocol received on an Ethernet Interface. This function provides the total number of packets received via this Ethernet interface which were discarded because they were of an unknown or unsupported protocol. More...
 

Static Public Member Functions

static hostIf_EthernetInterfaceStatsgetInstance (int dev_id)
 
static void closeInstance (hostIf_EthernetInterfaceStats *)
 
static GList * getAllInstances ()
 
static void closeAllInstances ()
 
static void getLock ()
 
static void releaseLock ()
 

Static Public Attributes

static EthernetInterfaceStats stEthInterfaceStats = {0,}
 

Private Member Functions

 hostIf_EthernetInterfaceStats (int dev_id)
 Class Constructor of the class hostIf_EthernetInterfaceStats. More...
 

Private Attributes

int dev_id
 
int backupBytesSent
 
int backupBytesReceived
 
int backupPacketsSent
 
int backupPacketsReceived
 
int backupUnicastPacketsSent
 
int backupUnicastPacketsReceived
 
int backupMulticastPacketsReceived
 
int backupBroadcastPacketsSent
 
int backupBroadcastPacketsReceived
 
int backupMulticastPacketsSent
 
int backupErrorSent
 
int backupErrorsReceived
 
int backupErrorsSent
 
int backupDiscardPacketsReceived
 
bool bCalledBytesSent
 
bool bCalledBytesReceived
 
bool bCalledPacketsSent
 
bool bCalledPacketsReceived
 
bool bCalledErrorSent
 
bool bCalledErrorsReceived
 
bool bCalledErrorsSent
 
bool bCalledUnicastPacketsSent
 
bool bCalledDiscardPacketsReceived
 
bool bCalledDiscardPacketsSent
 
bool bCalledUnicastPacketsReceived
 
bool bCalledMulticastPacketsReceived
 
bool bCalledBroadcastPacketsSent
 
bool bCalledBroadcastPacketsReceived
 
bool bCalledMulticastPacketsSent
 
bool bCalledUnknownProtoPacketsReceived
 

Static Private Attributes

static GHashTable * ifHash = NULL
 
static GMutex * m_mutex = NULL