dhcpv6_client.h

Go to the documentation of this file.

 
#ifndef _DHCPV6_CLIENT_H
#define _DHCPV6_CLIENT_H
 
//Dependencies
#include "dhcpv6/dhcpv6_common.h"
#include "core/socket.h"
 
//DHCPv6 client support
#ifndef DHCPV6_CLIENT_SUPPORT
   #define DHCPV6_CLIENT_SUPPORT DISABLED
#elif (DHCPV6_CLIENT_SUPPORT != ENABLED && DHCPV6_CLIENT_SUPPORT != DISABLED)
   #error DHCPV6_CLIENT_SUPPORT parameter is not valid
#endif
 
//DHCPv6 client tick interval
#ifndef DHCPV6_CLIENT_TICK_INTERVAL
   #define DHCPV6_CLIENT_TICK_INTERVAL 200
#elif (DHCPV6_CLIENT_TICK_INTERVAL < 10)
   #error DHCPV6_CLIENT_TICK_INTERVAL parameter is not valid
#endif
 
//Maximum number of IPv6 addresses in the client's IA
#ifndef DHCPV6_CLIENT_ADDR_LIST_SIZE
   #define DHCPV6_CLIENT_ADDR_LIST_SIZE 2
#elif (DHCPV6_CLIENT_ADDR_LIST_SIZE < 1)
   #error DHCPV6_CLIENT_ADDR_LIST_SIZE parameter is not valid
#endif
 
//Max delay of first Solicit
#ifndef DHCPV6_CLIENT_SOL_MAX_DELAY
   #define DHCPV6_CLIENT_SOL_MAX_DELAY 1000
#elif (DHCPV6_CLIENT_SOL_MAX_DELAY < 100)
   #error DHCPV6_CLIENT_SOL_MAX_DELAY parameter is not valid
#endif
 
//Initial Solicit timeout
#ifndef DHCPV6_CLIENT_SOL_TIMEOUT
   #define DHCPV6_CLIENT_SOL_TIMEOUT 1000
#elif (DHCPV6_CLIENT_SOL_TIMEOUT < 100)
   #error DHCPV6_CLIENT_SOL_TIMEOUT parameter is not valid
#endif
 
//Max Solicit timeout value
#ifndef DHCPV6_CLIENT_SOL_MAX_RT
   #define DHCPV6_CLIENT_SOL_MAX_RT 120000
#elif (DHCPV6_CLIENT_SOL_MAX_RT < 100)
   #error DHCPV6_CLIENT_SOL_MAX_RT parameter is not valid
#endif
 
//Initial Request timeout
#ifndef DHCPV6_CLIENT_REQ_TIMEOUT
   #define DHCPV6_CLIENT_REQ_TIMEOUT 1000
#elif (DHCPV6_CLIENT_REQ_TIMEOUT < 100)
   #error DHCPV6_CLIENT_REQ_TIMEOUT parameter is not valid
#endif
 
//Max Request timeout value
#ifndef DHCPV6_CLIENT_REQ_MAX_RT
   #define DHCPV6_CLIENT_REQ_MAX_RT 30000
#elif (DHCPV6_CLIENT_REQ_MAX_RT < 100)
   #error DHCPV6_CLIENT_REQ_MAX_RT parameter is not valid
#endif
 
//Max Request retry attempts
#ifndef DHCPV6_CLIENT_REQ_MAX_RC
   #define DHCPV6_CLIENT_REQ_MAX_RC 10
#elif (DHCPV6_CLIENT_REQ_MAX_RC < 1)
   #error DHCPV6_CLIENT_REQ_MAX_RC parameter is not valid
#endif
 
//Max delay of first Confirm
#ifndef DHCPV6_CLIENT_CNF_MAX_DELAY
   #define DHCPV6_CLIENT_CNF_MAX_DELAY 1000
#elif (DHCPV6_CLIENT_CNF_MAX_DELAY < 100)
   #error DHCPV6_CLIENT_CNF_MAX_DELAY parameter is not valid
#endif
 
//Initial Confirm timeout
#ifndef DHCPV6_CLIENT_CNF_TIMEOUT
   #define DHCPV6_CLIENT_CNF_TIMEOUT 1000
#elif (DHCPV6_CLIENT_CNF_TIMEOUT < 100)
   #error DHCPV6_CLIENT_CNF_TIMEOUT parameter is not valid
#endif
 
//Max Confirm timeout
#ifndef DHCPV6_CLIENT_CNF_MAX_RT
   #define DHCPV6_CLIENT_CNF_MAX_RT 4000
#elif (DHCPV6_CLIENT_CNF_MAX_RT < 100)
   #error DHCPV6_CLIENT_CNF_MAX_RT parameter is not valid
#endif
 
//Max Confirm duration
#ifndef DHCPV6_CLIENT_CNF_MAX_RD
   #define DHCPV6_CLIENT_CNF_MAX_RD 10000
#elif (DHCPV6_CLIENT_CNF_MAX_RD < 100)
   #error DHCPV6_CLIENT_CNF_MAX_RD parameter is not valid
#endif
 
//Initial Renew timeout
#ifndef DHCPV6_CLIENT_REN_TIMEOUT
   #define DHCPV6_CLIENT_REN_TIMEOUT 10000
#elif (DHCPV6_CLIENT_REN_TIMEOUT < 100)
   #error DHCPV6_CLIENT_REN_TIMEOUT parameter is not valid
#endif
 
//Max Renew timeout value
#ifndef DHCPV6_CLIENT_REN_MAX_RT
   #define DHCPV6_CLIENT_REN_MAX_RT 600000
#elif (DHCPV6_CLIENT_REN_MAX_RT < 100)
   #error DHCPV6_CLIENT_REN_MAX_RT parameter is not valid
#endif
 
//Initial Rebind timeout
#ifndef DHCPV6_CLIENT_REB_TIMEOUT
   #define DHCPV6_CLIENT_REB_TIMEOUT 10000
#elif (DHCPV6_CLIENT_REB_TIMEOUT < 100)
   #error DHCPV6_CLIENT_REB_TIMEOUT parameter is not valid
#endif
 
//Max Rebind timeout value
#ifndef DHCPV6_CLIENT_REB_MAX_RT
   #define DHCPV6_CLIENT_REB_MAX_RT 600000
#elif (DHCPV6_CLIENT_REB_MAX_RT < 100)
   #error DHCPV6_CLIENT_REB_MAX_RT parameter is not valid
#endif
 
//Max delay of first Information-request
#ifndef DHCPV6_CLIENT_INF_MAX_DELAY
   #define DHCPV6_CLIENT_INF_MAX_DELAY 1000
#elif (DHCPV6_CLIENT_INF_MAX_DELAY < 100)
   #error DHCPV6_CLIENT_INF_MAX_DELAY parameter is not valid
#endif
 
//Initial Information-request timeout
#ifndef DHCPV6_CLIENT_INF_TIMEOUT
   #define DHCPV6_CLIENT_INF_TIMEOUT 1000
#elif (DHCPV6_CLIENT_INF_TIMEOUT < 100)
   #error DHCPV6_CLIENT_INF_TIMEOUT parameter is not valid
#endif
 
//Max Information-request timeout value
#ifndef DHCPV6_CLIENT_INF_MAX_RT
   #define DHCPV6_CLIENT_INF_MAX_RT 120000
#elif (DHCPV6_CLIENT_INF_MAX_RT < 1000)
   #error DHCPV6_CLIENT_INF_MAX_RT parameter is not valid
#endif
 
//Initial Release timeout
#ifndef DHCPV6_CLIENT_REL_TIMEOUT
   #define DHCPV6_CLIENT_REL_TIMEOUT 1000
#elif (DHCPV6_CLIENT_REL_TIMEOUT < 100)
   #error DHCPV6_CLIENT_REL_TIMEOUT parameter is not valid
#endif
 
//Max Release attempts
#ifndef DHCPV6_CLIENT_REL_MAX_RC
   #define DHCPV6_CLIENT_REL_MAX_RC 5
#elif (DHCPV6_CLIENT_REL_MAX_RC < 1)
   #error DHCPV6_CLIENT_REL_MAX_RC parameter is not valid
#endif
 
//Initial Decline timeout
#ifndef DHCPV6_CLIENT_DEC_TIMEOUT
   #define DHCPV6_CLIENT_DEC_TIMEOUT 1000
#elif (DHCPV6_CLIENT_DEC_TIMEOUT < 100)
   #error DHCPV6_CLIENT_DEC_TIMEOUT parameter is not valid
#endif
 
//Max Decline attempts
#ifndef DHCPV6_CLIENT_DEC_MAX_RC
   #define DHCPV6_CLIENT_DEC_MAX_RC 5
#elif (DHCPV6_CLIENT_DEC_MAX_RC < 1)
   #error DHCPV6_CLIENT_DEC_MAX_RC parameter is not valid
#endif
 
//Initial Reconfigure timeout
#ifndef DHCPV6_CLIENT_REC_TIMEOUT
   #define DHCPV6_CLIENT_REC_TIMEOUT 2000
#elif (DHCPV6_CLIENT_REC_TIMEOUT < 100)
   #error DHCPV6_CLIENT_REC_TIMEOUT parameter is not valid
#endif
 
//Max Reconfigure attempts
#ifndef DHCPV6_CLIENT_REC_MAX_RC
   #define DHCPV6_CLIENT_REC_MAX_RC 8
#elif (DHCPV6_CLIENT_REC_MAX_RC < 1)
   #error DHCPV6_CLIENT_REC_MAX_RC parameter is not valid
#endif
 
//Application specific context
#ifndef DHCPV6_CLIENT_PRIVATE_CONTEXT
   #define DHCPV6_CLIENT_PRIVATE_CONTEXT
#endif
 
//Forward declaration of Dhcpv6ClientContext structure
struct _Dhcpv6ClientContext;
#define Dhcpv6ClientContext struct _Dhcpv6ClientContext
 
//C++ guard
#ifdef __cplusplus
extern "C" {
#endif
 
 
typedef enum
{
   DHCPV6_STATE_INIT         = 0,
   DHCPV6_STATE_SOLICIT      = 1,
   DHCPV6_STATE_REQUEST      = 2,
   DHCPV6_STATE_INIT_CONFIRM = 3,
   DHCPV6_STATE_CONFIRM      = 4,
   DHCPV6_STATE_DAD          = 5,
   DHCPV6_STATE_BOUND        = 6,
   DHCPV6_STATE_RENEW        = 7,
   DHCPV6_STATE_REBIND       = 8,
   DHCPV6_STATE_RELEASE      = 9,
   DHCPV6_STATE_DECLINE      = 10
} Dhcpv6State;
 
 
typedef void (*Dhcpv6TimeoutCallback)(Dhcpv6ClientContext *context,
   NetInterface *interface);
 
 
typedef void (*Dhcpv6LinkChangeCallback)(Dhcpv6ClientContext *context,
   NetInterface *interface, bool_t linkState);
 
 
typedef void (*Dhcpv6StateChangeCallback)(Dhcpv6ClientContext *context,
   NetInterface *interface, Dhcpv6State state);
 
 
typedef void (*Dhcpv6AddOptionsCallback)(Dhcpv6ClientContext *context,
   Dhcpv6Message *message, size_t *length);
 
 
typedef void (*Dhcpv6ParseOptionsCallback)(Dhcpv6ClientContext *context,
   const Dhcpv6Message *message, size_t length);
 
 
typedef struct
{
   NetInterface *interface;                         
   bool_t rapidCommit;                              
   bool_t manualDnsConfig;                          
   systime_t timeout;                               
   Dhcpv6TimeoutCallback timeoutEvent;              
   Dhcpv6LinkChangeCallback linkChangeEvent;        
   Dhcpv6StateChangeCallback stateChangeEvent;      
   Dhcpv6AddOptionsCallback addOptionsCallback;     
   Dhcpv6ParseOptionsCallback parseOptionsCallback; 
} Dhcpv6ClientSettings;
 
 
typedef struct
{
   Ipv6Addr addr;              
   uint32_t validLifetime;     
   uint32_t preferredLifetime; 
} Dhcpv6ClientAddrEntry;
 
 
typedef struct
{
   uint32_t t1;                                                  
   uint32_t t2;                                                  
   Dhcpv6ClientAddrEntry addrList[DHCPV6_CLIENT_ADDR_LIST_SIZE]; 
} Dhcpv6ClientIa;
 
 
struct _Dhcpv6ClientContext
{
   Dhcpv6ClientSettings settings;                   
   bool_t running;                                  
   Dhcpv6State state;                               
   bool_t timeoutEventDone;                         
   systime_t timestamp;                             
   systime_t timeout;                               
   uint_t retransmitCount;                          
   uint8_t clientId[DHCPV6_MAX_DUID_SIZE];          
   size_t clientIdLen;                              
   uint8_t serverId[DHCPV6_MAX_DUID_SIZE];          
   size_t serverIdLen;                              
   int_t serverPreference;                          
   uint32_t transactionId;                          
   systime_t configStartTime;                       
   systime_t exchangeStartTime;                     
   systime_t leaseStartTime;                        
   Dhcpv6ClientIa ia;                               
   DHCPV6_CLIENT_PRIVATE_CONTEXT                    
};
 
 
//DHCPv6 client related functions
void dhcpv6ClientGetDefaultSettings(Dhcpv6ClientSettings *settings);
 
error_t dhcpv6ClientInit(Dhcpv6ClientContext *context,
   const Dhcpv6ClientSettings *settings);
 
error_t dhcpv6ClientStart(Dhcpv6ClientContext *context);
error_t dhcpv6ClientStop(Dhcpv6ClientContext *context);
 
error_t dhcpv6ClientRelease(Dhcpv6ClientContext *context);
Dhcpv6State dhcpv6ClientGetState(Dhcpv6ClientContext *context);
 
//C++ guard
#ifdef __cplusplus
}
#endif
 
#endif