dhcp_server.h

Go to the documentation of this file.

 
#ifndef _DHCP_SERVER_H
#define _DHCP_SERVER_H
 
//Dependencies
#include "core/net.h"
 
//DHCP server support
#ifndef DHCP_SERVER_SUPPORT
   #define DHCP_SERVER_SUPPORT DISABLED
#elif (DHCP_SERVER_SUPPORT != ENABLED && DHCP_SERVER_SUPPORT != DISABLED)
   #error DHCP_SERVER_SUPPORT parameter is not valid
#endif
 
//DHCP server tick interval
#ifndef DHCP_SERVER_TICK_INTERVAL
   #define DHCP_SERVER_TICK_INTERVAL 1000
#elif (DHCP_SERVER_TICK_INTERVAL < 10)
   #error DHCP_SERVER_TICK_INTERVAL parameter is not valid
#endif
 
//Maximum number of clients
#ifndef DHCP_SERVER_MAX_CLIENTS
   #define DHCP_SERVER_MAX_CLIENTS 16
#elif (DHCP_SERVER_MAX_CLIENTS < 1)
   #error DHCP_SERVER_MAX_CLIENTS parameter is not valid
#endif
 
//Default lease time, in seconds
#ifndef DHCP_SERVER_DEFAULT_LEASE_TIME
   #define DHCP_SERVER_DEFAULT_LEASE_TIME 86400
#elif (DHCP_SERVER_DEFAULT_LEASE_TIME < 1)
   #error DHCP_SERVER_DEFAULT_LEASE_TIME parameter is not valid
#endif
 
//Maximum number of DNS servers
#ifndef DHCP_SERVER_MAX_DNS_SERVERS
   #define DHCP_SERVER_MAX_DNS_SERVERS 2
#elif (DHCP_SERVER_MAX_DNS_SERVERS < 1)
   #error DHCP_SERVER_MAX_DNS_SERVERS parameter is not valid
#endif
 
//Application specific context
#ifndef DHCP_SERVER_PRIVATE_CONTEXT
   #define DHCP_SERVER_PRIVATE_CONTEXT
#endif
 
//Forward declaration of DhcpServerContext structure
struct _DhcpServerContext;
#define DhcpServerContext struct _DhcpServerContext
 
//C++ guard
#ifdef __cplusplus
extern "C" {
#endif
 
 
typedef void (*DhcpServerAddOptionsCallback)(DhcpServerContext *context,
   DhcpMessage *message, size_t *length, DhcpMessageType type);
 
 
typedef error_t (*DhcpServerParseOptionsCallback)(DhcpServerContext *context,
   const DhcpMessage *message, size_t length, DhcpMessageType type);
 
 
typedef struct
{
   MacAddr macAddr;     
   Ipv4Addr ipAddr;     
   bool_t validLease;   
   systime_t timestamp; 
} DhcpServerBinding;
 
 
typedef struct
{
   NetInterface *interface;                             
   uint_t ipAddrIndex;                                  
   bool_t rapidCommit;                                  
   uint32_t leaseTime;                                  
   Ipv4Addr ipAddrRangeMin;                             
   Ipv4Addr ipAddrRangeMax;                             
   Ipv4Addr subnetMask;                                 
   Ipv4Addr defaultGateway;                             
   Ipv4Addr dnsServer[DHCP_SERVER_MAX_DNS_SERVERS];     
   DhcpServerAddOptionsCallback addOptionsCallback;     
   DhcpServerParseOptionsCallback parseOptionsCallback; 
} DhcpServerSettings;
 
 
struct _DhcpServerContext
{
   DhcpServerSettings settings;                              
   bool_t running;                                           
   Ipv4Addr nextIpAddr;                                      
   DhcpServerBinding clientBinding[DHCP_SERVER_MAX_CLIENTS]; 
   DHCP_SERVER_PRIVATE_CONTEXT                               
};
 
 
//DHCP server related functions
void dhcpServerGetDefaultSettings(DhcpServerSettings *settings);
 
error_t dhcpServerInit(DhcpServerContext *context,
   const DhcpServerSettings *settings);
 
error_t dhcpServerStart(DhcpServerContext *context);
error_t dhcpServerStop(DhcpServerContext *context);
 
void dhcpServerDeinit(DhcpServerContext *context);
 
//C++ guard
#ifdef __cplusplus
}
#endif
 
#endif