| Line No. | Rev | Author | Line |
|---|---|---|---|
| 1 | 6 | kaklik | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> |
| 2 | <html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> |
||
| 3 | <title>Procyon AVRlib: net/dhcp.h File Reference</title> |
||
| 4 | <link href="dox.css" rel="stylesheet" type="text/css"> |
||
| 5 | </head><body> |
||
| 6 | <!-- Generated by Doxygen 1.4.2 --> |
||
| 7 | <div class="qindex"><a class="qindex" href="main.html">Main Page</a> | <a class="qindex" href="modules.html">Modules</a> | <a class="qindex" href="annotated.html">Data Structures</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="functions.html">Data Fields</a> | <a class="qindex" href="globals.html">Globals</a> | <a class="qindex" href="pages.html">Related Pages</a></div> |
||
| 8 | <div class="nav"> |
||
| 9 | <a class="el" href="dir_000001.html">net</a></div> |
||
| 10 | <h1>dhcp.h File Reference</h1><hr><a name="_details"></a><h2>Detailed Description</h2> |
||
| 11 | |||
| 12 | <p> |
||
| 13 | Definition in file <a class="el" href="dhcp_8h-source.html">dhcp.h</a>. |
||
| 14 | <p> |
||
| 15 | <code>#include "<a class="el" href="global_8h-source.html">global.h</a>"</code><br> |
||
| 16 | <code>#include "<a class="el" href="net_8h-source.html">net.h</a>"</code><br> |
||
| 17 | |||
| 18 | <p> |
||
| 19 | <a href="dhcp_8h-source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0"> |
||
| 20 | <tr><td></td></tr> |
||
| 21 | <tr><td colspan="2"><br><h2>Defines</h2></td></tr> |
||
| 22 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga9" doxytag="dhcp.h::BOOTP_HEADER_LEN"></a> |
||
| 23 | #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dhcp.html#ga9">BOOTP_HEADER_LEN</a> 236</td></tr> |
||
| 24 | |||
| 25 | <tr><td class="mdescLeft"> </td><td class="mdescRight">length of BOOTP header not including options <br></td></tr> |
||
| 26 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga10" doxytag="dhcp.h::BOOTP_OP_BOOTREQUEST"></a> |
||
| 27 | #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dhcp.html#ga10">BOOTP_OP_BOOTREQUEST</a> 1</td></tr> |
||
| 28 | |||
| 29 | <tr><td class="mdescLeft"> </td><td class="mdescRight">BOOTP Request operation (message from client to server). <br></td></tr> |
||
| 30 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga11" doxytag="dhcp.h::BOOTP_OP_BOOTREPLY"></a> |
||
| 31 | #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dhcp.html#ga11">BOOTP_OP_BOOTREPLY</a> 2</td></tr> |
||
| 32 | |||
| 33 | <tr><td class="mdescLeft"> </td><td class="mdescRight">BOOTP Reply operation (message from server to client). <br></td></tr> |
||
| 34 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga12" doxytag="dhcp.h::BOOTP_HTYPE_ETHERNET"></a> |
||
| 35 | #define </td><td class="memItemRight" valign="bottom"><b>BOOTP_HTYPE_ETHERNET</b> 1</td></tr> |
||
| 36 | |||
| 37 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga13" doxytag="dhcp.h::BOOTP_HLEN_ETHERNET"></a> |
||
| 38 | #define </td><td class="memItemRight" valign="bottom"><b>BOOTP_HLEN_ETHERNET</b> 6</td></tr> |
||
| 39 | |||
| 40 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga14" doxytag="dhcp.h::DHCP_HEADER_LEN"></a> |
||
| 41 | #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dhcp.html#ga14">DHCP_HEADER_LEN</a> 240</td></tr> |
||
| 42 | |||
| 43 | <tr><td class="mdescLeft"> </td><td class="mdescRight">length of DHCP header not including options <br></td></tr> |
||
| 44 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga15" doxytag="dhcp.h::DHCP_UDP_SERVER_PORT"></a> |
||
| 45 | #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dhcp.html#ga15">DHCP_UDP_SERVER_PORT</a> 67</td></tr> |
||
| 46 | |||
| 47 | <tr><td class="mdescLeft"> </td><td class="mdescRight">UDP port where DHCP requests should be sent. <br></td></tr> |
||
| 48 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga16" doxytag="dhcp.h::DHCP_UDP_CLIENT_PORT"></a> |
||
| 49 | #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dhcp.html#ga16">DHCP_UDP_CLIENT_PORT</a> 68</td></tr> |
||
| 50 | |||
| 51 | <tr><td class="mdescLeft"> </td><td class="mdescRight">UDP port clients will receive DHCP replies. <br></td></tr> |
||
| 52 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga17" doxytag="dhcp.h::DHCP_OPT_PAD"></a> |
||
| 53 | #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dhcp.html#ga17">DHCP_OPT_PAD</a> 0</td></tr> |
||
| 54 | |||
| 55 | <tr><td class="mdescLeft"> </td><td class="mdescRight">token padding value (make be skipped) <br></td></tr> |
||
| 56 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga18" doxytag="dhcp.h::DHCP_OPT_NETMASK"></a> |
||
| 57 | #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dhcp.html#ga18">DHCP_OPT_NETMASK</a> 1</td></tr> |
||
| 58 | |||
| 59 | <tr><td class="mdescLeft"> </td><td class="mdescRight">subnet mask client should use (4 byte mask) <br></td></tr> |
||
| 60 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga19" doxytag="dhcp.h::DHCP_OPT_ROUTERS"></a> |
||
| 61 | #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dhcp.html#ga19">DHCP_OPT_ROUTERS</a> 3</td></tr> |
||
| 62 | |||
| 63 | <tr><td class="mdescLeft"> </td><td class="mdescRight">routers client should use (IP addr list) <br></td></tr> |
||
| 64 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga20" doxytag="dhcp.h::DHCP_OPT_TIMESERVERS"></a> |
||
| 65 | #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dhcp.html#ga20">DHCP_OPT_TIMESERVERS</a> 4</td></tr> |
||
| 66 | |||
| 67 | <tr><td class="mdescLeft"> </td><td class="mdescRight">time servers client should use (IP addr list) <br></td></tr> |
||
| 68 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga21" doxytag="dhcp.h::DHCP_OPT_NAMESERVERS"></a> |
||
| 69 | #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dhcp.html#ga21">DHCP_OPT_NAMESERVERS</a> 5</td></tr> |
||
| 70 | |||
| 71 | <tr><td class="mdescLeft"> </td><td class="mdescRight">name servers client should use (IP addr list) <br></td></tr> |
||
| 72 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga22" doxytag="dhcp.h::DHCP_OPT_DNSSERVERS"></a> |
||
| 73 | #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dhcp.html#ga22">DHCP_OPT_DNSSERVERS</a> 6</td></tr> |
||
| 74 | |||
| 75 | <tr><td class="mdescLeft"> </td><td class="mdescRight">DNS servers client should use (IP addr list). <br></td></tr> |
||
| 76 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga23" doxytag="dhcp.h::DHCP_OPT_HOSTNAME"></a> |
||
| 77 | #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dhcp.html#ga23">DHCP_OPT_HOSTNAME</a> 12</td></tr> |
||
| 78 | |||
| 79 | <tr><td class="mdescLeft"> </td><td class="mdescRight">host name client should use (string) <br></td></tr> |
||
| 80 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga24" doxytag="dhcp.h::DHCP_OPT_DOMAINNAME"></a> |
||
| 81 | #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dhcp.html#ga24">DHCP_OPT_DOMAINNAME</a> 15</td></tr> |
||
| 82 | |||
| 83 | <tr><td class="mdescLeft"> </td><td class="mdescRight">domain name client should use (string) <br></td></tr> |
||
| 84 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga25" doxytag="dhcp.h::DHCP_OPT_REQUESTEDIP"></a> |
||
| 85 | #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dhcp.html#ga25">DHCP_OPT_REQUESTEDIP</a> 50</td></tr> |
||
| 86 | |||
| 87 | <tr><td class="mdescLeft"> </td><td class="mdescRight">IP address requested by client (IP address). <br></td></tr> |
||
| 88 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga26" doxytag="dhcp.h::DHCP_OPT_LEASETIME"></a> |
||
| 89 | #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dhcp.html#ga26">DHCP_OPT_LEASETIME</a> 51</td></tr> |
||
| 90 | |||
| 91 | <tr><td class="mdescLeft"> </td><td class="mdescRight">DHCP Lease Time (uint32 seconds). <br></td></tr> |
||
| 92 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga27" doxytag="dhcp.h::DHCP_OPT_DHCPMSGTYPE"></a> |
||
| 93 | #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dhcp.html#ga27">DHCP_OPT_DHCPMSGTYPE</a> 53</td></tr> |
||
| 94 | |||
| 95 | <tr><td class="mdescLeft"> </td><td class="mdescRight">DHCP message type (1 byte). <br></td></tr> |
||
| 96 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga28" doxytag="dhcp.h::DHCP_OPT_SERVERID"></a> |
||
| 97 | #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dhcp.html#ga28">DHCP_OPT_SERVERID</a> 54</td></tr> |
||
| 98 | |||
| 99 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Server Identifier (IP address). <br></td></tr> |
||
| 100 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga29" doxytag="dhcp.h::DHCP_OPT_PARAMREQLIST"></a> |
||
| 101 | #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dhcp.html#ga29">DHCP_OPT_PARAMREQLIST</a> 55</td></tr> |
||
| 102 | |||
| 103 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Paramerter Request List (n OPT codes). <br></td></tr> |
||
| 104 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga30" doxytag="dhcp.h::DHCP_OPT_RENEWALTIME"></a> |
||
| 105 | #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dhcp.html#ga30">DHCP_OPT_RENEWALTIME</a> 58</td></tr> |
||
| 106 | |||
| 107 | <tr><td class="mdescLeft"> </td><td class="mdescRight">DHCP Lease Renewal Time (uint32 seconds). <br></td></tr> |
||
| 108 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga31" doxytag="dhcp.h::DHCP_OPT_REBINDTIME"></a> |
||
| 109 | #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dhcp.html#ga31">DHCP_OPT_REBINDTIME</a> 59</td></tr> |
||
| 110 | |||
| 111 | <tr><td class="mdescLeft"> </td><td class="mdescRight">DHCP Lease Rebinding Time (uint32 seconds). <br></td></tr> |
||
| 112 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga32" doxytag="dhcp.h::DHCP_OPT_END"></a> |
||
| 113 | #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dhcp.html#ga32">DHCP_OPT_END</a> 255</td></tr> |
||
| 114 | |||
| 115 | <tr><td class="mdescLeft"> </td><td class="mdescRight">token end value (marks end of options list) <br></td></tr> |
||
| 116 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga33" doxytag="dhcp.h::DHCP_MSG_DHCPDISCOVER"></a> |
||
| 117 | #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dhcp.html#ga33">DHCP_MSG_DHCPDISCOVER</a> 1</td></tr> |
||
| 118 | |||
| 119 | <tr><td class="mdescLeft"> </td><td class="mdescRight">DISCOVER is broadcast by client to solicit OFFER from any/all DHCP servers. <br></td></tr> |
||
| 120 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga34" doxytag="dhcp.h::DHCP_MSG_DHCPOFFER"></a> |
||
| 121 | #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dhcp.html#ga34">DHCP_MSG_DHCPOFFER</a> 2</td></tr> |
||
| 122 | |||
| 123 | <tr><td class="mdescLeft"> </td><td class="mdescRight">OFFER(s) are made to client by server to offer IP address and config info. <br></td></tr> |
||
| 124 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga35" doxytag="dhcp.h::DHCP_MSG_DHCPREQUEST"></a> |
||
| 125 | #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dhcp.html#ga35">DHCP_MSG_DHCPREQUEST</a> 3</td></tr> |
||
| 126 | |||
| 127 | <tr><td class="mdescLeft"> </td><td class="mdescRight">REQUEST is made my client in response to best/favorite OFFER message. <br></td></tr> |
||
| 128 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga36" doxytag="dhcp.h::DHCP_MSG_DHCPDECLINE"></a> |
||
| 129 | #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dhcp.html#ga36">DHCP_MSG_DHCPDECLINE</a> 4</td></tr> |
||
| 130 | |||
| 131 | <tr><td class="mdescLeft"> </td><td class="mdescRight">DECLINE may be sent by client to server to indicate IP already in use. <br></td></tr> |
||
| 132 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga37" doxytag="dhcp.h::DHCP_MSG_DHCPACK"></a> |
||
| 133 | #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dhcp.html#ga37">DHCP_MSG_DHCPACK</a> 5</td></tr> |
||
| 134 | |||
| 135 | <tr><td class="mdescLeft"> </td><td class="mdescRight">ACK is sent to client by server in confirmation of REQUEST, contains config and IP. <br></td></tr> |
||
| 136 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga38" doxytag="dhcp.h::DHCP_MSG_DHCPNAK"></a> |
||
| 137 | #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dhcp.html#ga38">DHCP_MSG_DHCPNAK</a> 6</td></tr> |
||
| 138 | |||
| 139 | <tr><td class="mdescLeft"> </td><td class="mdescRight">NAK is sent to client by server to indicate problem with REQUEST. <br></td></tr> |
||
| 140 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga39" doxytag="dhcp.h::DHCP_MSG_DHCPRELEASE"></a> |
||
| 141 | #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dhcp.html#ga39">DHCP_MSG_DHCPRELEASE</a> 7</td></tr> |
||
| 142 | |||
| 143 | <tr><td class="mdescLeft"> </td><td class="mdescRight">RELEASE is sent by client to server to relinquish DHCP lease on IP address, etc. <br></td></tr> |
||
| 144 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga40" doxytag="dhcp.h::DHCP_MSG_DHCPINFORM"></a> |
||
| 145 | #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dhcp.html#ga40">DHCP_MSG_DHCPINFORM</a> 8</td></tr> |
||
| 146 | |||
| 147 | <tr><td class="mdescLeft"> </td><td class="mdescRight">INFORM is sent by client to server to request config info, IP address configured locally. <br></td></tr> |
||
| 148 | <tr><td colspan="2"><br><h2>Functions</h2></td></tr> |
||
| 149 | <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dhcp.html#ga1">dhcpInit</a> (void)</td></tr> |
||
| 150 | |||
| 151 | <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dhcp.html#ga2">dhcpIn</a> (unsigned int len, struct <a class="el" href="structnetDhcpHeader.html">netDhcpHeader</a> *packet)</td></tr> |
||
| 152 | |||
| 153 | <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dhcp.html#ga3">dhcpRequest</a> (void)</td></tr> |
||
| 154 | |||
| 155 | <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dhcp.html#ga4">dhcpRelease</a> (void)</td></tr> |
||
| 156 | |||
| 157 | <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dhcp.html#ga5">dhcpTimer</a> (void)</td></tr> |
||
| 158 | |||
| 159 | <tr><td class="memItemLeft" nowrap align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dhcp.html#ga6">dhcpGetOption</a> (uint8_t *options, uint8_t optcode, uint8_t optlen, void *optvalptr)</td></tr> |
||
| 160 | |||
| 161 | <tr><td class="memItemLeft" nowrap align="right" valign="top">uint8_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dhcp.html#ga7">dhcpSetOption</a> (uint8_t *options, uint8_t optcode, uint8_t optlen, void *optvalptr)</td></tr> |
||
| 162 | |||
| 163 | <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dhcp.html#ga8">dhcpPrintHeader</a> (struct <a class="el" href="structnetDhcpHeader.html">netDhcpHeader</a> *packet)</td></tr> |
||
| 164 | |||
| 165 | <tr><td colspan="2"><br><h2>Variables</h2></td></tr> |
||
| 166 | <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="ga0" doxytag="dhcp.h::GNUC_PACKED"></a> |
||
| 167 | <a class="el" href="structnetBootpHeader.html">netBootpHeader</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__dhcp.html#ga0">GNUC_PACKED</a></td></tr> |
||
| 168 | |||
| 169 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Bootp Header (DHCP is transported by BOOTP/UDP/IP). <br></td></tr> |
||
| 170 | </table> |
||
| 171 | <hr size="1"><address style="align: right;"><small>Generated on Sun Oct 29 03:41:08 2006 for Procyon AVRlib by |
||
| 172 | <a href="http://www.doxygen.org/index.html"> |
||
| 173 | <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.2 </small></address> |
||
| 174 | </body> |
||
| 175 | </html> |
Powered by WebSVN v2.8.3