RDK Documentation (Open Sourced RDK Components)
Functions
TR-069 Object (Device.Ethernet.Interface.{i}.Stats) Public APIs
TR-069 » TR-069 Host Interface » TR-069 Host Interface Profile » TR-069 Object (Device.Ethernet) » TR-069 Object (Device.Ethernet.Interface.{i}.Stats)

Description

Describe the details about TR-069 Device ethernet interface stats APIs specifications.

Functions

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

Function Documentation

◆ get_Device_Ethernet_Interface_Stats_BytesSent()

int hostIf_EthernetInterfaceStats::get_Device_Ethernet_Interface_Stats_BytesSent ( HOSTIF_MsgData_t *  stMsgData,
bool *  pChanged = NULL 
)

This function provides the total number of bytes transmitted out of this Ethernet interface, including framing characters.

Parameters
[out]stMsgDataTR-069 Host interface message request.
[in]pChangedStatus of the operation.
Returns
Returns the status of the operation.
Return values
OKif is successfully fetch the data from the device.
ERR_INTERNAL_ERRORif not able to fetch the data.

Definition at line 388 of file Device_Ethernet_Interface_Stats.cpp.

◆ get_Device_Ethernet_Interface_Stats_BytesReceived()

int hostIf_EthernetInterfaceStats::get_Device_Ethernet_Interface_Stats_BytesReceived ( HOSTIF_MsgData_t *  stMsgData,
bool *  pChanged = NULL 
)

This function provides the total number of bytes received on this Ethernet interface, including framing characters.

Parameters
[out]stMsgDataTR-069 Host interface message request.
[in]pChangedStatus of the operation.
Returns
Return '0' if the method successfully received the total number of bytes via ethernet interface else returns '-1'.

Definition at line 416 of file Device_Ethernet_Interface_Stats.cpp.

◆ get_Device_Ethernet_Interface_Stats_PacketsSent()

int hostIf_EthernetInterfaceStats::get_Device_Ethernet_Interface_Stats_PacketsSent ( HOSTIF_MsgData_t *  stMsgData,
bool *  pChanged = NULL 
)

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

Parameters
[out]stMsgDataTR-069 Host interface message request.
[in]pChangedStatus of the operation.
Returns
Returns '0' if the method successfully sent the packets via ethernet interface else returns '-1'.

Definition at line 443 of file Device_Ethernet_Interface_Stats.cpp.

◆ get_Device_Ethernet_Interface_Stats_PacketsReceived()

int hostIf_EthernetInterfaceStats::get_Device_Ethernet_Interface_Stats_PacketsReceived ( HOSTIF_MsgData_t *  stMsgData,
bool *  pChanged = NULL 
)

This function provides the total number of packets received on this Ethernet interface.

Parameters
[out]stMsgDataTR-069 Host interface message request.
[in]pChangedStatus of the operation.
Returns
Returns '0' if the method successfully receive the total number of packets via ethernet interface else returns '1'.

Definition at line 470 of file Device_Ethernet_Interface_Stats.cpp.

◆ get_Device_Ethernet_Interface_Stats_ErrorsSent()

int hostIf_EthernetInterfaceStats::get_Device_Ethernet_Interface_Stats_ErrorsSent ( HOSTIF_MsgData_t *  stMsgData,
bool *  pChanged = NULL 
)

This function provides the total number of outbound packets that could not be transmitted because of errors.

Parameters
[out]stMsgDataTR-069 Host interface message request.
[in]pChangedStatus of the operation.
Returns
Returns '0' if the method successfully sent the errors via ethernet interface else returns '-1'.

Definition at line 498 of file Device_Ethernet_Interface_Stats.cpp.

◆ get_Device_Ethernet_Interface_Stats_ErrorsReceived()

int hostIf_EthernetInterfaceStats::get_Device_Ethernet_Interface_Stats_ErrorsReceived ( HOSTIF_MsgData_t *  stMsgData,
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.

Parameters
[out]stMsgDataTR-069 Host interface message request.
[in]pChangedStatus of the operation.
Returns
Returns '0' if the method successfully receive the errors via ethernet interface stats else returns '-1'.

Definition at line 526 of file Device_Ethernet_Interface_Stats.cpp.

◆ get_Device_Ethernet_Interface_Stats_UnicastPacketsSent()

int hostIf_EthernetInterfaceStats::get_Device_Ethernet_Interface_Stats_UnicastPacketsSent ( HOSTIF_MsgData_t *  stMsgData,
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.

Parameters
[out]stMsgDataTR-069 Host interface message request.
[in]pChangedStatus of the operation.
Returns
Returns '0' if the method successfully sent the unicast packets via ethernet interface else returns '-1'.

Definition at line 556 of file Device_Ethernet_Interface_Stats.cpp.

◆ get_Device_Ethernet_Interface_Stats_UnicastPacketsReceived()

int hostIf_EthernetInterfaceStats::get_Device_Ethernet_Interface_Stats_UnicastPacketsReceived ( HOSTIF_MsgData_t *  stMsgData,
bool *  pChanged = NULL 
)

Get the number of unicast packets received on an Ethernet Interface.

This function get the number of unicast 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 not addressed to a multicast or broadcast address at this layer.

This function 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.

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

Parameters
[out]stMsgDataTR-069 Host interface message request.
[in]pChangedStatus of the operation.
Returns
Returns '0' if the method successfully receive the unicast packets via ethernet interface else returns '-1'.

Definition at line 585 of file Device_Ethernet_Interface_Stats.cpp.

◆ get_Device_Ethernet_Interface_Stats_DiscardPacketsSent()

int hostIf_EthernetInterfaceStats::get_Device_Ethernet_Interface_Stats_DiscardPacketsSent ( HOSTIF_MsgData_t *  stMsgData,
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.

Note
One possible reason for discarding such a packet could be to free up buffer space.
Parameters
[out]stMsgDataTR-069 Host interface message request.
[in]pChangedStatus of the operation.
Returns
Returns '0' if the method successfully discard the unicast packets sent via ethernet interface else returns '-1'.

Definition at line 618 of file Device_Ethernet_Interface_Stats.cpp.

◆ get_Device_Ethernet_Interface_Stats_DiscardPacketsReceived()

int hostIf_EthernetInterfaceStats::get_Device_Ethernet_Interface_Stats_DiscardPacketsReceived ( HOSTIF_MsgData_t *  stMsgData,
bool *  pChanged = NULL 
)

Get the number of discarded inbound packets on an Ethernet Interface.

This function get the number of discarded inbound packets on an Ethernet Interface. This function 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.

This function 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.

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

Note
One possible reason for discarding such a packet could be to free up buffer space.
Parameters
[out]stMsgDataTR-069 Host interface message request.
[in]pChangedStatus of the operation.
Returns
Returns '0' if the method successfully discard the unicast packets received via ethernet interface else returns '-1'.

Definition at line 651 of file Device_Ethernet_Interface_Stats.cpp.

◆ get_Device_Ethernet_Interface_Stats_MulticastPacketsSent()

int hostIf_EthernetInterfaceStats::get_Device_Ethernet_Interface_Stats_MulticastPacketsSent ( HOSTIF_MsgData_t *  stMsgData,
bool *  pChanged = NULL 
)

Get the number of Multicast Packets sent on an Ethernet Interface.

This function get the number of Multicast 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 multicast address at this layer, including those that were discarded or not sent.

This function 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.

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

Parameters
[out]stMsgDataTR-069 Host interface message request.
[in]pChangedStatus of the operation.
Returns
Returns '0' if the method successfully sent the multicast packets via ethernet interface else returns '-1'.

Definition at line 682 of file Device_Ethernet_Interface_Stats.cpp.

◆ get_Device_Ethernet_Interface_Stats_MulticastPacketsReceived()

int hostIf_EthernetInterfaceStats::get_Device_Ethernet_Interface_Stats_MulticastPacketsReceived ( HOSTIF_MsgData_t *  stMsgData,
bool *  pChanged = NULL 
)

Get the number of Multicast Packets received on an Ethernet Interface.

This function get the number of Multicast 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 multicast address at this layer.

This function 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.

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

Parameters
[out]stMsgDataTR-069 Host interface message request.
[in]pChangedStatus of the operation.
Returns
Returns '0' if the method successfully received the multicast packets via ethernet interface else returns '-1'.

Definition at line 712 of file Device_Ethernet_Interface_Stats.cpp.

◆ get_Device_Ethernet_Interface_Stats_BroadcastPacketsSent()

int hostIf_EthernetInterfaceStats::get_Device_Ethernet_Interface_Stats_BroadcastPacketsSent ( HOSTIF_MsgData_t *  stMsgData,
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.

Note
IPv6 does not define broadcast addresses, so IPv6 packets will never cause this counter to increment.
Parameters
[out]stMsgDataTR-069 Host interface message request.
[in]pChangedStatus of the operation.
Returns
Returns '0' if the method successfully sent the broadcast packets via etherne interface else returns '-1'.

Definition at line 746 of file Device_Ethernet_Interface_Stats.cpp.

◆ get_Device_Ethernet_Interface_Stats_BroadcastPacketsReceived()

int hostIf_EthernetInterfaceStats::get_Device_Ethernet_Interface_Stats_BroadcastPacketsReceived ( HOSTIF_MsgData_t *  stMsgData,
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.

Note
IPv6 does not define broadcast addresses, so IPv6 packets will never cause this counter to increment.
Parameters
[out]stMsgDataTR-069 Host interface message request.
[in]pChangedStatus of the operation.
Returns
Returns '0' if the method successfully received the broadcast packets via ethernet interface else returns '-1'.

Definition at line 778 of file Device_Ethernet_Interface_Stats.cpp.

◆ get_Device_Ethernet_Interface_Stats_UnknownProtoPacketsReceived()

int hostIf_EthernetInterfaceStats::get_Device_Ethernet_Interface_Stats_UnknownProtoPacketsReceived ( HOSTIF_MsgData_t *  stMsgData,
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.

Parameters
[out]stMsgDataTR-069 Host interface message request.
[in]pChangedStatus of the operation.
Returns
Returns '0' if the method successfully received the unknown proto packets via ethernet interface else returns '-1'.

Definition at line 807 of file Device_Ethernet_Interface_Stats.cpp.