dhcpv6_relay.h

Go to the documentation of this file.

 
#ifndef _DHCPV6_RELAY_H
#define _DHCPV6_RELAY_H
 
//Dependencies
#include "dhcpv6/dhcpv6_common.h"
#include "core/socket.h"
 
//DHCPv6 relay agent support
#ifndef DHCPV6_RELAY_SUPPORT
   #define DHCPV6_RELAY_SUPPORT ENABLED
#elif (DHCPV6_RELAY_SUPPORT != ENABLED && DHCPV6_RELAY_SUPPORT != DISABLED)
   #error DHCPV6_RELAY_SUPPORT parameter is not valid
#endif
 
//Stack size required to run the DHCPv6 relay agent
#ifndef DHCPV6_RELAY_STACK_SIZE
   #define DHCPV6_RELAY_STACK_SIZE 500
#elif (DHCPV6_RELAY_STACK_SIZE < 1)
   #error DHCPV6_RELAY_STACK_SIZE parameter is not valid
#endif
 
//Priority at which the DHCPv6 relay agent should run
#ifndef DHCPV6_RELAY_PRIORITY
   #define DHCPV6_RELAY_PRIORITY OS_TASK_PRIORITY_NORMAL
#endif
 
//Maximum number of client-facing interfaces
#ifndef DHCPV6_RELAY_MAX_CLIENT_IF
   #define DHCPV6_RELAY_MAX_CLIENT_IF 4
#elif (DHCPV6_RELAY_MAX_CLIENT_IF < 1)
   #error DHCPV6_RELAY_MAX_CLIENT_IF parameter is not valid
#endif
 
//The amount of overhead added by relay forwarding
#define DHCPV6_RELAY_FORW_OVERHEAD (sizeof(Dhcpv6RelayMessage) + 2 * sizeof(Dhcpv6Option) + sizeof(uint32_t))
 
//C++ guard
#ifdef __cplusplus
extern "C" {
#endif
 
 
typedef struct
{
   NetInterface *serverInterface;                             
   NetInterface *clientInterface[DHCPV6_RELAY_MAX_CLIENT_IF]; 
   uint_t clientInterfaceCount;                               
   Ipv6Addr serverAddress;                                    
} Dhcpv6RelaySettings;
 
 
typedef struct
{
   NetInterface *serverInterface;                             
   NetInterface *clientInterface[DHCPV6_RELAY_MAX_CLIENT_IF]; 
   uint_t clientInterfaceCount;                               
   Ipv6Addr serverAddress;                                    
   Socket *serverSocket;                                      
   Socket *clientSocket[DHCPV6_RELAY_MAX_CLIENT_IF];          
   SocketEventDesc eventDesc[DHCPV6_RELAY_MAX_CLIENT_IF];     
   bool_t running;                                            
   bool_t stopRequest;                                        
   OsEvent ackEvent;                                          
   OsEvent event;                                             
   OsTaskId taskId;                                           
#if (OS_STATIC_TASK_SUPPORT == ENABLED)
   OsTaskTcb taskTcb;                                         
   OsStackType taskStack[DHCPV6_RELAY_STACK_SIZE];            
#endif
   uint8_t buffer[DHCPV6_MAX_MSG_SIZE];                       
} Dhcpv6RelayContext;
 
 
//DHCPv6 relay agent specific functions
error_t dhcpv6RelayStart(Dhcpv6RelayContext *context, const Dhcpv6RelaySettings *settings);
error_t dhcpv6RelayStop(Dhcpv6RelayContext *context);
 
error_t dhcpv6RelayJoinMulticastGroup(Dhcpv6RelayContext *context);
error_t dhcpv6RelayLeaveMulticastGroup(Dhcpv6RelayContext *context);
 
void dhcpv6RelayTask(void *param);
 
error_t dhcpv6ForwardClientMessage(Dhcpv6RelayContext *context, uint_t index);
error_t dhcpv6ForwardRelayReplyMessage(Dhcpv6RelayContext *context);
 
//C++ guard
#ifdef __cplusplus
}
#endif
 
#endif