igmp_router.h

Go to the documentation of this file.

 
#ifndef _IGMP_ROUTER_H
#define _IGMP_ROUTER_H
 
//Dependencies
#include "core/net.h"
#include "igmp/igmp_common.h"
 
//IGMP router support
#ifndef IGMP_ROUTER_SUPPORT
   #define IGMP_ROUTER_SUPPORT DISABLED
#elif (IGMP_ROUTER_SUPPORT != ENABLED && IGMP_ROUTER_SUPPORT != DISABLED)
   #error IGMP_ROUTER_SUPPORT parameter is not valid
#endif
 
//Forward declaration of DhcpClientContext structure
struct _IgmpRouterContext;
#define IgmpRouterContext struct _IgmpRouterContext
 
//C++ guard
#ifdef __cplusplus
extern "C" {
#endif
 
 
typedef enum
{
   IGMP_VERSION_1 = 1,
   IGMP_VERSION_2 = 2,
   IGMP_VERSION_3 = 3
} IgmpVersion;
 
 
typedef enum
{
   IGMP_ROUTER_STATE_INIT        = 0,
   IGMP_ROUTER_STATE_QUERIER     = 1,
   IGMP_ROUTER_STATE_NON_QUERIER = 2
} IgmpRouterState;
 
 
typedef enum
{
   IGMP_ROUTER_GROUP_STATE_NO_MEMBERS_PRESENT  = 0,
   IGMP_ROUTER_GROUP_STATE_MEMBERS_PRESENT     = 1,
   IGMP_ROUTER_GROUP_STATE_V1_MEMBERS_PRESENT  = 2,
   IGMP_ROUTER_GROUP_STATE_CHECKING_MEMBERSHIP = 3
} IgmpRouterGroupState;
 
 
typedef void (*IgmpRouterAddMcastRouteCallback)(IgmpRouterContext *context,
   Ipv4Addr groupAddr, NetInterface *interface);
 
 
typedef void (*IgmpRouterDeleteMcastRouteCallback)(IgmpRouterContext *context,
   Ipv4Addr groupAddr, NetInterface *interface);
 
 
typedef struct
{
   IgmpRouterGroupState state;  
   Ipv4Addr addr;               
   uint_t lastMemberQueryCount; 
   NetTimer timer;              
   NetTimer v1HostTimer;        
   NetTimer retransmitTimer;    
} IgmpRouterGroup;
 
 
typedef struct
{
   NetInterface *interface;                                     
   IgmpVersion version;                                         
   uint_t numGroups;                                            
   IgmpRouterGroup *groups;                                     
   IgmpRouterAddMcastRouteCallback addMcastRouteCallback;       
   IgmpRouterDeleteMcastRouteCallback deleteMcastRouteCallback; 
} IgmpRouterSettings;
 
 
struct _IgmpRouterContext
{
   NetInterface *interface;                                     
   IgmpVersion version;                                         
   uint_t numGroups;                                            
   IgmpRouterGroup *groups;                                     
   IgmpRouterAddMcastRouteCallback addMcastRouteCallback;       
   IgmpRouterDeleteMcastRouteCallback deleteMcastRouteCallback; 
   bool_t running;                                              
   IgmpRouterState state;                                       
   uint_t startupQueryCount;                                    
   NetTimer generalQueryTimer;                                  
   NetTimer otherQuerierPresentTimer;                           
};
 
 
//IGMP router related functions
void igmpRouterGetDefaultSettings(IgmpRouterSettings *settings);
 
error_t igmpRouterInit(IgmpRouterContext *context,
   const IgmpRouterSettings *settings);
 
error_t igmpRouterStart(IgmpRouterContext *context);
error_t igmpRouterStop(IgmpRouterContext *context);
 
void igmpRouterTick(IgmpRouterContext *context);
void igmpRouterFsm(IgmpRouterContext *context);
void igmpRouterGroupFsm(IgmpRouterContext *context, IgmpRouterGroup *group);
 
//C++ guard
#ifdef __cplusplus
}
#endif
 
#endif