IPC@CHIP® RTOS-PPC – API Documentation

Header image

Main page

int AddMulticastIPv4 ( unsigned long  ipv4Address,
unsigned char *  macAddress,
void *  devHandle 

Install an IPv4 multicast address entry on a specified device.

[in] ipv4Address Pointer to multicast IPv4 address in network byte order.
[in] macAddress It is recommended to provide a null pointer. In this default case the mapped mac address is calculated with the standard TCPIP mapping method. Otherwise macAddress provides a pointer to a 6 byte array that contains the mapped corresponding ethernet address.
[in] devHandle The device handle to install the multicast address. If devHandle is a null pointer, the internal ethernet will be used as default.
A device handle can be found by calling function Dev_Find_Iface_By_Name().
A list of all installed device drivers is retrieveable by Dev_Get_IfaceEntries().
-1: Failure
0 : success
SC2x3 V1.00 - CLIB V1.00
IP Multicasting is the Internet abstraction of hardware multicasting. It allows transmission of IP datagrams to a group of hosts that form a single multicast group. Membership in a multicast group is dynamic. Hosts may join or leave the group at any time. Each multicast group has unique IP multicast address (Class D address). The first four bits of an IP multicast address must match to binary 1110. IP multicast addresses range from through
For the usage of IP multicasting on an ethernet-based interface, IP multicast addresses must be mapped to ethernet hardware addresses. The ethernet device of the atIPCCHIP will be switched into the ethernet multicast mode. In this mode it receives any incoming IP packet with the mapped ethernet multicast address and forwards it to the TCP/IP layer. Each IP multicast packet will be sent with the mapped ethernet multicast address.
Because of the feature, that a multicast IP packet will be received by any member of a multicast group, sending and receiving of IP multicast packets is only usable with UDP sockets (datagram sockets). After installing a IP multicast address with this API, the application programmer is able use this address as a destination address when sending datagrams with SendToInterface(). An UDP socket is able to receive datagrams at the specified multicast address. The maximum number of supported IP multicast addresses is limited to 64.
This implementation does not support multicast routing. Sending and receiving multicast datagrams works only at a local network. Using multicast addresses is only provided for ethernet-based device interfaces.
See also:

Top of page | Main page

Copyright © 2017 Beck IPC GmbH
Generated on Thu Jan 26 16:21:39 2017 by Doxygen 1.6.1