Network Interface#
Functions#
Initialize a network interface.
De-initialize a network interface.
Bring a network interface up.
Bring a network interface down.
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.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| sl_net_interface_t | [in] | interface | Interface identified by sl_net_interface_t |
| const void * | [in] | configuration | Configuration object specific to network interface. |
| void * | [in] | context | Runtime context specific to network interface. |
| sl_net_event_handler_t | [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.
sl_net_deinit#
sl_status_t sl_net_deinit (sl_net_interface_t interface, void * context)
De-initialize a network interface.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| sl_net_interface_t | [in] | interface | Interface identified by sl_net_interface_t |
| void * | [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.
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.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| sl_net_interface_t | [in] | interface | Interface identified by sl_net_interface_t |
| sl_net_profile_id_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.
sl_net_down#
sl_status_t sl_net_down (sl_net_interface_t interface)
Bring a network interface down.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| sl_net_interface_t | [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.
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.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| const char * | N/A | host_name | Host name which needs to be resolved. |
| const uint32_t | 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. |
| const sl_net_dns_resolution_ip_type_t | N/A | dns_resolution_ip | Whether the host name needs to be resolved to IPV4 or IPV6. |
| sl_ip_address_t * | N/A | ip_address | IP address object to store resolved IP address |
Returns