Donatien Garnier
This library is deprecated.
Dependents: HTTPClientStreamingExample HTTPClientExample HTTPServerExample HTTPServerHelloWorld ... more
LPC2368/lwip/include/ipv4/lwip/igmp.h@0:422060928e37, 2010-06-11 (annotated)
- Committer:
- donatien
- Date:
- Fri Jun 11 16:25:22 2010 +0000
- Revision:
- 0:422060928e37
Who changed what in which revision?
| User | Revision | Line number | New contents of line |
|---|---|---|---|
| donatien | 0:422060928e37 | 1 | /* |
| donatien | 0:422060928e37 | 2 | * Copyright (c) 2002 CITEL Technologies Ltd. |
| donatien | 0:422060928e37 | 3 | * All rights reserved. |
| donatien | 0:422060928e37 | 4 | * |
| donatien | 0:422060928e37 | 5 | * Redistribution and use in source and binary forms, with or without |
| donatien | 0:422060928e37 | 6 | * modification, are permitted provided that the following conditions |
| donatien | 0:422060928e37 | 7 | * are met: |
| donatien | 0:422060928e37 | 8 | * 1. Redistributions of source code must retain the above copyright |
| donatien | 0:422060928e37 | 9 | * notice, this list of conditions and the following disclaimer. |
| donatien | 0:422060928e37 | 10 | * 2. Redistributions in binary form must reproduce the above copyright |
| donatien | 0:422060928e37 | 11 | * notice, this list of conditions and the following disclaimer in the |
| donatien | 0:422060928e37 | 12 | * documentation and/or other materials provided with the distribution. |
| donatien | 0:422060928e37 | 13 | * 3. Neither the name of CITEL Technologies Ltd nor the names of its contributors |
| donatien | 0:422060928e37 | 14 | * may be used to endorse or promote products derived from this software |
| donatien | 0:422060928e37 | 15 | * without specific prior written permission. |
| donatien | 0:422060928e37 | 16 | * |
| donatien | 0:422060928e37 | 17 | * THIS SOFTWARE IS PROVIDED BY CITEL TECHNOLOGIES AND CONTRIBUTORS ``AS IS'' |
| donatien | 0:422060928e37 | 18 | * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
| donatien | 0:422060928e37 | 19 | * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE |
| donatien | 0:422060928e37 | 20 | * ARE DISCLAIMED. IN NO EVENT SHALL CITEL TECHNOLOGIES OR CONTRIBUTORS BE LIABLE |
| donatien | 0:422060928e37 | 21 | * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL |
| donatien | 0:422060928e37 | 22 | * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS |
| donatien | 0:422060928e37 | 23 | * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) |
| donatien | 0:422060928e37 | 24 | * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT |
| donatien | 0:422060928e37 | 25 | * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY |
| donatien | 0:422060928e37 | 26 | * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF |
| donatien | 0:422060928e37 | 27 | * SUCH DAMAGE. |
| donatien | 0:422060928e37 | 28 | * |
| donatien | 0:422060928e37 | 29 | * This file is a contribution to the lwIP TCP/IP stack. |
| donatien | 0:422060928e37 | 30 | * The Swedish Institute of Computer Science and Adam Dunkels |
| donatien | 0:422060928e37 | 31 | * are specifically granted permission to redistribute this |
| donatien | 0:422060928e37 | 32 | * source code. |
| donatien | 0:422060928e37 | 33 | */ |
| donatien | 0:422060928e37 | 34 | |
| donatien | 0:422060928e37 | 35 | #ifndef __LWIP_IGMP_H__ |
| donatien | 0:422060928e37 | 36 | #define __LWIP_IGMP_H__ |
| donatien | 0:422060928e37 | 37 | |
| donatien | 0:422060928e37 | 38 | #include "lwip/opt.h" |
| donatien | 0:422060928e37 | 39 | #include "lwip/ip_addr.h" |
| donatien | 0:422060928e37 | 40 | #include "lwip/netif.h" |
| donatien | 0:422060928e37 | 41 | #include "lwip/pbuf.h" |
| donatien | 0:422060928e37 | 42 | |
| donatien | 0:422060928e37 | 43 | #if LWIP_IGMP /* don't build if not configured for use in lwipopts.h */ |
| donatien | 0:422060928e37 | 44 | |
| donatien | 0:422060928e37 | 45 | #ifdef __cplusplus |
| donatien | 0:422060928e37 | 46 | extern "C" { |
| donatien | 0:422060928e37 | 47 | #endif |
| donatien | 0:422060928e37 | 48 | |
| donatien | 0:422060928e37 | 49 | |
| donatien | 0:422060928e37 | 50 | /* IGMP timer */ |
| donatien | 0:422060928e37 | 51 | #define IGMP_TMR_INTERVAL 100 /* Milliseconds */ |
| donatien | 0:422060928e37 | 52 | #define IGMP_V1_DELAYING_MEMBER_TMR (1000/IGMP_TMR_INTERVAL) |
| donatien | 0:422060928e37 | 53 | #define IGMP_JOIN_DELAYING_MEMBER_TMR (500 /IGMP_TMR_INTERVAL) |
| donatien | 0:422060928e37 | 54 | |
| donatien | 0:422060928e37 | 55 | /* MAC Filter Actions, these are passed to a netif's |
| donatien | 0:422060928e37 | 56 | * igmp_mac_filter callback function. */ |
| donatien | 0:422060928e37 | 57 | #define IGMP_DEL_MAC_FILTER 0 |
| donatien | 0:422060928e37 | 58 | #define IGMP_ADD_MAC_FILTER 1 |
| donatien | 0:422060928e37 | 59 | |
| donatien | 0:422060928e37 | 60 | |
| donatien | 0:422060928e37 | 61 | /** |
| donatien | 0:422060928e37 | 62 | * igmp group structure - there is |
| donatien | 0:422060928e37 | 63 | * a list of groups for each interface |
| donatien | 0:422060928e37 | 64 | * these should really be linked from the interface, but |
| donatien | 0:422060928e37 | 65 | * if we keep them separate we will not affect the lwip original code |
| donatien | 0:422060928e37 | 66 | * too much |
| donatien | 0:422060928e37 | 67 | * |
| donatien | 0:422060928e37 | 68 | * There will be a group for the all systems group address but this |
| donatien | 0:422060928e37 | 69 | * will not run the state machine as it is used to kick off reports |
| donatien | 0:422060928e37 | 70 | * from all the other groups |
| donatien | 0:422060928e37 | 71 | */ |
| donatien | 0:422060928e37 | 72 | struct igmp_group { |
| donatien | 0:422060928e37 | 73 | /** next link */ |
| donatien | 0:422060928e37 | 74 | struct igmp_group *next; |
| donatien | 0:422060928e37 | 75 | /** interface on which the group is active */ |
| donatien | 0:422060928e37 | 76 | struct netif *netif; |
| donatien | 0:422060928e37 | 77 | /** multicast address */ |
| donatien | 0:422060928e37 | 78 | ip_addr_t group_address; |
| donatien | 0:422060928e37 | 79 | /** signifies we were the last person to report */ |
| donatien | 0:422060928e37 | 80 | u8_t last_reporter_flag; |
| donatien | 0:422060928e37 | 81 | /** current state of the group */ |
| donatien | 0:422060928e37 | 82 | u8_t group_state; |
| donatien | 0:422060928e37 | 83 | /** timer for reporting, negative is OFF */ |
| donatien | 0:422060928e37 | 84 | u16_t timer; |
| donatien | 0:422060928e37 | 85 | /** counter of simultaneous uses */ |
| donatien | 0:422060928e37 | 86 | u8_t use; |
| donatien | 0:422060928e37 | 87 | }; |
| donatien | 0:422060928e37 | 88 | |
| donatien | 0:422060928e37 | 89 | /* Prototypes */ |
| donatien | 0:422060928e37 | 90 | void igmp_init(void); |
| donatien | 0:422060928e37 | 91 | err_t igmp_start(struct netif *netif); |
| donatien | 0:422060928e37 | 92 | err_t igmp_stop(struct netif *netif); |
| donatien | 0:422060928e37 | 93 | void igmp_report_groups(struct netif *netif); |
| donatien | 0:422060928e37 | 94 | struct igmp_group *igmp_lookfor_group(struct netif *ifp, ip_addr_t *addr); |
| donatien | 0:422060928e37 | 95 | void igmp_input(struct pbuf *p, struct netif *inp, ip_addr_t *dest); |
| donatien | 0:422060928e37 | 96 | err_t igmp_joingroup(ip_addr_t *ifaddr, ip_addr_t *groupaddr); |
| donatien | 0:422060928e37 | 97 | err_t igmp_leavegroup(ip_addr_t *ifaddr, ip_addr_t *groupaddr); |
| donatien | 0:422060928e37 | 98 | void igmp_tmr(void); |
| donatien | 0:422060928e37 | 99 | |
| donatien | 0:422060928e37 | 100 | #ifdef __cplusplus |
| donatien | 0:422060928e37 | 101 | } |
| donatien | 0:422060928e37 | 102 | #endif |
| donatien | 0:422060928e37 | 103 | |
| donatien | 0:422060928e37 | 104 | #endif /* LWIP_IGMP */ |
| donatien | 0:422060928e37 | 105 | |
| donatien | 0:422060928e37 | 106 | #endif /* __LWIP_IGMP_H__ */ |