Network Interface#

Functions#

sl_status_t

sl_net_init(sl_net_interface_t interface, const void *configuration, void *context, sl_net_event_handler_t event_handler)

Initialize a network interface.

sl_status_t

sl_net_deinit(sl_net_interface_t interface, void *context)

De-initialize a network interface.

sl_status_t

sl_net_up(sl_net_interface_t interface, sl_net_profile_id_t profile_id)

Bring a network interface up.

sl_status_t

sl_net_down(sl_net_interface_t interface)

Bring a network interface down.

sl_status_t

sl_dns_host_get_by_name(const char *host_name, const uint32_t timeout, const sl_net_dns_resolution_ip_type_t dns_resolution_ip, sl_ip_address_t *ip_address)

Resolve given host name to IP address.

Function Documentation#

sl_net_init#

sl_status_t sl_net_init (sl_net_interface_t interface, const void * configuration, void * context, sl_net_event_handler_t event_handler)

Initialize a network interface.

Parameters

[in]	interface	Interface identified by sl_net_interface_t
[in]	configuration	Configuration object specific to network interface.
[in]	context	Runtime context specific to network interface.
[in]	event_handler	Processes all events related to network interface.

This API should be called before calling any sl_net API. Returns

sl_status_t. See https://docs.silabs.com/gecko-platform/4.1/common/api/group-status for details.

Definition at line 54 of file components/service/network_manager/inc/sl_net.h

sl_net_deinit#

sl_status_t sl_net_deinit (sl_net_interface_t interface, void * context)

De-initialize a network interface.

Parameters

[in]	interface	Interface identified by sl_net_interface_t
[in]	context	Runtime context specific to network interface.

sl_net_init should be called before this API.

sl_net_init should be called before this API.

Returns

sl_status_t. See https://docs.silabs.com/gecko-platform/4.1/common/api/group-status for details.

Definition at line 73 of file components/service/network_manager/inc/sl_net.h

sl_net_up#

sl_status_t sl_net_up (sl_net_interface_t interface, sl_net_profile_id_t profile_id)

Bring a network interface up.

Parameters

[in]	interface	Interface identified by sl_net_interface_t
[in]	profile_id	SL Network profile identifier for specific interface.

sl_net_init should be called before this API.

Returns

sl_status_t. See https://docs.silabs.com/gecko-platform/4.1/common/api/group-status for details.

Definition at line 87 of file components/service/network_manager/inc/sl_net.h

sl_net_down#

sl_status_t sl_net_down (sl_net_interface_t interface)

Bring a network interface down.

Parameters

[in]

interface

Interface identified by sl_net_interface_t

sl_net_up should be called before this API.

Returns

sl_status_t. See https://docs.silabs.com/gecko-platform/4.1/common/api/group-status for details.

Definition at line 99 of file components/service/network_manager/inc/sl_net.h

sl_dns_host_get_by_name#

sl_status_t sl_dns_host_get_by_name (const char * host_name, const uint32_t timeout, const sl_net_dns_resolution_ip_type_t dns_resolution_ip, sl_ip_address_t * ip_address)

Resolve given host name to IP address.

Parameters

N/A	host_name	Host name which needs to be resolved.
N/A	timeout	If value is greater than zero, caller would be blocked till timeout milliseconds to get the response. If the values is equal's to zero, response would sent asynchronously using callbacks.
N/A	dns_resolution_ip	Whether the host name needs to be resolved to IPV4 or IPV6.
N/A	ip_address	IP address object to store resolved IP address

Returns

Definition at line 21 of file components/service/network_manager/inc/sl_net_dns.h