Nut/OS  4.10.3
API Reference
dhcp.h File Reference

DHCP protocol definitions. More...

#include <cfg/dhcp.h>
#include <sys/types.h>
#include <stdint.h>
#include <compiler.h>
Include dependency graph for dhcp.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.


int NutDhcpIfConfig (CONST char *name, uint8_t *mac, uint32_t timeout)
 Automatically configure an Ethernet network interface.
int NutDhcpRelease (CONST char *name, uint32_t timeout)
 Relinguish our DHCP lease.
int NutDhcpInform (CONST char *name, uint32_t timeout)
 Inform DHCP about an allocated address.
int NutDhcpStatus (CONST char *name)
 Return DHCP client status.
int NutDhcpError (CONST char *name)
 Return DHCP error code.
int NutDhcpIsConfigured (void) NUT_DEPRECATED
 Check if DHCP has configured our interface.

DHCP Client States.

Applications can request the current state of the DHCP client by calling NutDhcpStatus().

#define DHCPST_IDLE   0
 DHCP state: Stopped.
#define DHCPST_INIT   1
 DHCP state: Starting.
 DHCP state: Selecting.
 DHCP state: Requesting.
 DHCP state: Rebooting.
#define DHCPST_BOUND   5
 DHCP state: Bound.
 DHCP state: Renewing.
 DHCP state: Rebinding.
 DHCP state: Informing.
 DHCP state: Releasing.

DHCP Error Codes

Applications can request the lastest error code of the DHCP client by calling NutDhcpError().

 DHCP timeout error.
#define DHCPERR_NOMAC   2
 DHCP MAC error.
#define DHCPERR_STATE   3
 DHCP state error.
#define DHCPERR_BADDEV   17
 DHCP error: Bad device.
#define DHCPERR_SYSTEM   18
 DHCP system error.
 DHCP transmit error.
#define DHCPERR_RECEIVE   20
 DHCP receive error.

Detailed Description

DHCP protocol definitions.

 * $Log$
 * Revision 1.10  2008/08/11 07:00:23  haraldkipp
 * BSD types replaced by stdint types (feature request #1282721).
 * Revision 1.9  2006/10/08 16:48:22  haraldkipp
 * Documentation fixed
 * Revision 1.8  2005/08/02 17:46:49  haraldkipp
 * Major API documentation update.
 * Revision 1.7  2005/02/03 14:34:05  haraldkipp
 * Several bug fixes and enhancements. The most important fix will
 * avoid hanging, when Ethernut is reset while ICMP pings are
 * received. A large number of changes make the client to follow
 * RFC 2131 more closely, like maintaining renewal and rebind time.
 * Two new API calls, NutDhcpStatus() and NutDhcpError(), allow
 * to query the current status of the DHCP client. The previously
 * introduced API call NutDhcpIsConfigured() has been marked
 * deprecated. Another problem was with timeout, because the client
 * continued negotiation with the server after the timeout time
 * given in the API called elapsed. Now all internal timeouts are
 * adjusted to the API timeout. Furthermore the previous version
 * let the client continue on fatal errors like UDP receive or UDP
 * broadcast failures. Now the client stops on such errors and
 * informs the caller. Finally the documentation has been enhanced.
 * Revision 1.6  2004/12/31 10:52:18  drsung
 * Bugfixes from Michel Hendriks applied.
 * Revision 1.5  2004/03/18 11:22:03  haraldkipp
 * Deprecated functions removed
 * Revision 1.4  2004/02/25 16:24:13  haraldkipp
 * DHCP release added
 * Revision 1.3  2004/01/14 17:51:05  drsung
 * Fix for Win2k DHCP server applied. Thanks to Damian Slee
 * Revision 1.2  2003/08/05 20:20:36  haraldkipp
 * Comments added
 * Revision  2003/05/09 14:41:18  haraldkipp
 * Initial using 3.2.1

Definition in file dhcp.h.