WLAN Health check API

Detailed Description

Macros
#define	MMWLAN_DEFAULT_MIN_HEALTH_CHECK_INTERVAL_MS   60000
	The default minimum interval to wait after the last health check before triggering another. More...
#define	MMWLAN_DEFAULT_MAX_HEALTH_CHECK_INTERVAL_MS   120000
	The default maximum interval to wait after the last health check before triggering another. More...

Functions
enum mmwlan_status	mmwlan_set_health_check_interval (uint32_t min_interval_ms, uint32_t max_interval_ms)
	Specify the periodic health check intervals. More...

Macro Definition Documentation

MMWLAN_DEFAULT_MAX_HEALTH_CHECK_INTERVAL_MS

#define MMWLAN_DEFAULT_MAX_HEALTH_CHECK_INTERVAL_MS   120000

The default maximum interval to wait after the last health check before triggering another.

If this parameter is 0 then periodic health checks will be disabled. MMWLAN_DEFAULT_MIN_HEALTH_CHECK_INTERVAL_MS must always be less than or equal to MMWLAN_DEFAULT_MAX_HEALTH_CHECK_INTERVAL_MS. Set this to UINT32_MAX to have the maximum unbounded.

Definition at line 1699 of file mmwlan.h.

MMWLAN_DEFAULT_MIN_HEALTH_CHECK_INTERVAL_MS

#define MMWLAN_DEFAULT_MIN_HEALTH_CHECK_INTERVAL_MS   60000

The default minimum interval to wait after the last health check before triggering another.

If this is 0 then health checks will always happen at the MMWLAN_DEFAULT_MAX_HEALTH_CHECK_INTERVAL_MS value. MMWLAN_DEFAULT_MIN_HEALTH_CHECK_INTERVAL_MS must always be less than or equal to MMWLAN_DEFAULT_MAX_HEALTH_CHECK_INTERVAL_MS.

Definition at line 1690 of file mmwlan.h.

Function Documentation

mmwlan_set_health_check_interval()

enum mmwlan_status mmwlan_set_health_check_interval	(	uint32_t	min_interval_ms,
		uint32_t	max_interval_ms
	)

Specify the periodic health check intervals.

The system will always schedule the periodic health check for the max_interval_ms interval. It will however monitor system activity and opportunistically perform health checks after min_interval_ms time has passed and some activity was detected. If no activity was detected then the health check will be performed after max_interval_ms as originally scheduled. Every time the health check is performed, the next one will be rescheduled to occur after max_interval_ms. If both min_interval_ms and max_interval_ms are set to 0, then periodic health checks will be disabled.

Parameters

min_interval_ms	The minimum interval to wait after the last health check before triggering another. If this parameter is 0 then health checks will always happen at the max_interval_ms value. min_interval_ms must always be less than or equal to max_interval_ms.
max_interval_ms	The maximum interval to wait after the last health check before triggering another. If this parameter is 0 then periodic health checks will be disabled. min_interval_ms must always be less than or equal to max_interval_ms. Set this to UINT32_MAX to have the maximum unbounded.

Returns

MMWLAN_SUCCESS on success, else an appropriate error code.