src/routing/static-routing/ipv4-static-routing.h
changeset 6273 8d70de29d514
parent 5856 7fd20c798a7d
equal deleted inserted replaced
6272:f52c6e3cae70 6273:8d70de29d514
   236  * output network interface indices over which packets matching the conditions
   236  * output network interface indices over which packets matching the conditions
   237  * are sent.
   237  * are sent.
   238  *
   238  *
   239  * Typically there are two main types of multicast routes:  routes of the 
   239  * Typically there are two main types of multicast routes:  routes of the 
   240  * first kind are used during forwarding.  All of the conditions must be
   240  * first kind are used during forwarding.  All of the conditions must be
   241  * exlicitly provided.  The second kind of routes are used to get packets off
   241  * explicitly provided.  The second kind of routes are used to get packets off
   242  * of a local node.  The difference is in the input interface.  Routes for
   242  * of a local node.  The difference is in the input interface.  Routes for
   243  * forwarding will always have an explicit input interface specified.  Routes
   243  * forwarding will always have an explicit input interface specified.  Routes
   244  * off of a node will always set the input interface to a wildcard specified
   244  * off of a node will always set the input interface to a wildcard specified
   245  * by the index Ipv4RoutingProtocol::INTERFACE_ANY.
   245  * by the index Ipv4RoutingProtocol::INTERFACE_ANY.
   246  *
   246  *
   333  * with n entries.  
   333  * with n entries.  
   334  * This method causes the multicast routing table to be searched for the first
   334  * This method causes the multicast routing table to be searched for the first
   335  * route that matches the parameters and removes it.
   335  * route that matches the parameters and removes it.
   336  *
   336  *
   337  * Wildcards may be provided to this function, but the wildcards are used to
   337  * Wildcards may be provided to this function, but the wildcards are used to
   338  * exacly match wildcards in the routes (see AddMulticastRoute).  That is,
   338  * exactly match wildcards in the routes (see AddMulticastRoute).  That is,
   339  * calling RemoveMulticastRoute with the origin set to "0.0.0.0" will not
   339  * calling RemoveMulticastRoute with the origin set to "0.0.0.0" will not
   340  * remove routes with any address in the origin, but will only remove routes
   340  * remove routes with any address in the origin, but will only remove routes
   341  * with "0.0.0.0" set as the the origin.
   341  * with "0.0.0.0" set as the the origin.
   342  *
   342  *
   343  * \param origin The IP address specified as the origin of packets for the
   343  * \param origin The IP address specified as the origin of packets for the
   344  * route.
   344  * route.
   345  * \param group The IP address specified as the multicast group addres of
   345  * \param group The IP address specified as the multicast group address of
   346  * the route.
   346  * the route.
   347  * \param inputInterface The network interface index specified as the expected
   347  * \param inputInterface The network interface index specified as the expected
   348  * input interface for the route.
   348  * input interface for the route.
   349  * \returns true if a route was found and removed, false otherwise.
   349  * \returns true if a route was found and removed, false otherwise.
   350  *
   350  *