Rizky Ardi Maulana / mbed-os
Embed: (wiki syntax)

« Back to documentation index

netif Struct Reference

netif Struct Reference

Generic data structure used for all lwIP network interfaces. More...

#include <netif.h>

Data Fields

struct netifnext
 pointer to next in linked list
ip_addr_t ip_addr
 IP address configuration in network byte order.
ip_addr_t ip6_addr [LWIP_IPV6_NUM_ADDRESSES]
 Array of IPv6 addresses for this netif.
u8_t ip6_addr_state [LWIP_IPV6_NUM_ADDRESSES]
 The state of each IPv6 address (Tentative, Preferred, etc).
netif_input_fn input
 This function is called by the network device driver to pass a packet up the TCP/IP stack.
netif_output_fn output
 This function is called by the IP module when it wants to send a packet on the interface.
netif_linkoutput_fn linkoutput
 This function is called by the ARP module when it wants to send a packet on the interface.
netif_output_ip6_fn output_ip6
 This function is called by the IPv6 module when it wants to send a packet on the interface.
netif_status_callback_fn status_callback
 This function is called when the netif state is set to up or down.
netif_status_callback_fn link_callback
 This function is called when the netif link is set to up or down.
netif_status_callback_fn remove_callback
 This function is called when the netif has been removed.
void * state
 This field can be set by the device driver and could point to state information for the device.
struct dhcpdhcp
 the DHCP client state information for this netif
struct autoipautoip
 the AutoIP client state information for this netif
u8_t ip6_autoconfig_enabled
 is this netif enabled for IPv6 autoconfiguration
u8_t rs_count
 Number of Router Solicitation messages that remain to be sent.
struct dhcp6dhcp6
 the DHCPv6 client state information for this netif
u16_t mtu
 maximum transfer unit (in bytes)
u8_t hwaddr_len
 number of bytes used in hwaddr
u8_t hwaddr [NETIF_MAX_HWADDR_LEN]
 link level hardware address of this interface
u8_t flags
 flags (
char name [2]
 descriptive abbreviation
u8_t num
 number of this interface
u8_t link_type
 link type (from "snmp_ifType" enum from snmp_mib2.h)
u32_t link_speed
 (estimate) link speed
u32_t ts
 timestamp at last change made (up/down)
struct stats_mib2_netif_ctrs mib2_counters
 counters
netif_igmp_mac_filter_fn igmp_mac_filter
 This function could be called to add or delete an entry in the multicast filter table of the ethernet MAC.
netif_mld_mac_filter_fn mld_mac_filter
 This function could be called to add or delete an entry in the IPv6 multicast filter table of the ethernet MAC.
u32_t ifinoctets
 counters

Detailed Description

Generic data structure used for all lwIP network interfaces.

The following fields should be filled in by the initialization function for the device driver: hwaddr_len, hwaddr[], mtu, flags

Definition at line 197 of file FEATURE_LWIP/lwip-interface/lwip/src/include/lwip/netif.h.


Field Documentation

struct autoip * autoip

the AutoIP client state information for this netif

Definition at line 256 of file FEATURE_LWIP/lwip-interface/lwip/src/include/lwip/netif.h.

struct dhcp * dhcp

the DHCP client state information for this netif

Definition at line 252 of file FEATURE_LWIP/lwip-interface/lwip/src/include/lwip/netif.h.

struct dhcp6* dhcp6

the DHCPv6 client state information for this netif

Definition at line 268 of file FEATURE_LWIP/lwip-interface/lwip/src/include/lwip/netif.h.

u8_t flags

flags (

flags (see NETIF_FLAG_ above)

See also:
Flags)

Definition at line 284 of file FEATURE_LWIP/lwip-interface/lwip/src/include/lwip/netif.h.

u8_t hwaddr

link level hardware address of this interface

Definition at line 282 of file FEATURE_LWIP/lwip-interface/lwip/src/include/lwip/netif.h.

u8_t hwaddr_len

number of bytes used in hwaddr

Definition at line 280 of file FEATURE_LWIP/lwip-interface/lwip/src/include/lwip/netif.h.

u32_t ifinoctets

counters

Definition at line 201 of file unsupported/net/lwip/lwip/include/lwip/netif.h.

This function could be called to add or delete an entry in the multicast filter table of the ethernet MAC.

This function could be called to add or delete a entry in the multicast filter table of the ethernet MAC.

Definition at line 302 of file FEATURE_LWIP/lwip-interface/lwip/src/include/lwip/netif.h.

This function is called by the network device driver to pass a packet up the TCP/IP stack.

Definition at line 216 of file FEATURE_LWIP/lwip-interface/lwip/src/include/lwip/netif.h.

ip_addr_t ip6_addr[LWIP_IPV6_NUM_ADDRESSES]

Array of IPv6 addresses for this netif.

Definition at line 209 of file FEATURE_LWIP/lwip-interface/lwip/src/include/lwip/netif.h.

u8_t ip6_addr_state[LWIP_IPV6_NUM_ADDRESSES]

The state of each IPv6 address (Tentative, Preferred, etc).

See also:
ip6_addr.h

Definition at line 212 of file FEATURE_LWIP/lwip-interface/lwip/src/include/lwip/netif.h.

is this netif enabled for IPv6 autoconfiguration

Definition at line 260 of file FEATURE_LWIP/lwip-interface/lwip/src/include/lwip/netif.h.

IP address configuration in network byte order.

Definition at line 203 of file FEATURE_LWIP/lwip-interface/lwip/src/include/lwip/netif.h.

This function is called when the netif link is set to up or down.

Definition at line 241 of file FEATURE_LWIP/lwip-interface/lwip/src/include/lwip/netif.h.

u32_t link_speed

(estimate) link speed

Definition at line 293 of file FEATURE_LWIP/lwip-interface/lwip/src/include/lwip/netif.h.

u8_t link_type

link type (from "snmp_ifType" enum from snmp_mib2.h)

link type (from "snmp_ifType" enum from snmp.h)

Definition at line 291 of file FEATURE_LWIP/lwip-interface/lwip/src/include/lwip/netif.h.

This function is called by the ARP module when it wants to send a packet on the interface.

This function outputs the pbuf as-is on the link medium.

Definition at line 226 of file FEATURE_LWIP/lwip-interface/lwip/src/include/lwip/netif.h.

This function could be called to add or delete an entry in the IPv6 multicast filter table of the ethernet MAC.

Definition at line 307 of file FEATURE_LWIP/lwip-interface/lwip/src/include/lwip/netif.h.

u16_t mtu

maximum transfer unit (in bytes)

Definition at line 278 of file FEATURE_LWIP/lwip-interface/lwip/src/include/lwip/netif.h.

char name

descriptive abbreviation

Definition at line 286 of file FEATURE_LWIP/lwip-interface/lwip/src/include/lwip/netif.h.

struct netif * next

pointer to next in linked list

Definition at line 199 of file FEATURE_LWIP/lwip-interface/lwip/src/include/lwip/netif.h.

u8_t num

number of this interface

Definition at line 288 of file FEATURE_LWIP/lwip-interface/lwip/src/include/lwip/netif.h.

This function is called by the IP module when it wants to send a packet on the interface.

This function typically first resolves the hardware address, then sends the packet.

Definition at line 221 of file FEATURE_LWIP/lwip-interface/lwip/src/include/lwip/netif.h.

This function is called by the IPv6 module when it wants to send a packet on the interface.

This function typically first resolves the hardware address, then sends the packet.

Definition at line 231 of file FEATURE_LWIP/lwip-interface/lwip/src/include/lwip/netif.h.

This function is called when the netif has been removed.

Definition at line 245 of file FEATURE_LWIP/lwip-interface/lwip/src/include/lwip/netif.h.

u8_t rs_count

Number of Router Solicitation messages that remain to be sent.

Definition at line 264 of file FEATURE_LWIP/lwip-interface/lwip/src/include/lwip/netif.h.

void * state

This field can be set by the device driver and could point to state information for the device.

Definition at line 249 of file FEATURE_LWIP/lwip-interface/lwip/src/include/lwip/netif.h.

This function is called when the netif state is set to up or down.

Definition at line 236 of file FEATURE_LWIP/lwip-interface/lwip/src/include/lwip/netif.h.

u32_t ts

timestamp at last change made (up/down)

Definition at line 295 of file FEATURE_LWIP/lwip-interface/lwip/src/include/lwip/netif.h.