Sync usage with man page.
[netbsd-mini2440.git] / sys / netinet / igmp_var.h
blob809fa3ed7edb44e162fc53504786f7d9639074a4
1 /* $NetBSD: igmp_var.h,v 1.22 2005/12/10 23:36:23 elad Exp $ */
3 /*
4 * Copyright (c) 1992, 1993
5 * The Regents of the University of California. All rights reserved.
7 * This code is derived from software contributed to Berkeley by
8 * Stephen Deering of Stanford University.
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
12 * are met:
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution.
18 * 3. Neither the name of the University nor the names of its contributors
19 * may be used to endorse or promote products derived from this software
20 * without specific prior written permission.
22 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 * SUCH DAMAGE.
34 * @(#)igmp_var.h 8.1 (Berkeley) 7/19/93
38 * Copyright (c) 1988 Stephen Deering.
40 * This code is derived from software contributed to Berkeley by
41 * Stephen Deering of Stanford University.
43 * Redistribution and use in source and binary forms, with or without
44 * modification, are permitted provided that the following conditions
45 * are met:
46 * 1. Redistributions of source code must retain the above copyright
47 * notice, this list of conditions and the following disclaimer.
48 * 2. Redistributions in binary form must reproduce the above copyright
49 * notice, this list of conditions and the following disclaimer in the
50 * documentation and/or other materials provided with the distribution.
51 * 3. All advertising materials mentioning features or use of this software
52 * must display the following acknowledgement:
53 * This product includes software developed by the University of
54 * California, Berkeley and its contributors.
55 * 4. Neither the name of the University nor the names of its contributors
56 * may be used to endorse or promote products derived from this software
57 * without specific prior written permission.
59 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
60 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
61 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
62 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
63 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
64 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
65 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
66 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
67 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
68 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
69 * SUCH DAMAGE.
71 * @(#)igmp_var.h 8.1 (Berkeley) 7/19/93
74 #ifndef _NETINET_IGMP_VAR_H_
75 #define _NETINET_IGMP_VAR_H_
78 * Internet Group Management Protocol (IGMP),
79 * implementation-specific definitions.
81 * Written by Steve Deering, Stanford, May 1988.
82 * Modified by Rosen Sharma, Stanford, Aug 1994.
83 * Modified by Bill Fenner, Xerox PARC, Feb 1995.
85 * MULTICAST 1.3
88 #define IGMP_STAT_RCV_TOTAL 1 /* total IGMP messages received */
89 #define IGMP_STAT_RCV_TOOSHORT 2 /* received with too few bytes */
90 #define IGMP_STAT_RCV_BADSUM 3 /* received with bad checksum */
91 #define IGMP_STAT_RCV_QUERIES 4 /* received membership queries */
92 #define IGMP_STAT_RCV_BADQUERIES 5 /* received invalid queries */
93 #define IGMP_STAT_RCV_REPORTS 6 /* received membership reports */
94 #define IGMP_STAT_RCV_BADREPORTS 7 /* received invalid reports */
95 #define IGMP_STAT_RCV_OURREPORTS 8 /* received reports for our groups */
96 #define IGMP_STAT_SND_REPORTS 9 /* sent membership reports */
98 #define IGMP_NSTATS 10
100 #ifdef _KERNEL
102 * Macro to compute a random timer value between 1 and (IGMP_MAX_REPORTING_
103 * DELAY * countdown frequency). We assume that the routine random()
104 * is defined somewhere (and that it returns a positive number).
106 #define IGMP_RANDOM_DELAY(X) (random() % (X) + 1)
108 #ifdef __NO_STRICT_ALIGNMENT
109 #define IGMP_HDR_ALIGNED_P(ig) 1
110 #else
111 #define IGMP_HDR_ALIGNED_P(ig) ((((vaddr_t) (ig)) & 3) == 0)
112 #endif
114 void igmp_init(void);
115 void igmp_input(struct mbuf *, ...);
116 int igmp_joingroup(struct in_multi *);
117 void igmp_leavegroup(struct in_multi *);
118 void igmp_fasttimo(void);
119 void igmp_slowtimo(void);
120 void igmp_purgeif(struct ifnet *);
121 #endif /* _KERNEL */
123 #endif /* !_NETINET_IGMP_VAR_H_ */