Description

This module provides the interface functions related to wireless end point profile table.

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 all the same values for SSID, Location and Priority.

int	hostIf_WiFi_EndPoint_Profile::get_hostIf_WiFi_EndPoint_Profile_Enable (HOSTIF_MsgData_t *stMsgData)
	Enables or disables the wireless end point Profile table. When there are multiple WiFi EndPoint Profiles, e.g. each instance supports a different SSID and/or different security configuration, this parameter can be used to control which of the instances are currently enabled. More...

int	hostIf_WiFi_EndPoint_Profile::get_hostIf_WiFi_EndPoint_Profile_Status (HOSTIF_MsgData_t *stMsgData)
	Get the status of the wireless endpoint Profile. More...

int	hostIf_WiFi_EndPoint_Profile::get_hostIf_WiFi_EndPoint_Profile_Alias (HOSTIF_MsgData_t *stMsgData)
	Get the alias name of the wireless end point. More...

int	hostIf_WiFi_EndPoint_Profile::get_hostIf_WiFi_EndPoint_Profile_SSID (HOSTIF_MsgData_t *stMsgData)
	Get the profile identifier in use by the connection. More...

int	hostIf_WiFi_EndPoint_Profile::get_hostIf_WiFi_EndPoint_Profile_Location (HOSTIF_MsgData_t *stMsgData)
	Get the location of the profile. More...

int	hostIf_WiFi_EndPoint_Profile::get_hostIf_WiFi_EndPoint_Profile_Priority (HOSTIF_MsgData_t *stMsgData)
	Get the profile priority defines one of the criteria used by the End Point to automatically select the "best" access point when several APs with known profiles are simultaneously available for association. More...

Function Documentation

◆ get_hostIf_WiFi_EndPoint_Profile_Enable()

int hostIf_WiFi_EndPoint_Profile::get_hostIf_WiFi_EndPoint_Profile_Enable ( HOSTIF_MsgData_t * stMsgData )

Enables or disables the wireless end point Profile table. When there are multiple WiFi EndPoint Profiles, e.g. each instance supports a different SSID and/or different security configuration, this parameter can be used to control which of the instances are currently enabled.

Parameters

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

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

◆ get_hostIf_WiFi_EndPoint_Profile_Status()

int hostIf_WiFi_EndPoint_Profile::get_hostIf_WiFi_EndPoint_Profile_Status ( HOSTIF_MsgData_t * stMsgData )

Get the status of the wireless endpoint Profile.

The following enumeration of the wireless endpoint profile:

Active
Available
Error (OPTIONAL)
Disabled The Active value is reserved for the instance that is actively connected. The Available value represents an instance that is not currently active, but is also not disabled or in error. 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_hostIf_WiFi_EndPoint_Profile_Alias()

int hostIf_WiFi_EndPoint_Profile::get_hostIf_WiFi_EndPoint_Profile_Alias ( HOSTIF_MsgData_t * stMsgData )

Get the alias name of the wireless end point.

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_hostIf_WiFi_EndPoint_Profile_SSID()

int hostIf_WiFi_EndPoint_Profile::get_hostIf_WiFi_EndPoint_Profile_SSID ( HOSTIF_MsgData_t * stMsgData )

Get the profile identifier in use by the connection.

The SSID is an identifier that is attached to packets sent over the wireless LAN that functions as an ID for joining a particular radio network (BSS).

Parameters

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

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

◆ get_hostIf_WiFi_EndPoint_Profile_Location()

int hostIf_WiFi_EndPoint_Profile::get_hostIf_WiFi_EndPoint_Profile_Location ( HOSTIF_MsgData_t * stMsgData )

Get the location of the profile.

This value serves as a reminder from the user, describing the location of the profile. For example: "Home", "Office", "Neighbor House", "Airport", etc. An empty string is also valid.

Parameters

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

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

◆ get_hostIf_WiFi_EndPoint_Profile_Priority()

int hostIf_WiFi_EndPoint_Profile::get_hostIf_WiFi_EndPoint_Profile_Priority ( HOSTIF_MsgData_t * stMsgData )

Get the profile priority defines one of the criteria used by the End Point to automatically select the "best" access point when several APs with known profiles are simultaneously available for association.

In this situation, the End Point has to select the AP with the higher priority in its profile. If there are several APs with the same priority, providing different SSID or the same SSID, then the wireless end point has to select the APs according to other criteria like signal quality, SNR, etc.

Note: 0 is the highest priority.

Parameters

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

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