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.
lwIP network interface abstraction More...
Go to the source code of this file.
Functions | |
| static err_t | netif_loopif_init (struct netif *netif) |
| Initialize a lwip network interface structure for a loopback interface. | |
| struct netif * | netif_add (struct netif *netif, ip_addr_t *ipaddr, ip_addr_t *netmask, ip_addr_t *gw, void *state, netif_init_fn init, netif_input_fn input) |
| Add a network interface to the list of lwIP netifs. | |
| void | netif_set_addr (struct netif *netif, ip_addr_t *ipaddr, ip_addr_t *netmask, ip_addr_t *gw) |
| Change IP address configuration for a network interface (including netmask and default gateway). | |
| void | netif_remove (struct netif *netif) |
| Remove a network interface from the list of lwIP netifs. | |
| struct netif * | netif_find (char *name) |
| Find a network interface by searching for its name. | |
| void | netif_set_ipaddr (struct netif *netif, ip_addr_t *ipaddr) |
| Change the IP address of a network interface. | |
| void | netif_set_gw (struct netif *netif, ip_addr_t *gw) |
| Change the default gateway for a network interface. | |
| void | netif_set_netmask (struct netif *netif, ip_addr_t *netmask) |
| Change the netmask of a network interface. | |
| void | netif_set_default (struct netif *netif) |
| Set a network interface as the default network interface (used to output all packets for which no specific route is found) | |
| void | netif_set_up (struct netif *netif) |
| Bring an interface up, available for processing traffic. | |
| void | netif_set_down (struct netif *netif) |
| Bring an interface down, disabling any traffic processing. | |
| void | netif_set_status_callback (struct netif *netif, netif_status_callback_fn status_callback) |
| Set callback to be called when interface is brought up/down. | |
| void | netif_set_link_up (struct netif *netif) |
| Called by a driver when its link goes up. | |
| void | netif_set_link_down (struct netif *netif) |
| Called by a driver when its link goes down. | |
| void | netif_set_link_callback (struct netif *netif, netif_status_callback_fn link_callback) |
| Set callback to be called when link is brought up/down. | |
| err_t | netif_loop_output (struct netif *netif, struct pbuf *p, ip_addr_t *ipaddr) |
| Send an IP packet to be received on the same netif (loopif-like). | |
| void | netif_poll (struct netif *netif) |
| Call netif_poll() in the main loop of your application. | |
| void | netif_poll_all (void) |
| Calls netif_poll() for every netif on the netif_list. | |
Variables | |
| struct netif * | netif_list |
| The list of network interfaces. | |
| struct netif * | netif_default |
| The default network interface. | |
Detailed Description
lwIP network interface abstraction
Definition in file netif.c.
Function Documentation
| struct netif* netif_add | ( | struct netif * | netif, |
| ip_addr_t * | ipaddr, | ||
| ip_addr_t * | netmask, | ||
| ip_addr_t * | gw, | ||
| void * | state, | ||
| netif_init_fn | init, | ||
| netif_input_fn | input | ||
| ) | [read] |
Add a network interface to the list of lwIP netifs.
- Parameters:
-
netif a pre-allocated netif structure ipaddr IP address for the new netif netmask network mask for the new netif gw default gateway IP address for the new netif state opaque data passed to the new netif init callback function that initializes the interface input callback function that is called to pass ingress packets up in the protocol layer stack.
- Returns:
- netif, or NULL if failed.
| struct netif* netif_find | ( | char * | name ) | [read] |
Send an IP packet to be received on the same netif (loopif-like).
The pbuf is simply copied and handed back to netif->input. In multithreaded mode, this is done directly since netif->input must put the packet on a queue. In callback mode, the packet is put on an internal queue and is fed to netif->input by netif_poll().
- Parameters:
-
netif the lwip network interface structure p the (IP) packet to 'send' ipaddr the ip address to send the packet to (not used)
- Returns:
- ERR_OK if the packet has been sent ERR_MEM if the pbuf used to copy the packet couldn't be allocated
| void netif_poll | ( | struct netif * | netif ) |
Call netif_poll() in the main loop of your application.
This is to prevent reentering non-reentrant functions like tcp_input(). Packets passed to netif_loop_output() are put on a list that is passed to netif->input() by netif_poll().
| void netif_poll_all | ( | void | ) |
Calls netif_poll() for every netif on the netif_list.
Change the default gateway for a network interface.
- Parameters:
-
netif the network interface to change gw the new default gateway
- Note:
- call netif_set_addr() if you also want to change ip address and netmask
Change the IP address of a network interface.
- Parameters:
-
netif the network interface to change ipaddr the new IP address
- Note:
- call netif_set_addr() if you also want to change netmask and default gateway
Change the netmask of a network interface.
- Parameters:
-
netif the network interface to change netmask the new netmask
- Note:
- call netif_set_addr() if you also want to change ip address and default gateway
Variable Documentation
| struct netif* netif_default |
| struct netif* netif_list |
Generated on Tue Jul 12 2022 17:35:03 by
1.7.2