Network Component  Version 7.8.0
MDK Middleware for IPv4 and IPv6 Networking
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
NetIGMP: IGMP Management

Events generated by the Network - IGMP Group Management functions. More...

Functions

__STATIC_INLINE void EvrNetIGMP_InitManager (uint32_t num_entries)
 Event on IGMP manager initialize (Op) More...
 
__STATIC_INLINE void EvrNetIGMP_Join (const uint8_t *ip4_addr)
 Event on IGMP netIGMP_Join start (API) More...
 
__STATIC_INLINE void EvrNetIGMP_AlreadyInGroup (void)
 Event on IGMP netIGMP_Join already a member (Op) More...
 
__STATIC_INLINE void EvrNetIGMP_NoFreeEntries (void)
 Event on IGMP netIGMP_Join no free entries available (Error) More...
 
__STATIC_INLINE void EvrNetIGMP_SendReport (const uint8_t *ip4_addr)
 Event on IGMP send report message (Op) More...
 
__STATIC_INLINE void EvrNetIGMP_Leave (const uint8_t *ip4_addr)
 Event on IGMP netIGMP_Leave start (API) More...
 
__STATIC_INLINE void EvrNetIGMP_NotInGroup (void)
 Event on IGMP netIGMP_Leave not a member (Op) More...
 
__STATIC_INLINE void EvrNetIGMP_SendLeave (const uint8_t *ip4_addr)
 Event on IGMP send leave message (Op) More...
 
__STATIC_INLINE void EvrNetIGMP_ReceiveFrame (uint8_t message_type)
 Event on IGMP receive frame (Op) More...
 
__STATIC_INLINE void EvrNetIGMP_FrameTooShort (uint32_t length, uint32_t min_length)
 Event on IGMP received frame is too short (Error) More...
 
__STATIC_INLINE void EvrNetIGMP_ChecksumFailed (void)
 Event on IGMP frame checksum check failed (Error) More...
 
__STATIC_INLINE void EvrNetIGMP_GroupSpecificQuery (const uint8_t *ip4_addr)
 Event on IGMPv2 group specific query (Op) More...
 
__STATIC_INLINE void EvrNetIGMP_DestAddressWrong (const uint8_t *ip4_addr)
 Event on IGMPv2 destination address wrong (Error) More...
 
__STATIC_INLINE void EvrNetIGMP_DelayedReportScheduled (uint8_t max_time)
 Event on IGMPv2 report message delayed (Op) More...
 
__STATIC_INLINE void EvrNetIGMP_GeneralQuery (const uint8_t *ip4_addr)
 Event on IGMPv1 general query (Op) More...
 
__STATIC_INLINE void EvrNetIGMP_StartModeIGMPv1 (void)
 Event on start IGMPv1 mode (Op) More...
 
__STATIC_INLINE void EvrNetIGMP_MaxTimeForReport (uint8_t max_time)
 Event on IGMPv2 maximum time for report messages (Op) More...
 
__STATIC_INLINE void EvrNetIGMP_GroupReportsScheduled (uint32_t n_reports)
 Event on IGMP scheduled reports for all active groups (Op) More...
 
__STATIC_INLINE void EvrNetIGMP_ReportReceived (const uint8_t *ip4_addr)
 Event on IGMP received report message (Op) More...
 
__STATIC_INLINE void EvrNetIGMP_OwnReportCanceled (void)
 Event on own report canceled (Op) More...
 
__STATIC_INLINE void EvrNetIGMP_StartModeIGMPv2 (void)
 Event on start IGMPv2 mode (Op) More...
 
__STATIC_INLINE void EvrNetIGMP_SendDelayedReport (const uint8_t *ip4_addr)
 Event on IGMP send delayed report message (Op) More...
 
__STATIC_INLINE void EvrNetIGMP_UninitManager (void)
 Event on IGMP manager de-initialize (Op) More...
 

Description

Events generated by the Network - IGMP Group Management functions.

Function Documentation

__STATIC_INLINE void EvrNetIGMP_AlreadyInGroup ( void  )

Event on IGMP netIGMP_Join already a member (Op)

__STATIC_INLINE void EvrNetIGMP_ChecksumFailed ( void  )

Event on IGMP frame checksum check failed (Error)

__STATIC_INLINE void EvrNetIGMP_DelayedReportScheduled ( uint8_t  max_time)

Event on IGMPv2 report message delayed (Op)

Parameters
max_timemaximum delay time in 100 ms ticks
__STATIC_INLINE void EvrNetIGMP_DestAddressWrong ( const uint8_t *  ip4_addr)

Event on IGMPv2 destination address wrong (Error)

Parameters
ip4_addrpointer to IPv4 address of a group
__STATIC_INLINE void EvrNetIGMP_FrameTooShort ( uint32_t  length,
uint32_t  min_length 
)

Event on IGMP received frame is too short (Error)

Parameters
lengthframe length in bytes
min_lengthminimum length of the frame
__STATIC_INLINE void EvrNetIGMP_GeneralQuery ( const uint8_t *  ip4_addr)

Event on IGMPv1 general query (Op)

Parameters
ip4_addrpointer to IPv4 address of a group
__STATIC_INLINE void EvrNetIGMP_GroupReportsScheduled ( uint32_t  n_reports)

Event on IGMP scheduled reports for all active groups (Op)

Parameters
n_reportsnumber of scheduled reports
__STATIC_INLINE void EvrNetIGMP_GroupSpecificQuery ( const uint8_t *  ip4_addr)

Event on IGMPv2 group specific query (Op)

Parameters
ip4_addrpointer to IPv4 address of a group
__STATIC_INLINE void EvrNetIGMP_InitManager ( uint32_t  num_entries)

Event on IGMP manager initialize (Op)

Parameters
num_entriesnumber of entries available in membership table
__STATIC_INLINE void EvrNetIGMP_Join ( const uint8_t *  ip4_addr)

Event on IGMP netIGMP_Join start (API)

Parameters
ip4_addrpointer to IPv4 address of a group
__STATIC_INLINE void EvrNetIGMP_Leave ( const uint8_t *  ip4_addr)

Event on IGMP netIGMP_Leave start (API)

Parameters
ip4_addrpointer to IPv4 address of a group
__STATIC_INLINE void EvrNetIGMP_MaxTimeForReport ( uint8_t  max_time)

Event on IGMPv2 maximum time for report messages (Op)

Parameters
max_timemaximum delay time in 100 ms ticks
__STATIC_INLINE void EvrNetIGMP_NoFreeEntries ( void  )

Event on IGMP netIGMP_Join no free entries available (Error)

__STATIC_INLINE void EvrNetIGMP_NotInGroup ( void  )

Event on IGMP netIGMP_Leave not a member (Op)

__STATIC_INLINE void EvrNetIGMP_OwnReportCanceled ( void  )

Event on own report canceled (Op)

__STATIC_INLINE void EvrNetIGMP_ReceiveFrame ( uint8_t  message_type)

Event on IGMP receive frame (Op)

Parameters
message_typetype of received message
__STATIC_INLINE void EvrNetIGMP_ReportReceived ( const uint8_t *  ip4_addr)

Event on IGMP received report message (Op)

Parameters
ip4_addrpointer to IPv4 address of a group
__STATIC_INLINE void EvrNetIGMP_SendDelayedReport ( const uint8_t *  ip4_addr)

Event on IGMP send delayed report message (Op)

Parameters
ip4_addrpointer to IPv4 address of a group
__STATIC_INLINE void EvrNetIGMP_SendLeave ( const uint8_t *  ip4_addr)

Event on IGMP send leave message (Op)

Parameters
ip4_addrpointer to IPv4 address of a group
__STATIC_INLINE void EvrNetIGMP_SendReport ( const uint8_t *  ip4_addr)

Event on IGMP send report message (Op)

Parameters
ip4_addrpointer to IPv4 address of a group
__STATIC_INLINE void EvrNetIGMP_StartModeIGMPv1 ( void  )

Event on start IGMPv1 mode (Op)

__STATIC_INLINE void EvrNetIGMP_StartModeIGMPv2 ( void  )

Event on start IGMPv2 mode (Op)

__STATIC_INLINE void EvrNetIGMP_UninitManager ( void  )

Event on IGMP manager de-initialize (Op)