dhcpc_8c.html

Freescale mcu OpenTCP-1.0.4.doc.html.zip 文档

          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">UINT8&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>&nbsp; <em>n</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>
<dl compact><dt><b>Author: </b></dt><dd>
 <ul>
<li> Vladan Jovanovic (<a href="mailto:[e-mail]">[e-mail]</a>) </ul>
</dl><dl compact><dt><b>Date: </b></dt><dd>
23.05.2003 </dl><dl compact><dt><b>Parameters: </b></dt><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>n</em>&nbsp;</td><td>
Number of bytes to read&amp;process. </td></tr>
</table>
</dl><dl compact><dt><b>Returns: </b></dt><dd>
Returns last for 4 bytes that were read as a 32-bit variable</dl>This is internal function that get's invoked to read a received parameter in DHCP message. Introduced to optimize code a little as 4 byte parameters are often returned by DHCP server (netmask, gateway, server identifier, T1, T2, lease expiration time, DNS IP,..) 
<p>
Definition at line <a class="el" href="dhcpc_8c-source.html#l00549">549</a> of file <a class="el" href="dhcpc_8c-source.html">dhcpc.c</a>.
<p>
References <a class="el" href="system_8h-source.html#l00210">RECEIVE_NETWORK_B</a>.
<p>
Referenced by <a class="el" href="dhcpc_8c-source.html#l00568">dhcpc_eventlistener()</a>.    </td>
  </tr>
</table>
<hr><h2>Variable Documentation</h2>
<a name="a0" doxytag="dhcpc.c::dhcpc_state"></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"> UINT8 dhcpc_state
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
This variable holds DHCP clients' current state information. Possible states are DHCP_STATE_INIT_REBOOT, DHCP_STATE_REBOOTING,  DHCP_STATE_INIT, DHCP_STATE_SELECTING, DHCP_STATE_REQUESTING, DHCP_STATE_BOUND, DHCP_STATE_RENEWING, DHCP_STATE_REBINDING. 
<p>
Definition at line <a class="el" href="dhcpc_8c-source.html#l00087">87</a> of file <a class="el" href="dhcpc_8c-source.html">dhcpc.c</a>.
<p>
Referenced by <a class="el" href="dhcpc_8c-source.html#l00568">dhcpc_eventlistener()</a>, <a class="el" href="dhcpc_8c-source.html#l00158">dhcpc_init()</a>, <a class="el" href="dhcpc_8c-source.html#l00201">dhcpc_run()</a>, and <a class="el" href="dhcpc_8c-source.html#l00389">dhcpc_send_message()</a>.    </td>
  </tr>
</table>
<a name="a1" doxytag="dhcpc.c::dhcpc_timer_handle"></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"> UINT8 dhcpc_timer_handle
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Hold DHCP clients' timer handle. We'll use only one timer from timer pool and take care of the rest by ourselves manually 
<p>
Definition at line <a class="el" href="dhcpc_8c-source.html#l00094">94</a> of file <a class="el" href="dhcpc_8c-source.html">dhcpc.c</a>.
<p>
Referenced by <a class="el" href="dhcpc_8c-source.html#l00158">dhcpc_init()</a>, and <a class="el" href="dhcpc_8c-source.html#l00201">dhcpc_run()</a>.    </td>
  </tr>
</table>
<a name="a2" doxytag="dhcpc.c::dhcpc_soc_handle"></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"> INT8 dhcpc_soc_handle
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
DHCP client's UDP socket handle 
<p>
Definition at line <a class="el" href="dhcpc_8c-source.html#l00100">100</a> of file <a class="el" href="dhcpc_8c-source.html">dhcpc.c</a>.
<p>
Referenced by <a class="el" href="dhcpc_8c-source.html#l00568">dhcpc_eventlistener()</a>, <a class="el" href="dhcpc_8c-source.html#l00158">dhcpc_init()</a>, and <a class="el" href="dhcpc_8c-source.html#l00389">dhcpc_send_message()</a>.    </td>
  </tr>
</table>
<a name="a3" doxytag="dhcpc.c::dhcpc_initialized"></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"> UINT8 dhcpc_initialized = 0
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Holds information if DHCP client is initialized 
<p>
Definition at line <a class="el" href="dhcpc_8c-source.html#l00106">106</a> of file <a class="el" href="dhcpc_8c-source.html">dhcpc.c</a>.
<p>
Referenced by <a class="el" href="dhcpc_8c-source.html#l00158">dhcpc_init()</a>, and <a class="el" href="dhcpc_8c-source.html#l00201">dhcpc_run()</a>.    </td>
  </tr>
</table>
<a name="a4" doxytag="dhcpc.c::dhcpc_t1"></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"> UINT32 dhcpc_t1
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
This variable holds renew time (in seconds) after which we'll start the renewing process. While obtaining the parameters from DHCP server (thus before we know of the renew time) this is used also to time retransmissions. 
<p>
Definition at line <a class="el" href="dhcpc_8c-source.html#l00115">115</a> of file <a class="el" href="dhcpc_8c-source.html">dhcpc.c</a>.
<p>
Referenced by <a class="el" href="dhcpc_8c-source.html#l00568">dhcpc_eventlistener()</a>, and <a class="el" href="dhcpc_8c-source.html#l00201">dhcpc_run()</a>.    </td>
  </tr>
</table>
<a name="a5" doxytag="dhcpc.c::dhcpc_t2"></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"> UINT32 dhcpc_t2
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
This variable holds rebind time (in seconds) after which we'll start the rebinding process. While obtaining the paramters from DHCP server (thus before we know of the renew time) this is  also used to time retransmissions as well as timeout detection 
<p>
Definition at line <a class="el" href="dhcpc_8c-source.html#l00124">124</a> of file <a class="el" href="dhcpc_8c-source.html">dhcpc.c</a>.
<p>
Referenced by <a class="el" href="dhcpc_8c-source.html#l00568">dhcpc_eventlistener()</a>, and <a class="el" href="dhcpc_8c-source.html#l00201">dhcpc_run()</a>.    </td>
  </tr>
</table>
<a name="a6" doxytag="dhcpc.c::dhcpc_server_identifier"></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"> UINT32 dhcpc_server_identifier
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
This variable will hold DHCP server identifier (which will actually be server's IP address). 
<p>
Definition at line <a class="el" href="dhcpc_8c-source.html#l00131">131</a> of file <a class="el" href="dhcpc_8c-source.html">dhcpc.c</a>.
<p>
Referenced by <a class="el" href="dhcpc_8c-source.html#l00568">dhcpc_eventlistener()</a>, and <a class="el" href="dhcpc_8c-source.html#l00389">dhcpc_send_message()</a>.    </td>
  </tr>
</table>
<a name="a7" doxytag="dhcpc.c::dhcpc_requested_ip"></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"> UINT32 dhcpc_requested_ip
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
This variable holds the IP address that DHCP server offered to us during address request procedure and this is the address that we will be requesting in all future requests untill DHCP server disallows us to use it any more. 
<p>
Definition at line <a class="el" href="dhcpc_8c-source.html#l00140">140</a> of file <a class="el" href="dhcpc_8c-source.html">dhcpc.c</a>.
<p>
Referenced by <a class="el" href="dhcpc_8c-source.html#l00568">dhcpc_eventlistener()</a>, <a class="el" href="dhcpc_8c-source.html#l00201">dhcpc_run()</a>, and <a class="el" href="dhcpc_8c-source.html#l00389">dhcpc_send_message()</a>.    </td>
  </tr>
</table>
<hr><address style="align: right;"><small>Generated on Sun Aug 3 20:33:00 2003 for OpenTCP by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border=0 
width=110 height=53></a>1.2.18 </small></address>
</body>
</html>