TR-069 Device.IP.Interface.Stats Getter API.

Description

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

This is the getter group of API for the Device.IP.Interface.{i}.Stats object.

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

Parameters

[in]	*name	This is the complete path name of the parameter extracted from soap message, e.g. ::get_Device_IP_Interface_Stats_BytesSent. In this case, the path is "Device.IP.Interface.{i}.Stats.BytesSent".
[in]	*type	Data 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]	*value	This is the value of the parameter requested by the ACS. (see paramaccess.h)

Returns

The status of the operation.

Return values

OK	If parameter requested was successfully fetched. (Same as NO_ERROR).
NO_ERROR	If parameter requested was successfully fetched. (Same as OK).
DIAG_ERROR	Diagnostic error.
ERR_???	Appropriate error value otherwise (see dimark_globals.h).

Data Structures
class	hostIf_IPInterfaceStats
	This class provides the hostIf IP interface stats for getting IP interface stats information. More...

---

Data Structure Documentation

hostIf_IPInterfaceStats

class hostIf_IPInterfaceStats

This class provides the hostIf IP interface stats for getting IP interface stats information.

Definition at line 143 of file Device_IP_Interface_Stats.h.

Collaboration diagram for hostIf_IPInterfaceStats:

Public Member Functions
int	handleGetMsg (const char *pSetting, HOSTIF_MsgData_t *stMsgData)
int	get_Device_IP_Interface_Stats_BytesSent (HOSTIF_MsgData_t *stMsgData, bool *pChanged=NULL)
	This function gets the number of bytes sent on the IP Interface. It provides the total number of bytes transmitted out of the interface, including framing characters. More...
int	get_Device_IP_Interface_Stats_BytesReceived (HOSTIF_MsgData_t *stMsgData, bool *pChanged=NULL)
	This function gets the number of bytes received on the IP Interface. It provides the total number of bytes received on the interface, including framing characters. More...
int	get_Device_IP_Interface_Stats_PacketsSent (HOSTIF_MsgData_t *stMsgData, bool *pChanged=NULL)
	Get the number of packets sent on the IP Interface. More...
int	get_Device_IP_Interface_Stats_PacketsReceived (HOSTIF_MsgData_t *stMsgData, bool *pChanged=NULL)
	This function gets the total number of packets received on the IP Interface. More...
int	get_Device_IP_Interface_Stats_ErrorsSent (HOSTIF_MsgData_t *stMsgData, bool *pChanged=NULL)
	This function gets the number of send errors on the IP Interface. It provides the total number of outbound packets that could not be transmitted because of errors. More...
int	get_Device_IP_Interface_Stats_ErrorsReceived (HOSTIF_MsgData_t *stMsgData, bool *pChanged=NULL)
	This function gets the number of receive errors on the IP Interface. It provides the total number of inbound packets that contained errors preventing them from being delivered to a higher-layer protocol. More...
int	get_Device_IP_Interface_Stats_UnicastPacketsSent (HOSTIF_MsgData_t *stMsgData, bool *pChanged=NULL)
	This function gets the number of unicast packets for which a request to send on the IP Interface was received. It 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_IP_Interface_Stats_UnicastPacketsReceived (HOSTIF_MsgData_t *stMsgData, bool *pChanged=NULL)
	This function gets the number of unicast packets received on the IP Interface. Provides 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_Device_IP_Interface_Stats_DiscardPacketsSent (HOSTIF_MsgData_t *stMsgData, bool *pChanged=NULL)
	This function gets the number of discarded outbound packets on the IP Interface. It 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_IP_Interface_Stats_DiscardPacketsReceived (HOSTIF_MsgData_t *stMsgData, bool *pChanged=NULL)
	This function gets the number of discarded inbound packets on the IP Interface. It provides the total number of inbound packets which were chosen to be discarded even though no errors had been detected to prevent their being delivered. More...
int	get_Device_IP_Interface_Stats_MulticastPacketsSent (HOSTIF_MsgData_t *stMsgData, bool *pChanged=NULL)
	This function gets the number of Multicast Packets sent on the IP Interface. It provides 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_Device_IP_Interface_Stats_MulticastPacketsReceived (HOSTIF_MsgData_t *stMsgData, bool *pChanged=NULL)
	This function gets the number of Multicast Packets received on the IP Interface. It provides 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_Device_IP_Interface_Stats_BroadcastPacketsSent (HOSTIF_MsgData_t *stMsgData, bool *pChanged=NULL)
	This function gets the number of broadcast packets sent on the IP Interface. It 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_IP_Interface_Stats_BroadcastPacketsReceived (HOSTIF_MsgData_t *stMsgData, bool *pChanged=NULL)
	This function gets the number of broadcast packets received on the IP interface. It 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_IP_Interface_Stats_UnknownProtoPacketsReceived (HOSTIF_MsgData_t *stMsgData, bool *pChanged=NULL)
	This function gets the number of Packets of unidentified protocol received on the IP Interface. It provides the total number of packets received via the interface which were discarded because they were of an unknown or unsupported protocol. More...
Static Public Member Functions
static hostIf_IPInterfaceStats *	getInstance (int dev_id)
static void	closeInstance (hostIf_IPInterfaceStats *)
static GList *	getAllInstances ()
static void	closeAllInstances ()
static void	getLock ()
static void	releaseLock ()
Private Member Functions
	hostIf_IPInterfaceStats (int dev_id)
	Class Constructor of the class hostIf_IPInterfaceStats. More...
void	refreshInterfaceName ()
int	getSysClassNetStatistic (char *statistic, unsigned long *result)
Private Attributes
int	dev_id
char	nameOfInterface [IF_NAMESIZE]
int	backupBytesSent
int	backupBytesReceived
int	backupPacketsSent
int	backupPacketsReceived
int	backupErrorsSent
int	backupErrorsReceived
int	backupUnicastPacketsSent
int	backupUnicastPacketsReceived
int	backupDiscardPacketsSent
int	backupDiscardPacketsReceived
int	backupMulticastPacketsSent
int	backupMulticastPacketsReceived
int	backupBroadcastPacketsSent
int	backupBroadcastPacketsReceived
int	backupUnknownProtoPacketsReceived
bool	bCalledBytesSent
bool	bCalledBytesReceived
bool	bCalledPacketsSent
bool	bCalledPacketsReceived
bool	bCalledErrorsSent
bool	bCalledErrorsReceived
bool	bCalledUnicastPacketsSent
bool	bCalledUnicastPacketsReceived
bool	bCalledDiscardPacketsSent
bool	bCalledDiscardPacketsReceived
bool	bCalledMulticastPacketsSent
bool	bCalledMulticastPacketsReceived
bool	bCalledBroadcastPacketsSent
bool	bCalledBroadcastPacketsReceived
bool	bCalledUnknownProtoPacketsReceived
Static Private Attributes
static GHashTable *	ifHash = NULL
static GMutex *	m_mutex = NULL
static IPInterfaceStats	curntIpStat = {0,}