Scan List - List of wireless access points

Internal list data structure of scanned access points NETOPT_SCAN. More...

Detailed Description

Internal list data structure of scanned access points NETOPT_SCAN.

Files
file	l2scan_list.h
	L2 Scan list API.

Data Structures
struct	l2scan_list
	Type of a Link Layer scan list. More...

Typedefs
typedef struct l2scan_list	l2scan_list_t
	Type of a Link Layer scan list.

Functions
void	l2scan_list_empty (l2scan_list_t *list, list_node_t *nodes, unsigned nodes_numof, size_t node_size)
	Empty the list to start a new scan.
void	l2scan_list_insert (l2scan_list_t *list, list_node_t *nodes, unsigned nodes_numof, size_t node_size, const netopt_scan_result_t *result)
	Insert a new scan result into the list.
unsigned	l2scan_list_to_array (const l2scan_list_t *list, void *nodes_array, unsigned nodes_numof, size_t node_size)
	Copy the content of a L2 scan list to an array to get rid of the list overhead.

Function Documentation

l2scan_list_empty()

void l2scan_list_empty	(	l2scan_list_t *	list,
		list_node_t *	nodes,
		unsigned	nodes_numof,
		size_t	node_size
	)

Empty the list to start a new scan.

Parameters

[in,out]	list	Pointer to list
[in,out]	nodes	Pointer to nodes array
[in]	nodes_numof	Number of nodes in the array
[in]	node_size	Size of one node element in the array

l2scan_list_insert()

void l2scan_list_insert	(	l2scan_list_t *	list,
		list_node_t *	nodes,
		unsigned	nodes_numof,
		size_t	node_size,
		const netopt_scan_result_t *	result
	)

Insert a new scan result into the list.

Parameters

[in,out]	list	Pointer to list
[in,out]	nodes	Pointer to nodes array
[in]	nodes_numof	Number of nodes in the array
[in]	node_size	Size of one node element in the array
[in]	result	New result to insert

l2scan_list_to_array()

unsigned l2scan_list_to_array	(	const l2scan_list_t *	list,
		void *	nodes_array,
		unsigned	nodes_numof,
		size_t	node_size
	)

Copy the content of a L2 scan list to an array to get rid of the list overhead.

Parameters

[in]	list	Pointer to list
[out]	nodes_array	Buffer of nodes to store the result
[in]	nodes_numof	Maximum number of nodes that can be copied
[in]	node_size	Size of one node element in the array

Returns

Number of copied nodes