Network Interface#

Functions#

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

Initialize a network interface.

sl_status_t
sl_net_deinit(sl_net_interface_t interface)

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_net_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 * network_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 of type sl_wifi_device_configuration_t. If configuration = NULL, then following configuration is used internally by SDK

sl_net_interface_t

Default configuration

SL_NET_WIFI_CLIENT_INTERFACE

sl_wifi_default_client_configuration

SL_NET_WIFI_AP_INTERFACE

sl_wifi_default_ap_configuration

[in]network_context

Runtime context specific to network interface.

[in]event_handler

Processes all network events related to network interface as identified by sl_net_event_handler_t

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

Note

  • For Wi-Fi events, sl_net uses the wifi callback framework. Register the corresponding Wi-Fi event handlers using sl_wifi_set_callback API.

  • Parameter network_context is only being used when module is acting as station in external stack mode[lwIP]. In such case, network_context is supposed to refer a valid sl_net_wifi_lwip_context_t variable.


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

sl_net_deinit#

sl_status_t sl_net_deinit (sl_net_interface_t interface)

De-initialize a network interface.

Parameters
[in]interface

Interface identified by sl_net_interface_t

  • Pre-conditions:

Returns


Definition at line 82 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

Network profile identifier for specific interface of type sl_net_profile_id_t

  • Pre-conditions:

Returns

Note

  • By default, profile and credential configurations in sl_net_defaults.h are used by SDK. User can define their profile and credential configurations for an interface, by calling sl_net_set_profile and sl_net_set_credentials APIs before calling sl_net_up API".


Definition at line 100 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

  • Pre-conditions:

Returns


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

sl_net_host_get_by_name#

sl_status_t sl_net_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
[in]host_name

Host name which needs to be resolved.

[in]timeout

timeout in millisecs.

[in]dns_resolution_ip

DNS resolution by IP of type sl_net_dns_resolution_ip_type_t

[out]ip_address

IP address object to store resolved IP address of type sl_ip_address_t

Returns

Note

  • If timeout 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 through sl_net_event_handler_t.


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