classpethsocket.html

pwlib开发文档

<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Enumerate all the interfaces that are capable of being accessed at the ethernet level. Begin with index 0, and increment until the function returns FALSE. The name string returned can be passed, unchanged, to the <a class="el" href="classPEthSocket.html#z117_0">Connect()</a> function.
<p>
Note that the driver does not need to be open for this function to work.
<p>
<dl compact><dt><b>Returns: </b></dt><dd>
 TRUE if an interface has the index supplied. </dl><dl compact><dt><b>Parameters: </b></dt><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>name</em>&nbsp;</td><td>
Index of interface Interface name </td></tr>
</table>
</dl>    </td>
  </tr>
</table>
<a name="z119_5" doxytag="PEthSocket::EnumIpAddress"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> BOOL PEthSocket::EnumIpAddress </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">PINDEX&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>idx</em>, </td>
        </tr>
        <tr>
          <td></td>
          <td></td>
          <td class="md" nowrap><a class="el" href="classPIPSocket_1_1Address.html">PIPSocket::Address</a> &amp;&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>addr</em>, </td>
        </tr>
        <tr>
          <td></td>
          <td></td>
          <td class="md" nowrap><a class="el" href="classPIPSocket_1_1Address.html">PIPSocket::Address</a> &amp;&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>netMask</em></td>
        </tr>
        <tr>
          <td></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Enumerate all of the IP addresses and net masks bound to the open interface. This allows all the addresses to be found on multi-homed hosts. Begin with index 0 and increment until the function returns FALSE to enumerate all the addresses.
<p>
<dl compact><dt><b>Returns: </b></dt><dd>
 TRUE if the address is returned, FALSE on error or if there are no more addresses bound to the interface. </dl><dl compact><dt><b>Parameters: </b></dt><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>addr</em>&nbsp;</td><td>
Index </td></tr>
<tr><td valign=top><em>netMask</em>&nbsp;</td><td>
Variable to receive the IP address. Variable to receive the net mask. </td></tr>
</table>
</dl>    </td>
  </tr>
</table>
<a name="z119_2" doxytag="PEthSocket::GetAddress"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> BOOL PEthSocket::GetAddress </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top"><a class="el" href="unionPEthSocket_1_1Address.html">Address</a> &amp;&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>&nbsp; <em>addr</em>          </td>
          <td class="md" valign="top">)&nbsp;</td>
          <td class="md" nowrap></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Get the low level MAC address of the open interface.
<p>
<dl compact><dt><b>Returns: </b></dt><dd>
 TRUE if the address is returned, FALSE on error. </dl><dl compact><dt><b>Parameters: </b></dt><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>addr</em>&nbsp;</td><td>
Variable to receive the MAC address. </td></tr>
</table>
</dl>    </td>
  </tr>
</table>
<a name="z121_2" doxytag="PEthSocket::GetFilter"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> BOOL PEthSocket::GetFilter </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">unsigned &amp;&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>mask</em>, </td>
        </tr>
        <tr>
          <td></td>
          <td></td>
          <td class="md" nowrap>WORD &amp;&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>type</em></td>
        </tr>
        <tr>
          <td></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Get the current filtering criteria for receiving packets.
<p>
A bit-wise OR of the FilterMask values will filter packets so that they do not appear in the <a class="el" href="classPEthSocket.html#z115_1">Read()</a> function at all.
<p>
The type is be the specific frame type to accept. A value of TypeAll may be used to match all frame types.
<p>
<dl compact><dt><b>Returns: </b></dt><dd>
 A bit mask is returned, a value of 0 indicates an error. </dl><dl compact><dt><b>Parameters: </b></dt><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>type</em>&nbsp;</td><td>
Bits for filtering on address Code for filtering on type. </td></tr>
</table>
</dl>    </td>
  </tr>
</table>
<a name="z119_4" doxytag="PEthSocket::GetIpAddress"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> BOOL PEthSocket::GetIpAddress </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top"><a class="el" href="classPIPSocket_1_1Address.html">PIPSocket::Address</a> &amp;&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>addr</em>, </td>
        </tr>
        <tr>
          <td></td>
          <td></td>
          <td class="md" nowrap><a class="el" href="classPIPSocket_1_1Address.html">PIPSocket::Address</a> &amp;&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>netMask</em></td>
        </tr>
        <tr>
          <td></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Get the prime IP number bound to the open interface. This also returns the net mask associated with the open interface.
<p>
<dl compact><dt><b>Returns: </b></dt><dd>
 TRUE if the address is returned, FALSE on error. </dl><dl compact><dt><b>Parameters: </b></dt><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>netMask</em>&nbsp;</td><td>
Variable to receive the IP address. Variable to receive the net mask. </td></tr>
</table>
</dl>    </td>
  </tr>
</table>
<a name="z119_3" doxytag="PEthSocket::GetIpAddress"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> BOOL PEthSocket::GetIpAddress </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top"><a class="el" href="classPIPSocket_1_1Address.html">PIPSocket::Address</a> &amp;&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>&nbsp; <em>addr</em>          </td>
          <td class="md" valign="top">)&nbsp;</td>
          <td class="md" nowrap></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Get the prime IP number bound to the open interface.
<p>
<dl compact><dt><b>Returns: </b></dt><dd>
 TRUE if the address is returned, FALSE on error. </dl><dl compact><dt><b>Parameters: </b></dt><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>addr</em>&nbsp;</td><td>
Variable to receive the IP address. </td></tr>
</table>
</dl>    </td>
  </tr>
</table>
<a name="z119_6" doxytag="PEthSocket::GetMedium"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> <a class="el" href="classPEthSocket.html#z119_0">MediumTypes</a> PEthSocket::GetMedium </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
          <td class="md" valign="top">)&nbsp;</td>
          <td class="md" nowrap></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Return the type of the interface.
<p>
<dl compact><dt><b>Returns: </b></dt><dd>
 Type enum for the interface, or NumMediumTypes if interface not open. </dl>    </td>
  </tr>
</table>
<a name="b1" doxytag="PEthSocket::GetProtocolName"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> virtual const char* PEthSocket::GetProtocolName </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
          <td class="md" valign="top">)&nbsp;</td>
          <td class="md" nowrap><code> [protected, virtual]</code></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
This function returns the protocol name for the socket type. 
<p>
Implements <a class="el" href="classPSocket.html#b2">PSocket</a>.    </td>
  </tr>
</table>
<a name="z117_1" doxytag="PEthSocket::Listen"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> virtual BOOL PEthSocket::Listen </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">unsigned&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>queueSize</em> = 5, </td>
        </tr>
        <tr>
          <td></td>
          <td></td>
          <td class="md" nowrap>WORD&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>port</em> = 0, </td>
        </tr>
        <tr>
          <td></td>
          <td></td>
          <td class="md" nowrap><a class="el" href="classPSocket.html#z369_0">Reusability</a>&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>reuse</em> = AddressIsExclusive</td>
        </tr>
        <tr>
          <td></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"><code> [virtual]</code></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
This function is illegal and will assert if attempted. You must be connected to an interface using <a class="el" href="classPEthSocket.html#z117_0">Connect()</a> to do I/O on the socket.
<p>
<dl compact><dt><b>Returns: </b></dt><dd>
 TRUE if the channel was successfully opened. </dl><dl compact><dt><b>Parameters: </b></dt><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>port</em>&nbsp;</td><td>
Number of pending accepts that may be queued. </td></tr>
<tr><td valign=top><em>reuse</em>&nbsp;</td><td>
Port number to use for the connection. Can/Cant listen more than once. </td></tr>
</table>
</dl>
<p>
Reimplemented from <a class="el" href="classPSocket.html#z369_2">PSocket</a>.    </td>
  </tr>
</table>
<a name="b0" doxytag="PEthSocket::OpenSocket"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> virtual BOOL PEthSocket::OpenSocket </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
          <td class="md" valign="top">)&nbsp;</td>
          <td class="md" nowrap><code> [protected, virtual]</code></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>

<p>
Implements <a class="el" href="classPSocket.html#b1">PSocket</a>.    </td>
  </tr>
</table>
<a name="z115_1" doxytag="PEthSocket::Read"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>