2 *------------------------------------------------------------------
3 * Copyright (c) 2017 Cisco and/or its affiliates.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at:
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 *------------------------------------------------------------------
18 option version = "1.0.0";
21 Used by a 'host' to enable the recption/listening of packets for a specific
23 @param client_index - opaque cookie to identify the sender
24 @param context - sender context, to match reply w/ request
25 @param enable - if set, enable igmp messages on configuration
26 @param sw_if_index - interface sw index
27 @param saddr - source address
28 @param gaddr - group address
30 autoreply define igmp_listen
42 Used by a 'router' to enable the recption of IGMP packets and the
43 construction of group state for hosts on the link
45 @param client_index - opaque cookie to identify the sender
46 @param context - sender context, to match reply w/ request
47 @param enable - if set, enable igmp messages on configuration
48 @param sw_if_index - interface sw index
50 autoreply define igmp_enable_disable
59 /** \brief dump (S,G)s from interface
60 @param client_index - opaque cookie to identify the sender
61 @param context - sender context, to match reply w/ request
62 @param sw_if_index - interface sw index
63 @param dump_all - get (S,G)s from all interfaces
74 /** \brief igmp details
75 @param context - sender context, to match reply w/ request
76 @param sw_if_index - interface sw index
77 @param saddr - source address
78 @param gaddr - group address
89 /** \brief remove all (S,G)s from an interface
90 @param client_index - opaque cookie to identify the sender
91 @param context - sender context, to match reply w/ request
92 @param sw_if_index - interface sw index
94 autoreply define igmp_clear_interface
102 /** \brief register for igmp events
103 @param client_index - opaque cookie to identify the sender
104 @param context - sender context, to match reply w/ request
105 @param pid - sender's pid
106 @param enable - 1 enable, 0 disable igmp events
108 autoreply define want_igmp_events
118 rpc want_igmp_events returns want_igmp_events_reply
122 /** \brief igmp event details
123 @param client_index - opaque cookie to identify the sender
124 @param context - sender context, to match reply w/ request
125 @param sw_if_index - interface sw index
126 @param saddr - source address
127 @param gaddr - group address
128 @param is_join - if set source is joining the group, else leaving
142 * eval: (c-set-style "gnu")