Important changes to repositories hosted on mbed.com
Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.
To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.
It is also possible to export all your personal repositories from the account settings page.
Dependents: TYBLE16_simple_data_logger TYBLE16_MP3_Air
netifapi.h File Reference
netif API (to be used from non-TCPIP threads) More...
Go to the source code of this file.
Functions | |
| err_t | netifapi_arp_add (const ip4_addr_t *ipaddr, struct eth_addr *ethaddr, enum netifapi_arp_entry type) |
| Add or update an entry in the ARP cache. | |
| err_t | netifapi_arp_remove (const ip4_addr_t *ipaddr, enum netifapi_arp_entry type) |
| Remove an entry in the ARP cache identified by ipaddr. | |
| err_t | netifapi_netif_add (struct netif *netif,#if LWIP_IPV4 const ip4_addr_t *ipaddr, const ip4_addr_t *netmask, const ip4_addr_t *gw,#endifvoid *state, netif_init_fn init, netif_input_fn input) |
| Call netif_add() in a thread-safe way by running that function inside the tcpip_thread context. | |
| err_t | netifapi_netif_set_addr (struct netif *netif, const ip4_addr_t *ipaddr, const ip4_addr_t *netmask, const ip4_addr_t *gw) |
| Call netif_set_addr() in a thread-safe way by running that function inside the tcpip_thread context. | |
| err_t | netifapi_netif_common (struct netif *netif, netifapi_void_fn voidfunc, netifapi_errt_fn errtfunc) |
| call the "errtfunc" (or the "voidfunc" if "errtfunc" is NULL) in a thread-safe way by running that function inside the tcpip_thread context. | |
| err_t | netifapi_netif_name_to_index (const char *name, u8_t *idx) |
| Call netif_name_to_index() in a thread-safe way by running that function inside the tcpip_thread context. | |
| err_t | netifapi_netif_index_to_name (u8_t idx, char *name) |
| Call netif_index_to_name() in a thread-safe way by running that function inside the tcpip_thread context. | |
Detailed Description
netif API (to be used from non-TCPIP threads)
Definition in file netifapi.h.
Function Documentation
| err_t netifapi_arp_add | ( | const ip4_addr_t * | ipaddr, |
| struct eth_addr * | ethaddr, | ||
| enum netifapi_arp_entry | type | ||
| ) |
Add or update an entry in the ARP cache.
For an update, ipaddr is used to find the cache entry.
- Parameters:
-
ipaddr IPv4 address of cache entry ethaddr hardware address mapped to ipaddr type type of ARP cache entry
- Returns:
- ERR_OK: entry added/updated, else error from err_t
Definition at line 163 of file lwip_netifapi.c.
| err_t netifapi_arp_remove | ( | const ip4_addr_t * | ipaddr, |
| enum netifapi_arp_entry | type | ||
| ) |
Remove an entry in the ARP cache identified by ipaddr.
- Parameters:
-
ipaddr IPv4 address of cache entry type type of ARP cache entry
- Returns:
- ERR_OK: entry removed, else error from err_t
Definition at line 193 of file lwip_netifapi.c.
| err_t netifapi_netif_common | ( | struct netif * | netif, |
| netifapi_void_fn | voidfunc, | ||
| netifapi_errt_fn | errtfunc | ||
| ) |
call the "errtfunc" (or the "voidfunc" if "errtfunc" is NULL) in a thread-safe way by running that function inside the tcpip_thread context.
- Note:
- use only for functions where there is only "netif" parameter.
Definition at line 303 of file lwip_netifapi.c.
Generated on Tue Jul 12 2022 13:55:16 by
1.7.2