Roaming

         Here are listed all the functions that implement the Wifi Roaming APIs.

Functions
sint8	m2m_wifi_disable_roaming (void)
	Disable WiFi STA roaming. More...
sint8	m2m_wifi_enable_roaming (uint8 bEnableDhcp)
	Enable WiFi STA roaming. More...

sint8 m2m_wifi_disable_roaming

(

void

)

Disable WiFi STA roaming.

Precondition

Must be called after the initialization.

Returns

The function returns M2M_SUCCESS for successful operations and a negative value otherwise.

See Also

m2m_wifi_init

sint8 m2m_wifi_enable_roaming

(

uint8

bEnableDhcp

)

Enable WiFi STA roaming.

m2m_wifi_enable_roaming enables the firmware to trigger the roaming algorithm/steps on link loss with the current AP.
If roaming is successful, 
    the @ref M2M_WIFI_RESP_CON_STATE_CHANGED message with state as @ref M2M_WIFI_ROAMED is sent to host.
    Additionally a @ref M2M_WIFI_REQ_DHCP_CONF message with new DHCP lease details is sent to host (only if bEnableDhcp=1).
If roaming is unsuccessful,
    @ref M2M_WIFI_RESP_CON_STATE_CHANGED message with state as @ref M2M_WIFI_DISCONNECTED is sent to host.

Parameters

[in]

bEnableDhcp

0 : Disables DHCP client execution after roaming to new AP 1 : Enables DHCP client execution after roaming to new AP

Precondition

Must be called after the initialization. The roaming algorithm/procedure is internal to the firmware.

Returns

The function returns M2M_SUCCESS for successful operations and a negative value otherwise.

See Also

m2m_wifi_init

m2m_wifi_enable_roaming enables the firmware to trigger the roaming algorithm/steps on link loss with the current AP.
If roaming is successful, the @ref M2M_WIFI_RESP_CON_STATE_CHANGED message with state as @ref M2M_WIFI_ROAMED is sent to the host.
Additionally a @ref M2M_WIFI_REQ_DHCP_CONF message with new DHCP lease details is sent to host (only if bEnableDhcp=1).
If roaming is unsuccessful, a @ref M2M_WIFI_RESP_CON_STATE_CHANGED message with state as @ref M2M_WIFI_DISCONNECTED is sent to host.

Parameters

[in]

bEnableDhcp

0 : Disables DHCP client execution after roaming to new AP 1 : Enables DHCP client execution after roaming to new AP

Precondition

Must be called after the initialization. The roaming algorithm/procedure is internal to the firmware.

Returns

The function returns M2M_SUCCESS for successful operations and a negative value otherwise.

See Also

m2m_wifi_init

Referenced by main().