RDK Documentation (Open Sourced RDK Components)
TR-069 Object (Device.WiFi.AccessPoint.{i}) API

Description

This object models an 802.11 connection from the perspective of a wireless access point. Each AccessPoint entry is associated with a particular SSID interface instance via the SSIDReference parameter.

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

Note
The AccessPoint 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 AccessPoint 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 AccessPoint 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_AccessPoint::get_hostIf_WiFi_AccessPoint_Enable (HOSTIF_MsgData_t *stMsgData)
 Enables or disables this access point. More...
 
int hostIf_WiFi_AccessPoint::get_hostIf_WiFi_AccessPoint_Status (HOSTIF_MsgData_t *stMsgData)
 Get the status of the access point which is currently being set. The status of the access point could be the following types,. More...
 
int hostIf_WiFi_AccessPoint::get_hostIf_WiFi_AccessPoint_Alias (HOSTIF_MsgData_t *stMsgData)
 Get the access point alias based addressing. Alias provides a mechanism for an ACS to label the instance for future reference. The following mandatory constraints MUST be enforced: More...
 
int hostIf_WiFi_AccessPoint::get_hostIf_WiFi_AccessPoint_SSIDReference (HOSTIF_MsgData_t *stMsgData)
 Get path name of a row in the SSID table. If the parameter value is set to Null indicate that the reference object is deleted. More...
 
int hostIf_WiFi_AccessPoint::get_hostIf_WiFi_AccessPoint_SSIDAdvertisementEnabled (HOSTIF_MsgData_t *stMsgData)
 Check whether or not beacons include the SSID name. More...
 
int hostIf_WiFi_AccessPoint::get_hostIf_WiFi_AccessPoint_RetryLimit (HOSTIF_MsgData_t *stMsgData)
 Get thee maximum number of retransmission for a packet. This corresponds to IEEE 802.11 parameter dot11ShortRetryLimit. More...
 
int hostIf_WiFi_AccessPoint::get_hostIf_WiFi_AccessPoint_WMMCapability (HOSTIF_MsgData_t *stMsgData)
 Check whether this access point supports WiFi Multimedia (WMM) Access Categories (AC). More...
 
int hostIf_WiFi_AccessPoint::get_hostIf_WiFi_AccessPoint_UAPSDCapability (HOSTIF_MsgData_t *stMsgData)
 Check whether this access point supports WMM Unscheduled Automatic Power Save Delivery (U-APSD). More...
 
int hostIf_WiFi_AccessPoint::get_hostIf_WiFi_AccessPoint_WMMEnable (HOSTIF_MsgData_t *stMsgData)
 Check whether WMM support is currently enabled. When enabled, this is indicated in beacon frames. More...
 
int hostIf_WiFi_AccessPoint::get_hostIf_WiFi_AccessPoint_UAPSDEnable (HOSTIF_MsgData_t *stMsgData)
 Whether U-APSD support is currently enabled. When enabled, this is indicated in beacon frames. More...
 
int hostIf_WiFi_AccessPoint::get_hostIf_WiFi_AccessPoint_AssociatedDeviceNumberOfEntries (HOSTIF_MsgData_t *stMsgData)
 Get the number of entries in the AssociatedDevice table. The AssociatedDevice table contains information about other Wifi devices currently associated with this Wifi interface. More...
 

Function Documentation

◆ get_hostIf_WiFi_AccessPoint_Enable()

int hostIf_WiFi_AccessPoint::get_hostIf_WiFi_AccessPoint_Enable ( HOSTIF_MsgData_t stMsgData)

Enables or disables this access point.

Parameters
[in]stMsgDataTR-069 Host interface message request.

◆ get_hostIf_WiFi_AccessPoint_Status()

int hostIf_WiFi_AccessPoint::get_hostIf_WiFi_AccessPoint_Status ( HOSTIF_MsgData_t stMsgData)

Get the status of the access point which is currently being set. The status of the access point could be the following types,.

  • 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
[in]stMsgDataTR-069 Host interface message request.

◆ get_hostIf_WiFi_AccessPoint_Alias()

int hostIf_WiFi_AccessPoint::get_hostIf_WiFi_AccessPoint_Alias ( HOSTIF_MsgData_t stMsgData)

Get the access point alias based addressing. Alias provides a mechanism for an ACS to label the instance for future reference. 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
    [in]stMsgDataTR-069 Host interface message request.
    Returns
    Returns 0 on success, otherwise will return the appropriate error code.

◆ get_hostIf_WiFi_AccessPoint_SSIDReference()

int hostIf_WiFi_AccessPoint::get_hostIf_WiFi_AccessPoint_SSIDReference ( HOSTIF_MsgData_t stMsgData)

Get path name of a row in the SSID table. If the parameter value is set to Null indicate that the reference object is deleted.

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

◆ get_hostIf_WiFi_AccessPoint_SSIDAdvertisementEnabled()

int hostIf_WiFi_AccessPoint::get_hostIf_WiFi_AccessPoint_SSIDAdvertisementEnabled ( HOSTIF_MsgData_t stMsgData)

Check whether or not beacons include the SSID name.

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

◆ get_hostIf_WiFi_AccessPoint_RetryLimit()

int hostIf_WiFi_AccessPoint::get_hostIf_WiFi_AccessPoint_RetryLimit ( HOSTIF_MsgData_t stMsgData)

Get thee maximum number of retransmission for a packet. This corresponds to IEEE 802.11 parameter dot11ShortRetryLimit.

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

◆ get_hostIf_WiFi_AccessPoint_WMMCapability()

int hostIf_WiFi_AccessPoint::get_hostIf_WiFi_AccessPoint_WMMCapability ( HOSTIF_MsgData_t stMsgData)

Check whether this access point supports WiFi Multimedia (WMM) Access Categories (AC).

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

◆ get_hostIf_WiFi_AccessPoint_UAPSDCapability()

int hostIf_WiFi_AccessPoint::get_hostIf_WiFi_AccessPoint_UAPSDCapability ( HOSTIF_MsgData_t stMsgData)

Check whether this access point supports WMM Unscheduled Automatic Power Save Delivery (U-APSD).

Note
U-APSD support implies WMM support.
Parameters
[in]stMsgDataTR-069 Host interface message request.
Returns
Returns 0 on success, otherwise will return the appropriate error code.

◆ get_hostIf_WiFi_AccessPoint_WMMEnable()

int hostIf_WiFi_AccessPoint::get_hostIf_WiFi_AccessPoint_WMMEnable ( HOSTIF_MsgData_t stMsgData)

Check whether WMM support is currently enabled. When enabled, this is indicated in beacon frames.

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

◆ get_hostIf_WiFi_AccessPoint_UAPSDEnable()

int hostIf_WiFi_AccessPoint::get_hostIf_WiFi_AccessPoint_UAPSDEnable ( HOSTIF_MsgData_t stMsgData)

Whether U-APSD support is currently enabled. When enabled, this is indicated in beacon frames.

Note
U-APSD can only be enabled if WMM is also enabled.
Parameters
[in]stMsgDataTR-069 Host interface message request.
Returns
Returns 0 on success, otherwise will return the appropriate error code.

◆ get_hostIf_WiFi_AccessPoint_AssociatedDeviceNumberOfEntries()

int hostIf_WiFi_AccessPoint::get_hostIf_WiFi_AccessPoint_AssociatedDeviceNumberOfEntries ( HOSTIF_MsgData_t stMsgData)

Get the number of entries in the AssociatedDevice table. The AssociatedDevice table contains information about other Wifi devices currently associated with this Wifi interface.

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