NetBurner 3.1
Multicast

Functions

void RegisterMulticastFifo4 (IPADDR4 group, uint16_t dest_port, OS_FIFO *pfifo, int interface=0)
 Register to join a Multicast group. More...
 
void UnregisterMulticastFifo4 (IPADDR4 group, uint16_t destination_port, int interface=0)
 Unregister from a Multicast group. More...
 
void RegisterMulticastFifo6 (IPADDR group, uint16_t dest_port, OS_FIFO *pfifo, int interface=0)
 Register to join a Multicast group. More...
 
void UnregisterMulticastFifo6 (IPADDR6 group, uint16_t destination_port, int interface=0)
 Unregister from a Multicast group. More...
 

Detailed Description

The NetBurner Multicast Group

Function Documentation

◆ RegisterMulticastFifo4()

void RegisterMulticastFifo4 ( IPADDR4  group,
uint16_t  dest_port,
OS_FIFO pfifo,
int  interface = 0 
)

Register to join a Multicast group.

Calling RegisterMulticastFifo() in dual stack mode will automatically select the correct IPv4/IPv6 function.

IGMP Multicast is a method for distributing UDP packets within a group of hosts and servers. The NetBurner Multicast functions extend the NetBurner UDP interface. Instead of RegisterUDPFifo(), the RegisterMulticastFifo() function is used to listen for Multicast UDP packets. To transmit Multicast packets, use the UDP Send function with a multicast IP address.

Parameters
groupThe IP address of the group to join
dest_portThe port number of the group to join
pfifoPointer to the FIFO to store incoming packets
interfaceOptional interface number. If not specified or 0, the first system interface will be used.
See also
UnregisterMulticastFifo4()

◆ RegisterMulticastFifo6()

void RegisterMulticastFifo6 ( IPADDR  group,
uint16_t  dest_port,
OS_FIFO pfifo,
int  interface = 0 
)

Register to join a Multicast group.

Calling RegisterMulticastFifo() in dual stack mode will automatically select the correct IPv4/IPv6 function.

IGMP Multicast is a method for distributing UDP packets within a group of hosts and servers. The NetBurner Multicast functions extend the NetBurner UDP interface. Instead of RegisterUDPFifo(), the RegisterMulticastFifo() function is used to listen for Multicast UDP packets. To transmit Multicast packets, use the UDP Send function with a multicast IP address.

Parameters
groupThe IP address of the group to join
dest_portThe port number of the group to join
pfifoPointer to the FIFO to store incoming packets
interfaceOptional interface number. If not specified or 0, the first system interface will be used.
See also
UnregisterMulticastFifo4()

◆ UnregisterMulticastFifo4()

void UnregisterMulticastFifo4 ( IPADDR4  group,
uint16_t  destination_port,
int  interface = 0 
)

Unregister from a Multicast group.

Calling UnregisterMulticastFifo() in dual stack mode will automatically select the correct IPv4/IPv6 function.

Parameters
groupThe IP address of the group to leave
dest_portThe port number of the group to leave
See also
RegisterMulticastFifo4()

◆ UnregisterMulticastFifo6()

void UnregisterMulticastFifo6 ( IPADDR6  group,
uint16_t  destination_port,
int  interface = 0 
)

Unregister from a Multicast group.

Calling UnregisterMulticastFifo() in dual stack mode will automatically select the correct IPv4/IPv6 function.

Parameters
groupThe IP address of the group to leave
dest_portThe port number of the group to leave
See also
RegisterMulticastFifo4()