RDK Documentation (Open Sourced RDK Components)
TR-069 Object (Device.WiFi.SSID.{i}.Stats) 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_SSID_Stats::get_Device_WiFi_SSID_Stats_BytesSent (HOSTIF_MsgData_t *stMsgData)
 Get the total number of bytes transmitted out of the interface, including framing characters. More...
 
int hostIf_WiFi_SSID_Stats::get_Device_WiFi_SSID_Stats_BytesReceived (HOSTIF_MsgData_t *stMsgData)
 Get the total number of bytes received on the interface, including framing characters. More...
 
int hostIf_WiFi_SSID_Stats::get_Device_WiFi_SSID_Stats_PacketsSent (HOSTIF_MsgData_t *stMsgData)
 Get the total number of packets transmitted out of the interface. More...
 
int hostIf_WiFi_SSID_Stats::get_Device_WiFi_SSID_Stats_PacketsReceived (HOSTIF_MsgData_t *stMsgData)
 Get the total number of packets received on the interface. More...
 
int hostIf_WiFi_SSID_Stats::get_Device_WiFi_SSID_Stats_ErrorsSent (HOSTIF_MsgData_t *stMsgData)
 Get the total number of outbound packets that could not be transmitted because of errors. More...
 
int hostIf_WiFi_SSID_Stats::get_Device_WiFi_SSID_Stats_ErrorsReceived (HOSTIF_MsgData_t *stMsgData)
 Get the total number of inbound packets that contained errors preventing them from being delivered to a higher-layer protocol. More...
 
int hostIf_WiFi_SSID_Stats::get_Device_WiFi_SSID_Stats_UnicastPacketsSent (HOSTIF_MsgData_t *stMsgData)
 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 hostIf_WiFi_SSID_Stats::get_Device_WiFi_SSID_Stats_UnicastPacketsReceived (HOSTIF_MsgData_t *stMsgData)
 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 hostIf_WiFi_SSID_Stats::get_Device_WiFi_SSID_Stats_DiscardPacketsSent (HOSTIF_MsgData_t *stMsgData)
 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_SSID_Stats::get_Device_WiFi_SSID_Stats_DiscardPacketsReceived (HOSTIF_MsgData_t *stMsgData)
 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_SSID_Stats::get_Device_WiFi_SSID_Stats_MulticastPacketsSent (HOSTIF_MsgData_t *stMsgData)
 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 hostIf_WiFi_SSID_Stats::get_Device_WiFi_SSID_Stats_MulticastPacketsReceived (HOSTIF_MsgData_t *stMsgData)
 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 hostIf_WiFi_SSID_Stats::get_Device_WiFi_SSID_Stats_BroadcastPacketsSent (HOSTIF_MsgData_t *stMsgData)
 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 hostIf_WiFi_SSID_Stats::get_Device_WiFi_SSID_Stats_BroadcastPacketsReceived (HOSTIF_MsgData_t *stMsgData)
 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 hostIf_WiFi_SSID_Stats::get_Device_WiFi_SSID_Stats_UnknownProtoPacketsReceived (HOSTIF_MsgData_t *stMsgData)
 Get the total number of packets received via the interface which were discarded because of an unknown or unsupported protocol. More...
 

Function Documentation

◆ get_Device_WiFi_SSID_Stats_BytesSent()

int hostIf_WiFi_SSID_Stats::get_Device_WiFi_SSID_Stats_BytesSent ( HOSTIF_MsgData_t stMsgData)

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

This function provides the output as a unsinged long value available in Device.WiFi.SSID.Stats.BytesSent parameter.

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

◆ get_Device_WiFi_SSID_Stats_BytesReceived()

int hostIf_WiFi_SSID_Stats::get_Device_WiFi_SSID_Stats_BytesReceived ( HOSTIF_MsgData_t stMsgData)

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

This function provides the output as integer value available in Device.WiFi.SSID.Stats.BytesReceived parameter.

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

◆ get_Device_WiFi_SSID_Stats_PacketsSent()

int hostIf_WiFi_SSID_Stats::get_Device_WiFi_SSID_Stats_PacketsSent ( HOSTIF_MsgData_t stMsgData)

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

This function provides the output as integer value available in Device.WiFi.SSID.Stats.PacketsSent parameter.

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

◆ get_Device_WiFi_SSID_Stats_PacketsReceived()

int hostIf_WiFi_SSID_Stats::get_Device_WiFi_SSID_Stats_PacketsReceived ( HOSTIF_MsgData_t stMsgData)

Get the total number of packets received on the interface.

This function provides the output as a integer value available in Device.WiFi.SSID.Stats.PacketsReceived parameter.

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

◆ get_Device_WiFi_SSID_Stats_ErrorsSent()

int hostIf_WiFi_SSID_Stats::get_Device_WiFi_SSID_Stats_ErrorsSent ( HOSTIF_MsgData_t stMsgData)

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

This function provides the output as a integer value available in Device.WiFi.SSID.Stats.ErrorsSent parameter.

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

◆ get_Device_WiFi_SSID_Stats_ErrorsReceived()

int hostIf_WiFi_SSID_Stats::get_Device_WiFi_SSID_Stats_ErrorsReceived ( HOSTIF_MsgData_t stMsgData)

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 integer value available in Device.WiFi.SSID.Stats.ErrorsReceived parameter.

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

◆ get_Device_WiFi_SSID_Stats_UnicastPacketsSent()

int hostIf_WiFi_SSID_Stats::get_Device_WiFi_SSID_Stats_UnicastPacketsSent ( HOSTIF_MsgData_t stMsgData)

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 integer value available in Device.WiFi.SSID.Stats.UnicastPacketsSent parameter.

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

◆ get_Device_WiFi_SSID_Stats_UnicastPacketsReceived()

int hostIf_WiFi_SSID_Stats::get_Device_WiFi_SSID_Stats_UnicastPacketsReceived ( HOSTIF_MsgData_t stMsgData)

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 integer value available in Device.WiFi.SSID.Stats.UnicastPacketsReceived parameter.

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

◆ get_Device_WiFi_SSID_Stats_DiscardPacketsSent()

int hostIf_WiFi_SSID_Stats::get_Device_WiFi_SSID_Stats_DiscardPacketsSent ( HOSTIF_MsgData_t stMsgData)

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 integer value available in Device.WiFi.SSID.Stats.DiscardPacketsSent parameter.

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

◆ get_Device_WiFi_SSID_Stats_DiscardPacketsReceived()

int hostIf_WiFi_SSID_Stats::get_Device_WiFi_SSID_Stats_DiscardPacketsReceived ( HOSTIF_MsgData_t stMsgData)

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 integer value available in Device.WiFi.SSID.Stats.DiscardPacketsReceived parameter.

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

◆ get_Device_WiFi_SSID_Stats_MulticastPacketsSent()

int hostIf_WiFi_SSID_Stats::get_Device_WiFi_SSID_Stats_MulticastPacketsSent ( HOSTIF_MsgData_t stMsgData)

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 numeric value available in Device.WiFi.SSID.Stats.MulticastPacketsSent parameter.

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

◆ get_Device_WiFi_SSID_Stats_MulticastPacketsReceived()

int hostIf_WiFi_SSID_Stats::get_Device_WiFi_SSID_Stats_MulticastPacketsReceived ( HOSTIF_MsgData_t stMsgData)

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.WiFi.SSID.Stats.MulticastPacketsReceived parameter.

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

◆ get_Device_WiFi_SSID_Stats_BroadcastPacketsSent()

int hostIf_WiFi_SSID_Stats::get_Device_WiFi_SSID_Stats_BroadcastPacketsSent ( HOSTIF_MsgData_t stMsgData)

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.WiFi.SSID.Stats.BroadcastPacketsSent parameter.

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

◆ get_Device_WiFi_SSID_Stats_BroadcastPacketsReceived()

int hostIf_WiFi_SSID_Stats::get_Device_WiFi_SSID_Stats_BroadcastPacketsReceived ( HOSTIF_MsgData_t stMsgData)

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.WiFi.SSID.Stats.BroadcastPacketsReceived parameter.

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

◆ get_Device_WiFi_SSID_Stats_UnknownProtoPacketsReceived()

int hostIf_WiFi_SSID_Stats::get_Device_WiFi_SSID_Stats_UnknownProtoPacketsReceived ( HOSTIF_MsgData_t stMsgData)

Get the total number of packets received via the interface which were discarded because of an unknown or unsupported protocol.

This function provides the output as a numeric value available in Device.WiFi.SSID.Stats.UnknownProtoPacketsReceived parameter.

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