Marco Zecchini / Mbed OS Example_RTOS

Rtos API example

Embed: (wiki syntax)

« Back to documentation index

igmp.h File Reference
Data Structures | Functions

igmp.h File Reference

IGMP API. More...

Go to the source code of this file.

Data Structures

struct  igmp_group
 igmp group structure - there is a list of groups for each interface these should really be linked from the interface, but if we keep them separate we will not affect the lwip original code too much More...

Functions

void igmp_init (void)
 Initialize the IGMP module.
err_t igmp_start (struct netif *netif)
 Start IGMP processing on interface.
err_t igmp_stop (struct netif *netif)
 Stop IGMP processing on interface.
void igmp_report_groups (struct netif *netif)
 Report IGMP memberships for this interface.
struct igmp_group * igmp_lookfor_group (struct netif *ifp, const ip4_addr_t *addr)
 Search for a group in the global igmp_group_list.
void igmp_input (struct pbuf *p, struct netif *inp, const ip4_addr_t *dest)
 Called from ip_input() if a new IGMP packet is received.
err_t igmp_joingroup (const ip4_addr_t *ifaddr, const ip4_addr_t *groupaddr)
 Join a group on one network interface.
err_t igmp_joingroup_netif (struct netif *netif, const ip4_addr_t *groupaddr)
 Join a group on one network interface.
err_t igmp_leavegroup (const ip4_addr_t *ifaddr, const ip4_addr_t *groupaddr)
 Leave a group on one network interface.
err_t igmp_leavegroup_netif (struct netif *netif, const ip4_addr_t *groupaddr)
 Leave a group on one network interface.
void igmp_tmr (void)
 The igmp timer function (both for NO_SYS=1 and =0) Should be called every IGMP_TMR_INTERVAL milliseconds (100 ms is default).

Detailed Description

IGMP API.

Definition in file igmp.h.

Function Documentation

void igmp_init ( void   )

Initialize the IGMP module.

Definition at line 114 of file lwip_igmp.c.

void igmp_input ( struct pbuf *  p,
struct netif *  inp,
const ip4_addr_t *  dest 
)

Called from ip_input() if a new IGMP packet is received.

Parameters:
preceived igmp packet, p->payload pointing to the igmp header
inpnetwork interface on which the packet was received
destdestination ip address of the igmp packet

Definition at line 323 of file lwip_igmp.c.

struct igmp_group* igmp_lookfor_group ( struct netif *  ifp,
const ip4_addr_t *  addr 
) [read]

Search for a group in the global igmp_group_list.

Parameters:
ifpthe network interface for which to look
addrthe group ip address to search for
Returns:
a struct igmp_group* if the group has been found, NULL if the group wasn't found.

Definition at line 218 of file lwip_igmp.c.

void igmp_report_groups ( struct netif *  netif )

Report IGMP memberships for this interface.

Parameters:
netifnetwork interface on which report IGMP memberships

Definition at line 192 of file lwip_igmp.c.

err_t igmp_start ( struct netif *  netif )

Start IGMP processing on interface.

Parameters:
netifnetwork interface on which start IGMP processing

Definition at line 128 of file lwip_igmp.c.

err_t igmp_stop ( struct netif *  netif )

Stop IGMP processing on interface.

Parameters:
netifnetwork interface on which stop IGMP processing

Definition at line 160 of file lwip_igmp.c.

void igmp_tmr ( void   )

The igmp timer function (both for NO_SYS=1 and =0) Should be called every IGMP_TMR_INTERVAL milliseconds (100 ms is default).

Definition at line 639 of file lwip_igmp.c.

Generated on Sun Jul 17 2022 08:25:34 by  doxygen 1.7.2