igmp_snooping.h

Go to the documentation of this file.

 
#ifndef _IGMP_SNOOPING_H
#define _IGMP_SNOOPING_H
 
//Dependencies
#include "core/net.h"
#include "igmp/igmp_common.h"
 
//IGMP snooping support
#ifndef IGMP_SNOOPING_SUPPORT
   #define IGMP_SNOOPING_SUPPORT DISABLED
#elif (IGMP_SNOOPING_SUPPORT != ENABLED && IGMP_SNOOPING_SUPPORT != DISABLED)
   #error IGMP_SNOOPING_SUPPORT parameter is not valid
#endif
 
//C++ guard
#ifdef __cplusplus
extern "C" {
#endif
 
 
typedef enum
{
   IGMP_SNOOPING_GROUP_STATE_NO_MEMBERS_PRESENT  = 0,
   IGMP_SNOOPING_GROUP_STATE_MEMBERS_PRESENT     = 1,
   IGMP_SNOOPING_GROUP_STATE_CHECKING_MEMBERSHIP = 2
} IgmpSnoopingGroupState;
 
 
typedef struct
{
   bool_t routerPresent;
   NetTimer timer;
} IgmpSnoopingPort;
 
 
typedef struct
{
   IgmpSnoopingGroupState state; 
   Ipv4Addr addr;                
   uint8_t port;
   NetTimer timer;
} IgmpSnoopingGroup;
 
 
typedef struct
{
   NetInterface *interface;             
   uint_t numPorts;                     
   IgmpSnoopingPort *ports;             
   uint_t numGroups;                    
   IgmpSnoopingGroup *groups;           
   bool_t floodReports;                 
   bool_t floodUnknownMulticastPackets; 
   systime_t lastMemberQueryTime;       
} IgmpSnoopingSettings;
 
 
typedef struct
{
   bool_t running;
   NetInterface *interface;             
   uint_t numPorts;                     
   IgmpSnoopingPort *ports;             
   uint_t numGroups;                    
   IgmpSnoopingGroup *groups;           
   bool_t floodReports;                 
   bool_t floodUnknownMulticastPackets; 
   systime_t lastMemberQueryTime;       
} IgmpSnoopingContext;
 
 
//IGMP snooping related functions
void igmpSnoopingGetDefaultSettings(IgmpSnoopingSettings *settings);
 
error_t igmpSnoopingInit(IgmpSnoopingContext *context,
   const IgmpSnoopingSettings *settings);
 
error_t igmpSnoopingStart(IgmpSnoopingContext *context);
error_t igmpSnoopingStop(IgmpSnoopingContext *context);
 
void igmpSnoopingTick(IgmpSnoopingContext *context);
 
//C++ guard
#ifdef __cplusplus
}
#endif
 
#endif