📄 proxyarplib.html
字号:
<html><head><!-- /vobs/wpwr/docs/vxworks/ref/proxyArpLib.html - generated by refgen from proxyArpLib.c --> <title> proxyArpLib </title></head><body bgcolor="#FFFFFF"> <hr><a name="top"></a><p align=right><a href="libIndex.html"><i>VxWorks Reference Manual : Libraries</i></a></p></blockquote><h1>proxyArpLib</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote> <p><strong>proxyArpLib</strong> - proxy Address Resolution Protocol (ARP) library </p></blockquote><h4>ROUTINES</h4><blockquote><p><p><b><i><a href="./proxyArpLib.html#proxyArpLibInit">proxyArpLibInit</a></i>( )</b> - initialize proxy ARP<br><b><i><a href="./proxyArpLib.html#proxyNetCreate">proxyNetCreate</a></i>( )</b> - create a proxy ARP network<br><b><i><a href="./proxyArpLib.html#proxyNetDelete">proxyNetDelete</a></i>( )</b> - delete a proxy network<br><b><i><a href="./proxyArpLib.html#proxyNetShow">proxyNetShow</a></i>( )</b> - show proxy ARP networks<br><b><i><a href="./proxyArpLib.html#proxyPortFwdOn">proxyPortFwdOn</a></i>( )</b> - enable broadcast forwarding for a particular port<br><b><i><a href="./proxyArpLib.html#proxyPortFwdOff">proxyPortFwdOff</a></i>( )</b> - disable broadcast forwarding for a particular port<br><b><i><a href="./proxyArpLib.html#proxyPortShow">proxyPortShow</a></i>( )</b> - show enabled ports<br><p></blockquote><h4>DESCRIPTION</h4><blockquote><p>This library provides transparent network access by using the AddressResolution Protocol (ARP) to make logically distinct networks appear asone logical network (that is, the networks share the same address space).This module implements a proxy ARP scheme which provides an alternatemethod (to subnets) of access to the WRS backplane.<p>This module implements the proxy server. The proxy server is the multi-homed target which provides network transparency over the backplane by watching for and answering ARP requests. <p>This implementation supports only a single tier of backplane networks (thatis, only targets on directly attached interfaces are proxied for). Only one proxy server resides on a particular backplane network.<p>This library is initialized by calling <b><i><a href="./proxyArpLib.html#proxyArpLibInit">proxyArpLibInit</a></i>( )</b>. Proxy networksare created by calling <b><i><a href="./proxyArpLib.html#proxyNetCreate">proxyNetCreate</a></i>( )</b> and deleted by calling<b><i><a href="./proxyArpLib.html#proxyNetDelete">proxyNetDelete</a></i>( )</b>. The <b><i><a href="./proxyArpLib.html#proxyNetShow">proxyNetShow</a></i>( )</b> routine displays the proxy and mainnetworks and the clients that reside on them.<p>A VxWorks backplane target registers itself as a target (proxy client) on the proxy network by calling <b><i><a href="./proxyLib.html#proxyReg">proxyReg</a></i>( )</b>. It unregisters itself by calling <b><i><a href="./proxyLib.html#proxyUnreg">proxyUnreg</a></i>( )</b>. These routines are provided in proxyLib.<p>To minimize and control backplane (proxy network) broadcast traffic, theproxy server must be configured to pass through broadcasts to a certainset of destination ports. Ports are enabled with the call<b><i><a href="./proxyArpLib.html#proxyPortFwdOn">proxyPortFwdOn</a></i>( )</b> and are disabled with the call <b><i><a href="./proxyArpLib.html#proxyPortFwdOff">proxyPortFwdOff</a></i>( )</b>. To seethe ports currently enabled use <b><i><a href="./proxyArpLib.html#proxyPortShow">proxyPortShow</a></i>( )</b>. By default, only theBOOTP server port is enabled.<p>For more information on proxy ARP, see the <i>VxWorks Programmer's Guide: Network </i><p></blockquote><h4>INCLUDE FILES</h4><blockquote><p><b>proxyArpLib.h</b><p></blockquote><h4>SEE ALSO</h4><blockquote><p><b><a href="./proxyLib.html#top">proxyLib</a></b>, RFC 925, RFC 1027, RFC 826, <i>Network Programmer's Guide </i><i>VxWorks Programmer's Guide: Network</i><p><hr><a name="proxyArpLibInit"></a><p align=right><a href="rtnIndex.html"><i>Libraries : Routines</i></a></p></blockquote><h1><i>proxyArpLibInit</i>( )</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote> <p><strong><i>proxyArpLibInit</i>( )</strong> - initialize proxy ARP</p></blockquote><h4>SYNOPSIS</h4><blockquote><p><pre>STATUS proxyArpLibInit ( int clientSizeLog2, /* client table size as power of two */ int portSizeLog2 /* port table size as power of two */ )</pre></blockquote><h4>DESCRIPTION</h4><blockquote><p>This routine initializes the proxy ARP library by initializing tables andstructures and adding the hooks to process ARP, proxy messages, andbroadcasts. <i>clientSizeLog2</i> specifies the client hash table size as apower of two. <i>portSizeLog2</i> specifies the port hash table as a power oftwo. If either of these parameters is zero, a default value will beused. By default, <b><i><a href="./proxyArpLib.html#proxyArpLibInit">proxyArpLibInit</a></i>( )</b> enables broadcast forwarding of theBOOTP server port. <p>This routine should be called only once; subsequent calls have no effect.<p></blockquote><h4>RETURNS</h4><blockquote><p>OK, or ERROR if unsuccessful.</blockquote><h4>SEE ALSO</h4><blockquote><p><b><a href="./proxyArpLib.html#top">proxyArpLib</a></b><hr><a name="proxyNetCreate"></a><p align=right><a href="rtnIndex.html"><i>Libraries : Routines</i></a></p></blockquote><h1><i>proxyNetCreate</i>( )</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote> <p><strong><i>proxyNetCreate</i>( )</strong> - create a proxy ARP network</p></blockquote><h4>SYNOPSIS</h4><blockquote><p><pre>STATUS proxyNetCreate ( char * proxyAddr, /* proxy network address */ char * mainAddr /* main network address */ )</pre></blockquote><h4>DESCRIPTION</h4><blockquote><p>This routine creates a proxy network with the interface <i>proxyAddr</i> as theproxy network and the interface <i>mainAddr</i> as the main network. Theinterfaces and the routing tables must be set up correctly, prior tocalling this routine. That is, the interfaces must be attached, addressesmust be set, and there should be a network route to <i>mainAddr</i> and noroutes to <i>proxyAddr</i>.<p><i>proxyAddr</i> and <i>mainAddr</i> must reside in the same network address space.<p></blockquote><h4>RETURNS</h4><blockquote><p>OK, or ERROR if unsuccessful.<p></blockquote><h4>ERRNO</h4><blockquote><p><p> S_proxyArpLib_INVALID_INTERFACE<br> S_proxyArpLib_INVALID_ADDRESS<p></blockquote><h4>SEE ALSO</h4><blockquote><p><b><a href="./proxyArpLib.html#top">proxyArpLib</a></b><hr><a name="proxyNetDelete"></a><p align=right><a href="rtnIndex.html"><i>Libraries : Routines</i></a></p></blockquote><h1><i>proxyNetDelete</i>( )</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote> <p><strong><i>proxyNetDelete</i>( )</strong> - delete a proxy network</p></blockquote><h4>SYNOPSIS</h4><blockquote><p><pre>STATUS proxyNetDelete ( char * proxyAddr /* proxy net address */ )</pre></blockquote><h4>DESCRIPTION</h4><blockquote><p>This routine deletes the proxy network specified by <i>proxyAddr</i>. It alsoremoves all the proxy clients that exist on that network.<p></blockquote><h4>RETURNS</h4><blockquote><p>OK, or ERROR if unsuccessful.</blockquote><h4>SEE ALSO</h4><blockquote><p><b><a href="./proxyArpLib.html#top">proxyArpLib</a></b><hr><a name="proxyNetShow"></a><p align=right><a href="rtnIndex.html"><i>Libraries : Routines</i></a></p></blockquote><h1><i>proxyNetShow</i>( )</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote> <p><strong><i>proxyNetShow</i>( )</strong> - show proxy ARP networks</p></blockquote><h4>SYNOPSIS</h4><blockquote><p><pre>void proxyNetShow (void)</pre></blockquote><h4>DESCRIPTION</h4><blockquote><p>This routine displays the proxy networks and their associated clients.<p></blockquote><h4>EXAMPLE</h4><blockquote><p><pre> -> proxyNetShow main interface 147.11.1.182 proxy interface 147.11.1.183 client 147.11.1.184</pre></blockquote><h4>RETURNS</h4><blockquote><p>N/A<p></blockquote><h4>SEE ALSO</h4><blockquote><p><b><a href="./proxyArpLib.html#top">proxyArpLib</a></b><hr><a name="proxyPortFwdOn"></a><p align=right><a href="rtnIndex.html"><i>Libraries : Routines</i></a></p></blockquote><h1><i>proxyPortFwdOn</i>( )</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote> <p><strong><i>proxyPortFwdOn</i>( )</strong> - enable broadcast forwarding for a particular port</p></blockquote><h4>SYNOPSIS</h4><blockquote><p><pre>STATUS proxyPortFwdOn ( int port /* port number */ )</pre></blockquote><h4>DESCRIPTION</h4><blockquote><p>This routine enables broadcasts destined for the port, <i>port</i>, to be forwarded to and from the proxy network. To enable all ports, specify zero for <i>port</i>.<p></blockquote><h4>RETURNS</h4><blockquote><p>OK, or ERROR if unsuccessful.</blockquote><h4>SEE ALSO</h4><blockquote><p><b><a href="./proxyArpLib.html#top">proxyArpLib</a></b><hr><a name="proxyPortFwdOff"></a><p align=right><a href="rtnIndex.html"><i>Libraries : Routines</i></a></p></blockquote><h1><i>proxyPortFwdOff</i>( )</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote> <p><strong><i>proxyPortFwdOff</i>( )</strong> - disable broadcast forwarding for a particular port</p></blockquote><h4>SYNOPSIS</h4><blockquote><p><pre>STATUS proxyPortFwdOff ( int port /* port number */ )</pre></blockquote><h4>DESCRIPTION</h4><blockquote><p>This routine disables broadcast forwarding on port number <i>port</i>. Todisable the (previously enabled) forwarding of all ports via<b><i><a href="./proxyArpLib.html#proxyPortFwdOn">proxyPortFwdOn</a></i>( )</b>, specify zero for <i>port</i>.<p></blockquote><h4>RETURNS</h4><blockquote><p>OK, or ERROR if unsuccessful.</blockquote><h4>SEE ALSO</h4><blockquote><p><b><a href="./proxyArpLib.html#top">proxyArpLib</a></b><hr><a name="proxyPortShow"></a><p align=right><a href="rtnIndex.html"><i>Libraries : Routines</i></a></p></blockquote><h1><i>proxyPortShow</i>( )</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote> <p><strong><i>proxyPortShow</i>( )</strong> - show enabled ports</p></blockquote><h4>SYNOPSIS</h4><blockquote><p><pre>void proxyPortShow (void)</pre></blockquote><h4>DESCRIPTION</h4><blockquote><p>This routine displays the ports currently enabled.<p></blockquote><h4>EXAMPLE</h4><blockquote><p><pre> -> proxyPortShow enabled ports: port 67</pre></blockquote><h4>RETURNS</h4><blockquote><p>N/A<p></blockquote><h4>SEE ALSO</h4><blockquote><p><b><a href="./proxyArpLib.html#top">proxyArpLib</a></b></body></html>
⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -