Description

The flow statistics table provides information on the MoCA parameterized QoS flows this interface has allocated onto the MoCA network.

At most one entry in this table can exist with a given value for FlowID.

int	MoCAInterfaceQoSFlowStats::get_FlowID (HOSTIF_MsgData_t stMsgData, unsigned int entryNum, bool pChanged=NULL)
	Get the flow ID used to identify a flow in the network. More...

int	MoCAInterfaceQoSFlowStats::get_PacketDA (HOSTIF_MsgData_t stMsgData, unsigned int entryNum, bool pChanged=NULL)
	Get the Destination Address (DA) for the packets in this flow. More...

int	MoCAInterfaceQoSFlowStats::get_MaxRate (HOSTIF_MsgData_t stMsgData, unsigned int entryNum, bool pChanged=NULL)
	Get the maximum required rate in Kbps. More...

int	MoCAInterfaceQoSFlowStats::get_MaxBurstSize (HOSTIF_MsgData_t stMsgData, unsigned int entryNum, bool pChanged=NULL)
	Get Maximum burst size of MoCA interface. More...

int	MoCAInterfaceQoSFlowStats::get_LeaseTime (HOSTIF_MsgData_t stMsgData, unsigned int entryNum, bool pChanged=NULL)
	Get the flow lease time (expressed in seconds). A LeaseTime of 0 means unlimited lease time. More...

int	MoCAInterfaceQoSFlowStats::get_LeaseTimeLeft (HOSTIF_MsgData_t stMsgData, unsigned int entryNum, bool pChanged=NULL)
	Get the Flow lease time remaining (expressed in seconds). More...

int	MoCAInterfaceQoSFlowStats::get_FlowPackets (HOSTIF_MsgData_t stMsgData, unsigned int entryNum, bool pChanged=NULL)
	Get the number of packets transmitted for this flow. More...

Function Documentation

◆ get_FlowID()

int MoCAInterfaceQoSFlowStats::get_FlowID	(	HOSTIF_MsgData_t *	stMsgData,
		unsigned int	entryNum,
		bool *	pChanged = `NULL`
	)

Get the flow ID used to identify a flow in the network.

This parameter is based on mocaIfFlowID from [MOCA11-MIB].

This function provides the output as a numeric value available in Device.MoCA.Interface.{i}.QoS.FlowStats.FlowID parameter.

Parameters

[out]	stMsgData	TR-069 Host interface message request.
[in]	entryNum	Entry Number.
[out]	pChanged	pChange 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 59 of file Device_MoCA_Interface_QoS_FlowStats.cpp.

◆ get_PacketDA()

int MoCAInterfaceQoSFlowStats::get_PacketDA	(	HOSTIF_MsgData_t *	stMsgData,
		unsigned int	entryNum,
		bool *	pChanged = `NULL`
	)

Get the Destination Address (DA) for the packets in this flow.

This function provides the output as a string value available in Device.MoCA.Interface.{i}.QoS.FlowStats.PacketDA parameter.

Parameters

[out]	stMsgData	TR-069 Host interface message request.
[in]	entryNum	Entry Number.
[out]	pChanged	pChange 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 67 of file Device_MoCA_Interface_QoS_FlowStats.cpp.

◆ get_MaxRate()

int MoCAInterfaceQoSFlowStats::get_MaxRate	(	HOSTIF_MsgData_t *	stMsgData,
		unsigned int	entryNum,
		bool *	pChanged = `NULL`
	)

Get the maximum required rate in Kbps.

This function provides the output as a numeric value available in Device.MoCA.Interface.{i}.QoS.FlowStats.MaxRate parameter.

Parameters

[out]	stMsgData	TR-069 Host interface message request.
[in]	entryNum	Entry Number.
[out]	pChanged	pChange 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 76 of file Device_MoCA_Interface_QoS_FlowStats.cpp.

◆ get_MaxBurstSize()

int MoCAInterfaceQoSFlowStats::get_MaxBurstSize	(	HOSTIF_MsgData_t *	stMsgData,
		unsigned int	entryNum,
		bool *	pChanged = `NULL`
	)

Get Maximum burst size of MoCA interface.

This function provides the output as a numeric value available in Device.MoCA.Interface.{i}.QoS.FlowStats.MaxBurstSize parameter.

Parameters

[out]	stMsgData	TR-069 Host interface message request.
[in]	entryNum	Entry Number.
[out]	pChanged	pChange 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 84 of file Device_MoCA_Interface_QoS_FlowStats.cpp.

◆ get_LeaseTime()

int MoCAInterfaceQoSFlowStats::get_LeaseTime	(	HOSTIF_MsgData_t *	stMsgData,
		unsigned int	entryNum,
		bool *	pChanged = `NULL`
	)

Get the flow lease time (expressed in seconds). A LeaseTime of 0 means unlimited lease time.

This function provides the output as a numeric value available in Device.MoCA.Interface.{i}.QoS.FlowStats.LeaseTime parameter.

Parameters

[out]	stMsgData	TR-069 Host interface message request.
[in]	entryNum	Entry Number.
[out]	pChanged	pChange 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 91 of file Device_MoCA_Interface_QoS_FlowStats.cpp.

◆ get_LeaseTimeLeft()

int MoCAInterfaceQoSFlowStats::get_LeaseTimeLeft	(	HOSTIF_MsgData_t *	stMsgData,
		unsigned int	entryNum,
		bool *	pChanged = `NULL`
	)

Get the Flow lease time remaining (expressed in seconds).

If LeaseTime is 0 then a LeaseTimeLeft of 0 means unlimited lease time; otherwise, a LeaseTimeLeft of 0 means expired.

This parameter is based on mocaIfLeaseTimeLeft from [MOCA11-MIB].

This function provides the output as a numeric value available in Device.MoCA.Interface.{i}.QoS.FlowStats.LeaseTimeLeft parameter.

Parameters

[out]	stMsgData	TR-069 Host interface message request.
[in]	entryNum	Entry Number.
[out]	pChanged	pChange 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 98 of file Device_MoCA_Interface_QoS_FlowStats.cpp.

◆ get_FlowPackets()

int MoCAInterfaceQoSFlowStats::get_FlowPackets	(	HOSTIF_MsgData_t *	stMsgData,
		unsigned int	entryNum,
		bool *	pChanged = `NULL`
	)

Get the number of packets transmitted for this flow.

This parameter is based on mocaIfTxPacketsFlow from [MOCA11-MIB].

This function provides the output as a numeric value available in Device.MoCA.Interface.{i}.QoS.FlowStats.FlowPackets parameter.

Parameters

[out]	stMsgData	TR-069 Host interface message request.
[in]	entryNum	Entry Number.
[out]	pChanged	pChange 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 105 of file Device_MoCA_Interface_QoS_FlowStats.cpp.