Multicast

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

Detailed Description

#include< multicast.h >

The NetBurner Multicast API

Function Documentation

RegisterMulticastFifo4()

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

#include <multicast.h>

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

group	The IP address of the group to join
dest_port	The port number of the group to join
pfifo	Pointer to the FIFO to store incoming packets
interface	Optional 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 )

#include <multicast.h>

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

group	The IP address of the group to join
dest_port	The port number of the group to join
pfifo	Pointer to the FIFO to store incoming packets
interface	Optional 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 )

#include <multicast.h>

Unregister from a Multicast group.

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

Parameters

group	The IP address of the group to leave
destination_port	The port number of the group to leave
interface	Specifies the interface number, the default is 0

See also

RegisterMulticastFifo4()

UnregisterMulticastFifo6()

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

#include <multicast.h>

Unregister from a Multicast group.

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

Parameters

group	The IP address of the group to leave
destination_port	The port number of the group to leave
interface	Optional interface number. If not specified or 0, the first system interface will be used.

See also

RegisterMulticastFifo4()