Functions
wiced_result_t	wiced_ip_deregister_address_change_callback (wiced_ip_address_change_callback_t callback)

wiced_result_t	wiced_ip_get_gateway_address (wiced_interface_t interface, wiced_ip_address_t *ipv4_address)

wiced_result_t	wiced_ip_get_ipv4_address (wiced_interface_t interface, wiced_ip_address_t *ipv4_address)

wiced_result_t	wiced_ip_get_ipv6_address (wiced_interface_t interface, wiced_ip_address_t *ipv6_address, wiced_ipv6_address_type_t address_type)

wiced_result_t	wiced_ip_get_netmask (wiced_interface_t interface, wiced_ip_address_t *ipv4_address)

wiced_bool_t	wiced_ip_is_any_pending_packets (wiced_interface_t interface)

wiced_result_t	wiced_ip_register_address_change_callback (wiced_ip_address_change_callback_t callback, void *arg)

Detailed Description

Functions to access IP information from network interfaces

Function Documentation

◆ wiced_ip_deregister_address_change_callback()

wiced_result_t wiced_ip_deregister_address_change_callback ( wiced_ip_address_change_callback_t callback )

De-registers a callback function that gets called when the IP address has changed

Parameters

[in] callback : Callback function to de-register

Returns: wiced_result_t

◆ wiced_ip_get_gateway_address()

wiced_result_t wiced_ip_get_gateway_address	(	wiced_interface_t	interface,
		wiced_ip_address_t *	ipv4_address )

Retrieves the IPv4 gateway address for an interface

Retrieves the gateway IPv4 address for an interface (AP or STA) if it exists.

Parameters

[in]	interface	: The interface (AP or STA)
[out]	ipv4_address	: The address structure to be filled with the gateway IP

Returns: wiced_result_t

◆ wiced_ip_get_ipv4_address()

wiced_result_t wiced_ip_get_ipv4_address	(	wiced_interface_t	interface,
		wiced_ip_address_t *	ipv4_address )

Retrieves the IPv4 address for an interface

Retrieves the IPv4 address for an interface (AP or STA) if it exists.

Parameters

[in]	interface	: The interface (AP or STA)
[out]	ipv4_address	: The address structure to be filled

Returns: wiced_result_t

◆ wiced_ip_get_ipv6_address()

wiced_result_t wiced_ip_get_ipv6_address	(	wiced_interface_t	interface,
		wiced_ip_address_t *	ipv6_address,
		wiced_ipv6_address_type_t	address_type )

Retrieves the IPv6 address for an interface

Retrieves the IPv6 address for an interface (AP or STA) if it exists.

Parameters

[in]	interface	: The interface (AP or STA)
[out]	ipv6_address	: The address structure to be filled
[in]	address_type	: The address type

Returns: wiced_result_t

◆ wiced_ip_get_netmask()

wiced_result_t wiced_ip_get_netmask	(	wiced_interface_t	interface,
		wiced_ip_address_t *	ipv4_address )

Retrieves the IPv4 netmask for an interface

Retrieves the gateway IPv4 netmask for an interface (AP or STA) if it exists.

Parameters

[in]	interface	: The interface (AP or STA)
[out]	ipv4_address	: The address structure to be filled with the netmask

Returns: wiced_result_t

◆ wiced_ip_is_any_pending_packets()

wiced_bool_t wiced_ip_is_any_pending_packets ( wiced_interface_t interface )

Check whether any packets are pending inside IP stack

Parameters

[in] interface : IP instance

Returns: WICED_TRUE if any packets pending, otherwise WICED_FALSE

◆ wiced_ip_register_address_change_callback()

wiced_result_t wiced_ip_register_address_change_callback	(	wiced_ip_address_change_callback_t	callback,
		void *	arg )

Registers a callback function that gets called when the IP address has changed

Parameters

[in]	callback	: Callback function to register
[in]	arg	: Pointer to the argument to pass to the callback

Returns: wiced_result_t