RDK Documentation (Open Sourced RDK Components)
TR-069 Object (Device.WiFi.Radio.{i}.Stat.) Public APIs

Description

Throughput statistics for this interface.

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

int hostIf_WiFi_Radio_Stats::get_Device_WiFi_Radio_Stats_BytesSent (HOSTIF_MsgData_t *stMsgData, int radioIndex)
 Get total number of bytes transmitted out of the interface, including framing characters. More...
 
int hostIf_WiFi_Radio_Stats::get_Device_WiFi_Radio_Stats_BytesReceived (HOSTIF_MsgData_t *stMsgData, int radioIndex)
 Get the total number of bytes received on the interface, including framing characters. More...
 
int hostIf_WiFi_Radio_Stats::get_Device_WiFi_Radio_Stats_PacketsSent (HOSTIF_MsgData_t *stMsgData, int radioIndex)
 Get the value of 'Device.WiFi.Radio.Stats.PacketsSent'. This function provides the total number of packets transmitted out of the interface. More...
 
int hostIf_WiFi_Radio_Stats::get_Device_WiFi_Radio_Stats_PacketsReceived (HOSTIF_MsgData_t *stMsgData, int radioIndex)
 Get the total number of packets received on the interface. More...
 
int hostIf_WiFi_Radio_Stats::get_Device_WiFi_Radio_Stats_ErrorsSent (HOSTIF_MsgData_t *stMsgData, int radioIndex)
 Get the total number of outbound packets that could not be transmitted because of errors. More...
 
int hostIf_WiFi_Radio_Stats::get_Device_WiFi_Radio_Stats_ErrorsReceived (HOSTIF_MsgData_t *stMsgData, int radioIndex)
 Get the total number of inbound packets that contained errors preventing them from being delivered to a higher-layer protocol. More...
 
int hostIf_WiFi_Radio_Stats::get_Device_WiFi_Radio_Stats_DiscardPacketsSent (HOSTIF_MsgData_t *stMsgData, int radioIndex)
 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 hostIf_WiFi_Radio_Stats::get_Device_WiFi_Radio_Stats_DiscardPacketsReceived (HOSTIF_MsgData_t *stMsgData, int radioIndex)
 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 hostIf_WiFi_Radio_Stats::get_Device_WiFi_Radio_Stats_NoiseFloor (HOSTIF_MsgData_t *stMsgData, int radioIndex)
 Get total number of bytes transmitted out of the interface, including framing characters. More...
 

Function Documentation

◆ get_Device_WiFi_Radio_Stats_BytesSent()

int hostIf_WiFi_Radio_Stats::get_Device_WiFi_Radio_Stats_BytesSent ( HOSTIF_MsgData_t stMsgData,
int  radioIndex 
)

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

This function provides the output as unsigned long value available in Device.WiFi.Radio.{i}.Stats.BytesSent parameter.

Parameters
[out]stMsgDataTR-069 Host interface message request.
[in]radioIndexIndex number.
Returns
Returns 0 on success, otherwise will return the appropriate error code.

◆ get_Device_WiFi_Radio_Stats_BytesReceived()

int hostIf_WiFi_Radio_Stats::get_Device_WiFi_Radio_Stats_BytesReceived ( HOSTIF_MsgData_t stMsgData,
int  radioIndex 
)

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

This function provides the output as unsigned long value available in Device.WiFi.Radio.{i}.Stats.BytesReceived parameter.

Parameters
[out]stMsgDataTR-069 Host interface message request.
[in]radioIndexIndex number.
Returns
Returns 0 on success, otherwise will return the appropriate error code.

◆ get_Device_WiFi_Radio_Stats_PacketsSent()

int hostIf_WiFi_Radio_Stats::get_Device_WiFi_Radio_Stats_PacketsSent ( HOSTIF_MsgData_t stMsgData,
int  radioIndex 
)

Get the value of 'Device.WiFi.Radio.Stats.PacketsSent'. This function provides the total number of packets transmitted out of the interface.

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

This function provides the output as unsigned long value available in Device.WiFi.Radio.{i}.Stats.PacketsSent parameter.

Parameters
[out]stMsgDataTR-069 Host interface message request.
[in]radioIndexIndex number.
Returns
Returns 0 on success, otherwise will return the appropriate error code.

◆ get_Device_WiFi_Radio_Stats_PacketsReceived()

int hostIf_WiFi_Radio_Stats::get_Device_WiFi_Radio_Stats_PacketsReceived ( HOSTIF_MsgData_t stMsgData,
int  radioIndex 
)

Get the total number of packets received on the interface.

This function provides the output as unsigned long value available in Device.WiFi.Radio.{i}.Stats.PacketReceived parameter.

Parameters
[out]stMsgDataTR-069 Host interface message request.
[in]radioIndexIndex number.
Returns
Returns 0 on success, otherwise will return the appropriate error code.

◆ get_Device_WiFi_Radio_Stats_ErrorsSent()

int hostIf_WiFi_Radio_Stats::get_Device_WiFi_Radio_Stats_ErrorsSent ( HOSTIF_MsgData_t stMsgData,
int  radioIndex 
)

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

This function provides the output as unsigned int value available in Device.WiFi.Radio.{i}.Stats.ErrorsSent parameter.

Parameters
[out]stMsgDataTR-069 Host interface message request.
[in]radioIndexIndex number.
Returns
Returns 0 on success, otherwise will return the appropriate error code.

◆ get_Device_WiFi_Radio_Stats_ErrorsReceived()

int hostIf_WiFi_Radio_Stats::get_Device_WiFi_Radio_Stats_ErrorsReceived ( HOSTIF_MsgData_t stMsgData,
int  radioIndex 
)

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 unsigned int value available in Device.WiFi.Radio.{i}.Stats.ErrorsReceived parameter.

Parameters
[out]stMsgDataTR-069 Host interface message request.
[in]radioIndexIndex number.
Returns
Returns 0 on success, otherwise will return the appropriate error code.

◆ get_Device_WiFi_Radio_Stats_DiscardPacketsSent()

int hostIf_WiFi_Radio_Stats::get_Device_WiFi_Radio_Stats_DiscardPacketsSent ( HOSTIF_MsgData_t stMsgData,
int  radioIndex 
)

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 unsigned int value available in Device.WiFi.Radio.{i}.Stats.DiscardPacketsSent parameter.

Parameters
[out]stMsgDataTR-069 Host interface message request.
[in]radioIndexIndex number.
Returns
Returns 0 on success, otherwise will return the appropriate error code.

◆ get_Device_WiFi_Radio_Stats_DiscardPacketsReceived()

int hostIf_WiFi_Radio_Stats::get_Device_WiFi_Radio_Stats_DiscardPacketsReceived ( HOSTIF_MsgData_t stMsgData,
int  radioIndex 
)

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 unsigned int value available in Device.WiFi.Radio.{i}.Stats.DiscardPacketsReceived parameter.

Parameters
[out]stMsgDataTR-069 Host interface message request.
[in]radioIndexIndex number.
Returns
Returns 0 on success, otherwise will return the appropriate error code.

◆ get_Device_WiFi_Radio_Stats_NoiseFloor()

int hostIf_WiFi_Radio_Stats::get_Device_WiFi_Radio_Stats_NoiseFloor ( HOSTIF_MsgData_t stMsgData,
int  radioIndex 
)

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

This function provides the output as unsigned long value available in Device.WiFi.Radio.{i}.Stats.BytesSent parameter.

Parameters
[out]stMsgDataTR-069 Host interface message request.
[in]radioIndexIndex number.
Returns
Returns 0 on success, otherwise will return the appropriate error code.