Description

This object models an 802.11 connection from the perspective of a wireless end point. Each EndPoint entry is associated with a particular SSID interface instance via the SSIDReference parameter, and an associated active Profile instance via the ProfileReference parameter. The active profile is responsible for specifying the actual SSID and security settings used by the end point.

For enabled table entries, if SSIDReference or ProfileReference is not a valid reference then the table entry is inoperable and the CPE MUST set Status to Error_Misconfigured.

Note: The EndPoint table includes a unique key parameter that is a strong reference. If a strongly referenced object is deleted, the CPE will set the referencing parameter to an empty string. However, doing so under these circumstances might cause the updated EndPoint row to then violate the table's unique key constraint;

if this occurs, the CPE MUST set Status to Error_Misconfigured and disable the offending EndPoint row. At most one entry in this table (regardless of whether or not it is enabled) can exist with a given value for Alias. On creation of a new table entry, the CPE MUST choose an initial value for Alias such that the new entry does not conflict with any existing entries.

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

int	hostIf_WiFi_EndPoint::get_Device_WiFi_EndPoint_Enable (HOSTIF_MsgData_t *stMsgData)
	Check wethen wifi endpoint is enabled or not. More...

int	hostIf_WiFi_EndPoint::set_Device_WiFi_EndPoint_Enable (HOSTIF_MsgData_t *stMsgData)
	Enables or disables this end point. More...

int	hostIf_WiFi_EndPoint::get_Device_WiFi_EndPoint_Status (HOSTIF_MsgData_t *stMsgData)
	Get the status of the wireless end point. More...

int	hostIf_WiFi_EndPoint::get_Device_WiFi_EndPoint_Alias (HOSTIF_MsgData_t *stMsgData)
	Get the alias name of the wireless endpoint. More...

int	hostIf_WiFi_EndPoint::set_Device_WiFi_EndPoint_Alias (HOSTIF_MsgData_t *stMsgData)
	Set the alias name for the wireless endpoint. More...

int	hostIf_WiFi_EndPoint::get_Device_WiFi_EndPoint_ProfileReference (HOSTIF_MsgData_t *stMsgData)
	Set the alias name for the wireless endpoint. More...

int	hostIf_WiFi_EndPoint::set_Device_WiFi_EndPoint_ProfileReference (HOSTIF_MsgData_t *stMsgData)
	Set the value MUST be the path name of a row in the Profile table. If the referenced object is deleted, the parameter value MUST be set to an empty string. This is the currently active profile, which specifies the SSID and security settings to be used by the end point. More...

int	hostIf_WiFi_EndPoint::get_Device_WiFi_EndPoint_SSIDReference (HOSTIF_MsgData_t *stMsgData)
	Check wethen wifi endpoint is enabled or not. More...

int	hostIf_WiFi_EndPoint::get_Device_WiFi_EndPoint_ProfileNumberOfEntries (HOSTIF_MsgData_t *stMsgData)
	Check wethen wifi endpoint is enabled or not. More...

int	hostIf_WiFi_EndPoint::get_Device_WiFi_EndPoint_Stats_LastDataDownlinkRate (HOSTIF_MsgData_t *stMsgData)
	Get the data transmit rate in kbps that was most recently used for transmission from the access point to the end point device. More...

int	hostIf_WiFi_EndPoint::get_Device_WiFi_EndPoint_Stats_LastDataUplinkRate (HOSTIF_MsgData_t *stMsgData)
	The data transmit rate in kbps that was most recently used for transmission from the end point to the access point device. More...

int	hostIf_WiFi_EndPoint::get_Device_WiFi_EndPoint_Stats_SignalStrength (HOSTIF_MsgData_t *stMsgData)
	This function provide an indicator of radio signal strength of the downlink from the access point to the end point, measured in dBm, as an average of the last 100 packets received from the device.. More...

int	hostIf_WiFi_EndPoint::get_Device_WiFi_EndPoint_Stats_Retransmissions (HOSTIF_MsgData_t *stMsgData)
	Get the number of packets that had to be re-transmitted, from the last 100 packets sent to the access point. Multiple re-transmissions of the same packet count as one. More...

Function Documentation

◆ get_Device_WiFi_EndPoint_Enable()

int hostIf_WiFi_EndPoint::get_Device_WiFi_EndPoint_Enable ( HOSTIF_MsgData_t * stMsgData )

Check wethen wifi endpoint is enabled or not.

Parameters

[out] stMsgData TR-069 Host interface message request.

Returns: Returns 0 on success, otherwise will return the appropriate error code.

◆ set_Device_WiFi_EndPoint_Enable()

int hostIf_WiFi_EndPoint::set_Device_WiFi_EndPoint_Enable ( HOSTIF_MsgData_t * stMsgData )

Enables or disables this end point.

Parameters

[out] stMsgData TR-069 Host interface message request.

Returns: Returns 0 on success, otherwise will return the appropriate error code.

◆ get_Device_WiFi_EndPoint_Status()

int hostIf_WiFi_EndPoint::get_Device_WiFi_EndPoint_Status ( HOSTIF_MsgData_t * stMsgData )

Get the status of the wireless end point.

The status of the wifi end point could be the enumeration of:

Disabled
Enabled
Error_Misconfigured
Error (OPTIONAL)

The Error_Misconfigured value indicates that a necessary configuration value is undefined or invalid. The Error value MAY be used by the CPE to indicate a locally defined error condition.

Parameters

[out] stMsgData TR-069 Host interface message request.

Returns: Returns 0 on success, otherwise will return the appropriate error code.

◆ get_Device_WiFi_EndPoint_Alias()

int hostIf_WiFi_EndPoint::get_Device_WiFi_EndPoint_Alias ( HOSTIF_MsgData_t * stMsgData )

Get the alias name of the wireless endpoint.

A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. An initial unique value MUST be assigned when the CPE creates an instance of this object.

Parameters

[out] stMsgData TR-069 Host interface message request.

Returns: Returns 0 on success, otherwise will return the appropriate error code.

◆ set_Device_WiFi_EndPoint_Alias()

int hostIf_WiFi_EndPoint::set_Device_WiFi_EndPoint_Alias ( HOSTIF_MsgData_t * stMsgData )

Set the alias name for the wireless endpoint.

A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069a4] and described in [Appendix II/TR-069a4], the following mandatory constraints MUST be enforced:

Its value MUST NOT be empty.
Its value MUST start with a letter.
If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
The CPE MUST NOT change the parameter value.

Parameters

[out] stMsgData TR-069 Host interface message request.

Returns: Returns 0 on success, otherwise will return the appropriate error code.

◆ get_Device_WiFi_EndPoint_ProfileReference()

int hostIf_WiFi_EndPoint::get_Device_WiFi_EndPoint_ProfileReference ( HOSTIF_MsgData_t * stMsgData )

Set the alias name for the wireless endpoint.

A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in [Section 3.6.1/TR-069a4] and described in [Appendix II/TR-069a4], the following mandatory constraints MUST be enforced:

Its value MUST NOT be empty.
Its value MUST start with a letter.
If its value is not assigned by the ACS, it MUST start with a "cpe-" prefix.
The CPE MUST NOT change the parameter value.

Parameters

[out] stMsgData TR-069 Host interface message request.

Returns: Returns 0 on success, otherwise will return the appropriate error code.

◆ set_Device_WiFi_EndPoint_ProfileReference()

int hostIf_WiFi_EndPoint::set_Device_WiFi_EndPoint_ProfileReference ( HOSTIF_MsgData_t * stMsgData )

Set the value MUST be the path name of a row in the Profile table. If the referenced object is deleted, the parameter value MUST be set to an empty string. This is the currently active profile, which specifies the SSID and security settings to be used by the end point.

Parameters

[out] stMsgData TR-069 Host interface message request.

Returns: Returns 0 on success, otherwise will return the appropriate error code.

◆ get_Device_WiFi_EndPoint_SSIDReference()

int hostIf_WiFi_EndPoint::get_Device_WiFi_EndPoint_SSIDReference ( HOSTIF_MsgData_t * stMsgData )

Check wethen wifi endpoint is enabled or not.

Parameters

[out] stMsgData TR-069 Host interface message request.

Returns: Returns 0 on success, otherwise will return the appropriate error code.

◆ get_Device_WiFi_EndPoint_ProfileNumberOfEntries()

int hostIf_WiFi_EndPoint::get_Device_WiFi_EndPoint_ProfileNumberOfEntries ( HOSTIF_MsgData_t * stMsgData )

Check wethen wifi endpoint is enabled or not.

Parameters

[out] stMsgData TR-069 Host interface message request.

Returns: Returns 0 on success, otherwise will return the appropriate error code.

◆ get_Device_WiFi_EndPoint_Stats_LastDataDownlinkRate()

int hostIf_WiFi_EndPoint::get_Device_WiFi_EndPoint_Stats_LastDataDownlinkRate ( HOSTIF_MsgData_t * stMsgData )

Get the data transmit rate in kbps that was most recently used for transmission from the access point to the end point device.

Parameters

[out] stMsgData TR-069 Host interface message request.

Returns: Returns 0 on success, otherwise will return the appropriate error code.

◆ get_Device_WiFi_EndPoint_Stats_LastDataUplinkRate()

int hostIf_WiFi_EndPoint::get_Device_WiFi_EndPoint_Stats_LastDataUplinkRate ( HOSTIF_MsgData_t * stMsgData )

The data transmit rate in kbps that was most recently used for transmission from the end point to the access point device.

Parameters

[out] stMsgData TR-069 Host interface message request.

Returns: Returns 0 on success, otherwise will return the appropriate error code.

◆ get_Device_WiFi_EndPoint_Stats_SignalStrength()

int hostIf_WiFi_EndPoint::get_Device_WiFi_EndPoint_Stats_SignalStrength ( HOSTIF_MsgData_t * stMsgData )

This function provide an indicator of radio signal strength of the downlink from the access point to the end point, measured in dBm, as an average of the last 100 packets received from the device..

Parameters

[out] stMsgData TR-069 Host interface message request.

Returns: Returns 0 on success, otherwise will return the appropriate error code.

◆ get_Device_WiFi_EndPoint_Stats_Retransmissions()

int hostIf_WiFi_EndPoint::get_Device_WiFi_EndPoint_Stats_Retransmissions ( HOSTIF_MsgData_t * stMsgData )

Get the number of packets that had to be re-transmitted, from the last 100 packets sent to the access point. Multiple re-transmissions of the same packet count as one.

Parameters

[out] stMsgData TR-069 Host interface message request.

Returns: Returns 0 on success, otherwise will return the appropriate error code.