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

Description

Provides Throughput statistics for this interface.

The CPE MUST reset the MoCA interface's Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the MoCA interface becomes operationally down due to a previous administrative down (i.e. the MoCA interface's Status parameter transitions to a down state after the interface is disabled) or when the MoCA interface becomes administratively up (i.e. the MoCA interface's Enable parameter transitions from false to true). Administrative and operational interface status is discussed in [Section 4.2.2/TR-181i2].

int MoCAInterfaceStats::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 MoCAInterfaceStats::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 MoCAInterfaceStats::get_PacketsSent (HOSTIF_MsgData_t *stMsgData, bool *pChanged=NULL)
 Get the total number of packets transmitted out of the MoCA interface. More...
 
int MoCAInterfaceStats::get_PacketsReceived (HOSTIF_MsgData_t *stMsgData, bool *pChanged=NULL)
 Get the total number of packets received on the MoCA interface. More...
 
int MoCAInterfaceStats::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 MoCAInterfaceStats::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 MoCAInterfaceStats::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 MoCAInterfaceStats::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 MoCAInterfaceStats::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 MoCAInterfaceStats::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 MoCAInterfaceStats::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 MoCAInterfaceStats::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 MoCAInterfaceStats::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 MoCAInterfaceStats::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 MoCAInterfaceStats::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...
 

Function Documentation

◆ get_BytesSent()

int MoCAInterfaceStats::get_BytesSent ( HOSTIF_MsgData_t *  stMsgData,
bool *  pChanged = NULL 
)

Get the total number of bytes transmitted out of the MoCA interface, including framing characters.

This function provides the output as a numeric value available in Device.MoCA.Interface.{i}.Stats.BytesSent parameter.

Parameters
[in]stMsgDataTR-069 Host interface message request.
[out]pChangedpChange set to not NULL if the object value got changed.
Returns
Returns 0 on success, otherwise will return the appropriate error code.

Definition at line 90 of file Device_MoCA_Interface_Stats.cpp.

◆ get_BytesReceived()

int MoCAInterfaceStats::get_BytesReceived ( HOSTIF_MsgData_t *  stMsgData,
bool *  pChanged = NULL 
)

Get the total number of bytes received on the MoCA interface, including framing characters.

This function provides the output as a numeric value available in Device.MoCA.Interface.{i}.Stats.BytesReceived parameter.

Parameters
[in]stMsgDataTR-069 Host interface message request.
[out]pChangedpChange set to not NULL if the object value got changed.
Returns
Returns 0 on success, otherwise will return the appropriate error code.

Definition at line 106 of file Device_MoCA_Interface_Stats.cpp.

◆ get_PacketsSent()

int MoCAInterfaceStats::get_PacketsSent ( HOSTIF_MsgData_t *  stMsgData,
bool *  pChanged = NULL 
)

Get the total number of packets transmitted out of the MoCA interface.

This function provides the output as a numeric value available in Device.MoCA.Interface.{i}.Stats.PacketsSent parameter.

Parameters
[in]stMsgDataTR-069 Host interface message request.
[out]pChangedpChange set to not NULL if the object value got changed.
Returns
Returns 0 on success, otherwise will return the appropriate error code.

Definition at line 123 of file Device_MoCA_Interface_Stats.cpp.

◆ get_PacketsReceived()

int MoCAInterfaceStats::get_PacketsReceived ( HOSTIF_MsgData_t *  stMsgData,
bool *  pChanged = NULL 
)

Get the total number of packets received on the MoCA interface.

This function provides the output as a numeric value available in Device.MoCA.Interface.{i}.Stats.PacketsReceived parameter.

Parameters
[in]stMsgDataTR-069 Host interface message request.
[out]pChangedpChange set to not NULL if the object value got changed.
Returns
Returns 0 on success, otherwise will return the appropriate error code.

Definition at line 139 of file Device_MoCA_Interface_Stats.cpp.

◆ get_ErrorsSent()

int MoCAInterfaceStats::get_ErrorsSent ( HOSTIF_MsgData_t *  stMsgData,
bool *  pChanged = NULL 
)

Get the total number of outbound packets that could not be transmitted because of errors.

This function provides the output as a numeric value available in Device.MoCA.Interface.{i}.Stats.ErrorsSent parameter.

Parameters
[in]stMsgDataTR-069 Host interface message request.
[out]pChangedpChange set to not NULL if the object value got changed.
Returns
Returns 0 on success, otherwise will return the appropriate error code.

Definition at line 155 of file Device_MoCA_Interface_Stats.cpp.

◆ get_ErrorsReceived()

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

This function provides the output as a numeric value available in Device.MoCA.Interface.{i}.Stats.ErrorsReceived parameter.

Parameters
[in]stMsgDataTR-069 Host interface message request.
[out]pChangedpChange set to not NULL if the object value got changed.
Returns
Returns 0 on success, otherwise will return the appropriate error code.

Definition at line 172 of file Device_MoCA_Interface_Stats.cpp.

◆ get_UnicastPacketsSent()

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

This function provides the output as a numeric value available in Device.MoCA.Interface.{i}.Stats.UnicastPacketsSent parameter.

Parameters
[in]stMsgDataTR-069 Host interface message request.
[out]pChangedpChange set to not NULL if the object value got changed.
Returns
Returns 0 on success, otherwise will return the appropriate error code.

Definition at line 189 of file Device_MoCA_Interface_Stats.cpp.

◆ get_UnicastPacketsReceived()

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

This function provides the output as a numeric value available in Device.MoCA.Interface.{i}.Stats.UnicastPacketsReceived parameter.

Parameters
[in]stMsgDataTR-069 Host interface message request.
[out]pChangedpChange set to not NULL if the object value got changed.
Returns
Returns 0 on success, otherwise will return the appropriate error code.

Definition at line 205 of file Device_MoCA_Interface_Stats.cpp.

◆ get_DiscardPacketsSent()

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

This function provides the output as a numeric value available in Device.MoCA.Interface.{i}.Stats.DiscardPacketsSent parameter.

Parameters
[in]stMsgDataTR-069 Host interface message request.
[out]pChangedpChange set to not NULL if the object value got changed.
Returns
Returns 0 on success, otherwise will return the appropriate error code.

Definition at line 221 of file Device_MoCA_Interface_Stats.cpp.

◆ get_DiscardPacketsReceived()

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

This function provides the output as a numeric value available in Device.MoCA.Interface.{i}.Stats.DiscardPacketsReceived parameter.

Parameters
[in]stMsgDataTR-069 Host interface message request.
[out]pChangedpChange set to not NULL if the object value got changed.
Returns
Returns 0 on success, otherwise will return the appropriate error code.

Definition at line 237 of file Device_MoCA_Interface_Stats.cpp.

◆ get_MulticastPacketsSent()

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

This function provides the output as a numeric value available in Device.MoCA.Interface.{i}.Stats.MulticastPacketsSent parameter.

Parameters
[in]stMsgDataTR-069 Host interface message request.
[out]pChangedpChange set to not NULL if the object value got changed.
Returns
Returns 0 on success, otherwise will return the appropriate error code.

Definition at line 253 of file Device_MoCA_Interface_Stats.cpp.

◆ get_MulticastPacketsReceived()

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

This function provides the output as a numeric value available in Device.MoCA.Interface.{i}.Stats.MulticastPacketsReceived parameter.

Parameters
[in]stMsgDataTR-069 Host interface message request.
[out]pChangedpChange set to not NULL if the object value got changed.
Returns
Returns 0 on success, otherwise will return the appropriate error code.

Definition at line 270 of file Device_MoCA_Interface_Stats.cpp.

◆ get_BroadcastPacketsSent()

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

This function provides the output as a numeric value available in Device.MoCA.Interface.{i}.Stats.BroadcastPacketsSent parameter.

Parameters
[in]stMsgDataTR-069 Host interface message request.
[out]pChangedpChange set to not NULL if the object value got changed.
Returns
Returns 0 on success, otherwise will return the appropriate error code.

Definition at line 287 of file Device_MoCA_Interface_Stats.cpp.

◆ get_BroadcastPacketsReceived()

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

This function provides the output as a numeric value available in Device.MoCA.Interface.{i}.Stats.BroadcastPacketsReceived parameter.

Parameters
[in]stMsgDataTR-069 Host interface message request.
[out]pChangedpChange set to not NULL if the object value got changed.
Returns
Returns 0 on success, otherwise will return the appropriate error code.

Definition at line 303 of file Device_MoCA_Interface_Stats.cpp.

◆ get_UnknownProtoPacketsReceived()

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

This function provides the output as a numeric value available in Device.MoCA.Interface.{i}.Stats.UnknownProtoPacketsReceived parameter.

Parameters
[in]stMsgDataTR-069 Host interface message request.
[out]pChangedpChange set to not NULL if the object value got changed.
Returns
Returns 0 on success, otherwise will return the appropriate error code.

Definition at line 319 of file Device_MoCA_Interface_Stats.cpp.