Description

Describe the details about TR069 Device IP Interface stats APIs specifications.

Functions
int	hostIf_IPInterfaceStats::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	hostIf_IPInterfaceStats::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	hostIf_IPInterfaceStats::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	hostIf_IPInterfaceStats::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	hostIf_IPInterfaceStats::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	hostIf_IPInterfaceStats::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	hostIf_IPInterfaceStats::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	hostIf_IPInterfaceStats::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	hostIf_IPInterfaceStats::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	hostIf_IPInterfaceStats::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	hostIf_IPInterfaceStats::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	hostIf_IPInterfaceStats::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	hostIf_IPInterfaceStats::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	hostIf_IPInterfaceStats::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	hostIf_IPInterfaceStats::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...

Function Documentation

◆ get_Device_IP_Interface_Stats_BytesSent()

int hostIf_IPInterfaceStats::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.

Parameters

[out]	stMsgData	TR-069 Host interface message request.
[in]	pChanged	Status of the operation.

Returns: Returns the status of the operation.

Return values

OK	if it is successfully fetch the data from the device.
ERR_INTERNAL_ERROR	if not able to fetch the data.

Definition at line 287 of file Device_IP_Interface_Stats.cpp.

◆ get_Device_IP_Interface_Stats_BytesReceived()

int hostIf_IPInterfaceStats::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.

Parameters

[out]	stMsgData	TR-069 Host interface message request.
[in]	pChanged	Status of the operation.

Returns: Returns the status of the operation.

Return values

OK	if it is successfully fetch the data from the device.
ERR_INTERNAL_ERROR	if not able to fetch the data.

Definition at line 318 of file Device_IP_Interface_Stats.cpp.

◆ get_Device_IP_Interface_Stats_PacketsSent()

int hostIf_IPInterfaceStats::get_Device_IP_Interface_Stats_PacketsSent	(	HOSTIF_MsgData_t *	stMsgData,
		bool *	pChanged = `NULL`
	)

Get the number of packets sent on the IP Interface.

This function gets the number of packets sent on the IP Interface. It provides the total number of packets transmitted out of the interface.

This function provides the total number of packets transmitted out of the interface.

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

Parameters

[out]	stMsgData	TR-069 Host interface message request.
[in]	pChanged	Status of the operation.

Returns: Returns the status of the operation.

Return values

OK	if it is successfully fetch the data from the device.
ERR_INTERNAL_ERROR	if not able to fetch the data.

Definition at line 349 of file Device_IP_Interface_Stats.cpp.

◆ get_Device_IP_Interface_Stats_PacketsReceived()

int hostIf_IPInterfaceStats::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.

Parameters

[out]	stMsgData	TR-069 Host interface message request.
[in]	pChanged	Status of the operation.

Returns: Returns the status of the operation.

Return values

OK	if it is successfully fetch the data from the device.
ERR_INTERNAL_ERROR	if not able to fetch the data.

Definition at line 379 of file Device_IP_Interface_Stats.cpp.

◆ get_Device_IP_Interface_Stats_ErrorsSent()

int hostIf_IPInterfaceStats::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.

Parameters

[out]	stMsgData	TR-069 Host interface message request.
[in]	pChanged	Status of the operation.

Returns: Returns the status of the operation.

Return values

OK	if it successfully fetch the data from the device.
ERR_INTERNAL_ERROR	if not able to fetch the data.

Definition at line 413 of file Device_IP_Interface_Stats.cpp.

◆ get_Device_IP_Interface_Stats_ErrorsReceived()

int hostIf_IPInterfaceStats::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.

Parameters

[out]	stMsgData	TR-069 Host interface message request.
[in]	pChanged	Status of the operation.

Returns: Returns the status of the operation.

Return values

OK	if it is successfully fetch the data from the device.
ERR_INTERNAL_ERROR	if not able to fetch the data.

Definition at line 445 of file Device_IP_Interface_Stats.cpp.

◆ get_Device_IP_Interface_Stats_UnicastPacketsSent()

int hostIf_IPInterfaceStats::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.

Parameters

[out]	stMsgData	TR-069 Host interface message request.
[in]	pChanged	Status of the operation.

Returns: Returns the status of the operation.

Return values

OK	if it is successfully fetch the data from the device.
ERR_INTERNAL_ERROR	if not able to fetch the data.

Definition at line 478 of file Device_IP_Interface_Stats.cpp.

◆ get_Device_IP_Interface_Stats_UnicastPacketsReceived()

int hostIf_IPInterfaceStats::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.

Parameters

[out]	stMsgData	TR-069 Host interface message request.
[in]	pChanged	Status of the operation.

Returns: Returns the status of the operation.

Return values

OK	if it is successfully fetch the data from the device.
ERR_INTERNAL_ERROR	if not able to fetch the data.

Definition at line 510 of file Device_IP_Interface_Stats.cpp.

◆ get_Device_IP_Interface_Stats_DiscardPacketsSent()

int hostIf_IPInterfaceStats::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.

Note: One possible reason for discarding such a packet could be to free up buffer space.

Parameters

[out]	stMsgData	TR-069 Host interface message request.
[in]	pChanged	Status of the operation.

Returns: Returns the status of the operation.

Return values

OK	if it is successfully fetch the data from the device.
ERR_INTERNAL_ERROR	if not able to fetch the data.

Definition at line 544 of file Device_IP_Interface_Stats.cpp.

◆ get_Device_IP_Interface_Stats_DiscardPacketsReceived()

int hostIf_IPInterfaceStats::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.

Note: One possible reason for discarding such a packet could be to free up buffer space.

Parameters

[out]	stMsgData	TR-069 Host interface message request.
[in]	pChanged	Status of the operation.

Returns: Returns the status of the operation.

Return values

OK	if it is successfully fetch the data from the device.
ERR_INTERNAL_ERROR	if not able to fetch the data.

Definition at line 578 of file Device_IP_Interface_Stats.cpp.

◆ get_Device_IP_Interface_Stats_MulticastPacketsSent()

int hostIf_IPInterfaceStats::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.

Parameters

[out]	stMsgData	TR-069 Host interface message request.
[in]	pChanged	Status of the operation.

Returns: Returns the status of the operation.

Return values

OK	if it is successfully fetch the data from the device.
ERR_INTERNAL_ERROR	if not able to fetch the data.

Definition at line 610 of file Device_IP_Interface_Stats.cpp.

◆ get_Device_IP_Interface_Stats_MulticastPacketsReceived()

int hostIf_IPInterfaceStats::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.

Parameters

[out]	stMsgData	TR-069 Host interface message request.
[in]	pChanged	Status of the operation.

Returns: Returns the status of the operation.

Return values

OK	if it is successfully fetch the data from the device.
ERR_INTERNAL_ERROR	if not able to fetch the data.

Definition at line 642 of file Device_IP_Interface_Stats.cpp.

◆ get_Device_IP_Interface_Stats_BroadcastPacketsSent()

int hostIf_IPInterfaceStats::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.

Note: IPv6 does not define broadcast addresses, so IPv6 packets will never cause this counter to increment.

Parameters

[out]	stMsgData	TR-069 Host interface message request.
[in]	pChanged	Status of the operation.

Returns: Returns the status of the operation.

Return values

OK	if it is successfully fetch the data from the device.
ERR_INTERNAL_ERROR	if not able to fetch the data.

Definition at line 676 of file Device_IP_Interface_Stats.cpp.

◆ get_Device_IP_Interface_Stats_BroadcastPacketsReceived()

int hostIf_IPInterfaceStats::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.

Note: IPv6 does not define broadcast addresses, so IPv6 packets will never cause this counter to increment.

Parameters

[out]	stMsgData	TR-069 Host interface message request.
[in]	pChanged	Status of the operation.

Returns: Returns the status of the operation.

Return values

OK	if it successfully fetch the data from the device.
ERR_INTERNAL_ERROR	if not able to fetch the data.

Definition at line 711 of file Device_IP_Interface_Stats.cpp.

◆ get_Device_IP_Interface_Stats_UnknownProtoPacketsReceived()

int hostIf_IPInterfaceStats::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.

Parameters

[out]	stMsgData	TR-069 Host interface message request.
[in]	pChanged	Status of the operation.

Returns: Returns the status of the operation.

Return values

OK	if it successfully fetch the data from the device.
ERR_INTERNAL_ERROR	if not able to fetch the data.

Definition at line 743 of file Device_IP_Interface_Stats.cpp.

Description

Functions

Function Documentation

◆ get_Device_IP_Interface_Stats_BytesSent()

◆ get_Device_IP_Interface_Stats_BytesReceived()

◆ get_Device_IP_Interface_Stats_PacketsSent()

◆ get_Device_IP_Interface_Stats_PacketsReceived()

◆ get_Device_IP_Interface_Stats_ErrorsSent()

◆ get_Device_IP_Interface_Stats_ErrorsReceived()

◆ get_Device_IP_Interface_Stats_UnicastPacketsSent()

◆ get_Device_IP_Interface_Stats_UnicastPacketsReceived()

◆ get_Device_IP_Interface_Stats_DiscardPacketsSent()

◆ get_Device_IP_Interface_Stats_DiscardPacketsReceived()

◆ get_Device_IP_Interface_Stats_MulticastPacketsSent()

◆ get_Device_IP_Interface_Stats_MulticastPacketsReceived()

◆ get_Device_IP_Interface_Stats_BroadcastPacketsSent()

◆ get_Device_IP_Interface_Stats_BroadcastPacketsReceived()

◆ get_Device_IP_Interface_Stats_UnknownProtoPacketsReceived()