riplib.html

Vxworks API操作系统和驱动程序设计API。压缩的HTML文件

delete the route or change its metric. If the hook returns a 
value greater than or equal to <b>HOPCNT_INFINITY</b>, RIP deletes 
the route from its internal routing data base. If the hook 
routine returns a valid metric (a value greater than zero 
but less than <b>HOPCNT_INFINITY</b>), RIP reassigns the routes 
metric to equal the returned value of the route hook routine. 
If the returned value of the route hook route is invalid 
(less than zero) RIP ignores the event. RIP also ignores 
the event if the route specified in <i>pRouteInfo</i> is not one 
stored in its internal data base. 
<p>
</blockQuote><h4>An ICMP Redirect Message Arrived </h4><blockQuote>
<p>
In response to this event, RIP never needs to make any changes 
to its internal routing database. Thus, RIP ignores the returned 
function value of the route hook routine called in response 
to an ICMP redirect message. However, if the event is of 
interest to your particular environment, and it makes sense 
to catch the event in the context of the RIP task, you can 
use the route hook routine to do so. 
<p>
Within your route hook routine, your can recognize an ICMP 
event by checking whether the flags parameter value sets 
the <b>RIP_REDIRECT_RECD</b> bit. The <i>primaryRoute</i> parameter passes 
in a boolean value that indicates whether the route is 
primary route. If the <i>primaryRoute</i> passes in <b>FALSE</b>, the 
route hook routine need will most likely need to do nothing 
more. If this parameter passes in <b>TRUE</b>, take whatever action 
(if any) that you know to be appropriate to your particular 
environment. 
<p>
</blockquote><h4>RETURNS</h4><blockquote><p>
OK; or ERROR, if RIP is not initialized.
</blockquote><h4>SEE ALSO</h4><blockquote><p>
<b><a href="./ripLib.html#top">ripLib</a></b>

<hr>
<a name="ripRouteHookDelete"></a>
<p align=right>
<a href="rtnIndex.htm"><i>OS Libraries :  Routines</i></a></p>

</blockquote><h1>ripRouteHookDelete(&nbsp;)</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote>  
<p><strong>ripRouteHookDelete(&nbsp;)</strong> - remove the route hook</p>

</blockquote><h4>SYNOPSIS</h4><blockquote><p>
<pre>STATUS ripRouteHookDelete (void)</pre>

</blockquote><h4>DESCRIPTION</h4><blockquote><p>
This routine removes the route hook installed earlier by the 
<b><a href="./ripLib.html#ripRouteHookAdd">ripRouteHookAdd</a>(&nbsp;)</b> routine. This will cause RIP to ignore any routes
added to the system Routing database.
<p>
</blockquote><h4>RETURNS</h4><blockquote><p>
OK; or ERROR, if RIP is not initialized.
</blockquote><h4>SEE ALSO</h4><blockquote><p>
<b><a href="./ripLib.html#top">ripLib</a></b>

<hr>
<a name="ripIfSearch"></a>
<p align=right>
<a href="rtnIndex.htm"><i>OS Libraries :  Routines</i></a></p>

</blockquote><h1>ripIfSearch(&nbsp;)</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote>  
<p><strong>ripIfSearch(&nbsp;)</strong> - add new interfaces to the internal list</p>

</blockquote><h4>SYNOPSIS</h4><blockquote><p>
<pre>void ripIfSearch (void)</pre>

</blockquote><h4>DESCRIPTION</h4><blockquote><p>
By default, a RIP session will not recognize any interfaces initialized
after it has started. This routine schedules a search for additional
interfaces that will occur during the next update of the internal routing
table. Once completed, the session will accept and send RIP messages over
the new interfaces.
<p>
</blockquote><h4>RETURNS</h4><blockquote><p>
N/A
<p>
</blockquote><h4>ERRNO</h4><blockquote><p>
N/A
<p>
</blockquote><h4>SEE ALSO</h4><blockquote><p>
<b><a href="./ripLib.html#top">ripLib</a></b>

<hr>
<a name="ripIfReset"></a>
<p align=right>
<a href="rtnIndex.htm"><i>OS Libraries :  Routines</i></a></p>

</blockquote><h1>ripIfReset(&nbsp;)</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote>  
<p><strong>ripIfReset(&nbsp;)</strong> - alter the RIP configuration after an interface changes</p>

</blockquote><h4>SYNOPSIS</h4><blockquote><p>
<pre>STATUS ripIfReset
    (
    char * pIfName            /* name of changed interface */
    )
</pre>

</blockquote><h4>DESCRIPTION</h4><blockquote><p>
This routine updates the interface list and routing tables to reflect
address and/or netmask changes for the device indicated by <i>pIfName</i>. 
To accommodate possible changes in the network number, all routes using 
the named interface are removed from the routing tables, but will be
added in the next route update if appropriate. None of the removed
routes are poisoned, so it may take some time for the routing tables of
all the RIP participants to stabilize if the network number has changed.
This routine replaces the existing interface structure with a new one.
Thus, any interface specific MIB2 changes that were made to the interface
being reset will be lost
<p>
</blockquote><h4>RETURNS</h4><blockquote><p>
OK, or ERROR if named interface not found or not added to list.
<p>
</blockquote><h4>ERRNO</h4><blockquote><p>
N/A
<p>
</blockquote><h4>SEE ALSO</h4><blockquote><p>
<b><a href="./ripLib.html#top">ripLib</a></b>

<hr>
<a name="ripFilterEnable"></a>
<p align=right>
<a href="rtnIndex.htm"><i>OS Libraries :  Routines</i></a></p>

</blockquote><h1>ripFilterEnable(&nbsp;)</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote>  
<p><strong>ripFilterEnable(&nbsp;)</strong> - activate strict border gateway filtering</p>

</blockquote><h4>SYNOPSIS</h4><blockquote><p>
<pre>void ripFilterEnable (void)</pre>

</blockquote><h4>DESCRIPTION</h4><blockquote><p>
This routine configures an active RIP session to enforce the restrictions 
necessary for RIP-1 and RIP-2 routers to operate correctly in the same 
network as described in section 3.2 of RFC 1058 and section 3.3 of RFC 1723. 
When enabled, routes to portions of a logical network (including host 
routes) will be limited to routers within that network. Updates sent 
outside that network will only include a single entry representing the 
entire network. That entry will subsume all subnets and host-specific
routes. If supernets are used, the entry will advertise the largest
class-based portion of the supernet reachable through the connected
interface.
<p>
</blockquote><h4>RETURNS</h4><blockquote><p>
N/A
<p>
</blockquote><h4>ERRNO</h4><blockquote><p>
N/A
<p>
</blockquote><h4>SEE ALSO</h4><blockquote><p>
<b><a href="./ripLib.html#top">ripLib</a></b>

<hr>
<a name="ripFilterDisable"></a>
<p align=right>
<a href="rtnIndex.htm"><i>OS Libraries :  Routines</i></a></p>

</blockquote><h1>ripFilterDisable(&nbsp;)</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote>  
<p><strong>ripFilterDisable(&nbsp;)</strong> - prevent strict border gateway filtering</p>

</blockquote><h4>SYNOPSIS</h4><blockquote><p>
<pre>void ripFilterDisable (void)</pre>

</blockquote><h4>DESCRIPTION</h4><blockquote><p>
This routine configures an active RIP session to ignore the restrictions 
necessary for RIP-1 and RIP-2 routers to operate correctly in the same 
network. All border gateway filtering is ignored and all routes to
subnets, supernets, and specific hosts will be sent over any available 
interface. This operation is only correct if no RIP-1 routers are present 
anywhere on the network. Results are unpredictable if that condition is 
not met, but high rates of packet loss and widespread routing failures are 
likely.
<p>
The border gateway filtering rules are in force by default.
<p>
</blockquote><h4>RETURNS</h4><blockquote><p>
N/A
<p>
</blockquote><h4>ERRNO</h4><blockquote><p>
N/A
<p>
</blockquote><h4>SEE ALSO</h4><blockquote><p>
<b><a href="./ripLib.html#top">ripLib</a></b>

<hr>
<a name="ripShutdown"></a>
<p align=right>
<a href="rtnIndex.htm"><i>OS Libraries :  Routines</i></a></p>

</blockquote><h1>ripShutdown(&nbsp;)</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote>  
<p><strong>ripShutdown(&nbsp;)</strong> - terminate all RIP processing</p>

</blockquote><h4>SYNOPSIS</h4><blockquote><p>
<pre>STATUS ripShutdown (void)</pre>

</blockquote><h4>DESCRIPTION</h4><blockquote><p>
This routine "poisons" all routes in the current table by transmitting
updates with an infinite metric for each entry over all available
interfaces. It then halts all RIP processing and removes the associated
tasks and data structures. When completed successfully, the RIP
services are unavailable until restarted with the <b><a href="./ripLib.html#ripLibInit">ripLibInit</a>(&nbsp;)</b> routine.
<p>
</blockquote><h4>RETURNS</h4><blockquote><p>
OK if shutdown completed, or ERROR otherwise.
<p>
</blockquote><h4>ERRNO</h4><blockquote><p>
N/A
<p>
</blockquote><h4>SEE ALSO</h4><blockquote><p>
<b><a href="./ripLib.html#top">ripLib</a></b>

<hr>
<a name="ripDebugLevelSet"></a>
<p align=right>
<a href="rtnIndex.htm"><i>OS Libraries :  Routines</i></a></p>

</blockquote><h1>ripDebugLevelSet(&nbsp;)</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote>  
<p><strong>ripDebugLevelSet(&nbsp;)</strong> - specify amount of debugging output</p>

</blockquote><h4>SYNOPSIS</h4><blockquote><p>
<pre>void ripDebugLevelSet
    (
    int level                 /* verbosity level (0 - 3) */
    )
</pre>

</blockquote><h4>DESCRIPTION</h4><blockquote><p>
This routine determines the amount of debugging information sent to
standard output during the RIP session. Higher values of the <i>level</i>
parameter result in increasingly verbose output. A <i>level</i> of zero
restores the default behavior by disabling all debugging output.
<p>
</blockquote><h4>RETURNS</h4><blockquote><p>
N/A
<p>
</blockquote><h4>ERRNO</h4><blockquote><p>
N/A
</blockquote><h4>SEE ALSO</h4><blockquote><p>
<b><a href="./ripLib.html#top">ripLib</a></b>

<hr>
<a name="ripAuthKeyShow"></a>
<p align=right>
<a href="rtnIndex.htm"><i>OS Libraries :  Routines</i></a></p>

</blockquote><h1>ripAuthKeyShow(&nbsp;)</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote>  
<p><strong>ripAuthKeyShow(&nbsp;)</strong> - show current authentication configuration</p>

</blockquote><h4>SYNOPSIS</h4><blockquote><p>
<pre>void ripAuthKeyShow
    (
    UINT showKey              /* if non-zero then key values are shown */
    )
</pre>

</blockquote><h4>DESCRIPTION</h4><blockquote><p>
This routines shows the current configuration of the authentication keys
for each interface.
<p>
</blockquote><h4>RETURNS</h4><blockquote><p>
N/A
</blockquote><h4>SEE ALSO</h4><blockquote><p>
<b><a href="./ripLib.html#top">ripLib</a></b>

<hr>
<a name="ripAuthKeyAdd"></a>
<p align=right>
<a href="rtnIndex.htm"><i>OS Libraries :  Routines</i></a></p>

</blockquote><h1>ripAuthKeyAdd(&nbsp;)</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote>  
<p><strong>ripAuthKeyAdd(&nbsp;)</strong> - add a new RIP authentication key</p>

</blockquote><h4>SYNOPSIS</h4><blockquote><p>
<pre>STATUS ripAuthKeyAdd
    (
    char * pInterfaceName,    /* interface to add a key */
    UINT16 keyId,             /* the keyId for this new key */
    char * pKey,              /* the secret key */