classpsocket.html

pwlib开发文档

          <td></td>
          <td></td>
          <td class="md" nowrap>void *&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>valuePtr</em>, </td>
        </tr>
        <tr>
          <td></td>
          <td></td>
          <td class="md" nowrap>PINDEX&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>valueSize</em>, </td>
        </tr>
        <tr>
          <td></td>
          <td></td>
          <td class="md" nowrap>int&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>level</em> = SOL_SOCKET</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 options on the socket. These options are defined as Berkeley socket options of the class SOL_SOCKET.
<p>
<dl compact><dt><b>Returns: </b></dt><dd>
 TRUE if the option was successfully retreived. </dl><dl compact><dt><b>Parameters: </b></dt><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>valuePtr</em>&nbsp;</td><td>
Option to get. </td></tr>
<tr><td valign=top><em>valueSize</em>&nbsp;</td><td>
Pointer to buffer for value. </td></tr>
<tr><td valign=top><em>level</em>&nbsp;</td><td>
Size of buffer to receive value. Level for option </td></tr>
</table>
</dl>    </td>
  </tr>
</table>
<a name="z371_2" doxytag="PSocket::GetOption"></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 PSocket::GetOption </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">int&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>option</em>, </td>
        </tr>
        <tr>
          <td></td>
          <td></td>
          <td class="md" nowrap>int &amp;&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>value</em>, </td>
        </tr>
        <tr>
          <td></td>
          <td></td>
          <td class="md" nowrap>int&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>level</em> = SOL_SOCKET</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 options on the socket. These options are defined as Berkeley socket options of the class SOL_SOCKET.
<p>
<dl compact><dt><b>Returns: </b></dt><dd>
 TRUE if the option was successfully retreived. </dl><dl compact><dt><b>Parameters: </b></dt><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>value</em>&nbsp;</td><td>
Option to get. </td></tr>
<tr><td valign=top><em>level</em>&nbsp;</td><td>
Integer to receive value. Level for option </td></tr>
</table>
</dl>    </td>
  </tr>
</table>
<a name="z373_4" doxytag="PSocket::GetPort"></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"> WORD PSocket::GetPort </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>
Get the port the TCP socket channel object instance is using.
<p>
<dl compact><dt><b>Returns: </b></dt><dd>
 Port number. </dl>    </td>
  </tr>
</table>
<a name="z373_8" doxytag="PSocket::GetPortByService"></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"> WORD PSocket::GetPortByService </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">const char *&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>protocol</em>, </td>
        </tr>
        <tr>
          <td></td>
          <td></td>
          <td class="md" nowrap>const <a class="el" href="classPString.html">PString</a> &amp;&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>service</em></td>
        </tr>
        <tr>
          <td></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"><code> [static]</code></td>
        </tr>

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

<p>
Get the port number for the specified service name.
<p>
A name is a unique string contained in a system database. The parameter here may be either this unique name, an integer value or both separated by a space (name then integer). In the latter case the integer value is used if the name cannot be found in the database.
<p>
The exact behviour of this function is dependent on whether TCP or UDP transport is being used. The PTCPSocket# and PUDPSocket# classes will implement this function.
<p>
The static version of the function is independent of the socket type as its first parameter may be "tcp" or "udp",
<p>
<dl compact><dt><b>Returns: </b></dt><dd>
 Port number for service name, or 0 if service cannot be found. </dl><dl compact><dt><b>Parameters: </b></dt><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>service</em>&nbsp;</td><td>
Protocol type for port lookup Name of service to get port number for. </td></tr>
</table>
</dl>    </td>
  </tr>
</table>
<a name="z373_0" doxytag="PSocket::GetPortByService"></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 WORD PSocket::GetPortByService </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">const <a class="el" href="classPString.html">PString</a> &amp;&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>&nbsp; <em>service</em>          </td>
          <td class="md" valign="top">)&nbsp;</td>
          <td class="md" nowrap> const<code> [virtual]</code></td>
        </tr>

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

<p>
Get the port number for the specified service name. <dl compact><dt><b>Parameters: </b></dt><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>service</em>&nbsp;</td><td>
Name of service to get port number for. </td></tr>
</table>
</dl>    </td>
  </tr>
</table>
<a name="z373_6" doxytag="PSocket::GetProtocolByName"></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"> WORD PSocket::GetProtocolByName </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">const <a class="el" href="classPString.html">PString</a> &amp;&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>&nbsp; <em>name</em>          </td>
          <td class="md" valign="top">)&nbsp;</td>
          <td class="md" nowrap><code> [static]</code></td>
        </tr>

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

<p>
Get the number of the protocol associated with the specified name.
<p>
<dl compact><dt><b>Returns: </b></dt><dd>
 Number of protocol or 0 if the protocol was not found. </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>
Name of protocol </td></tr>
</table>
</dl>    </td>
  </tr>
</table>
<a name="b2" doxytag="PSocket::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* PSocket::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, pure 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>
Implemented in <a class="el" href="classPEthSocket.html#b1">PEthSocket</a>, <a class="el" href="classPICMPSocket.html#b0">PICMPSocket</a>, <a class="el" href="classPIPXSocket.html#b1">PIPXSocket</a>, <a class="el" href="classPSPXSocket.html#b1">PSPXSocket</a>, <a class="el" href="classPTCPSocket.html#b2">PTCPSocket</a>, and <a class="el" href="classPUDPSocket.html#b4">PUDPSocket</a>.    </td>
  </tr>
</table>
<a name="z373_5" doxytag="PSocket::GetService"></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="classPString.html">PString</a> PSocket::GetService </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>
Get a service name for the port number the TCP socket channel object instance is using.
<p>
<dl compact><dt><b>Returns: </b></dt><dd>
 string service name or a string representation of the port number if no service with that number can be found. </dl>    </td>
  </tr>
</table>
<a name="z373_9" doxytag="PSocket::GetServiceByPort"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>