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 upper and lower bound for the periodic health check interval. 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.

Definition at line 2246 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.

Definition at line 2239 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 upper and lower bound for the periodic health check interval.

To guarantee a specific interval set both min_interval_ms and max_interval_ms to the same value.

Note

To disable periodic health checks entirely set both values to zero (0).

Parameters

min_interval_ms	Minimum value that the interval can be.
max_interval_ms	Maximum value that the interval can be.

Returns

MMWLAN_SUCCESS on success, else an appropriate error code.