MCast Class

Properties   Methods   Events   Configuration Settings   Errors  

The MCast component is used to multicast UDP datagrams to multicast capable hosts in multicast capable subnets. It can act both as a client and a server and communicate with any number of hosts simultaneously, as well as generate and receive broadcast packets.

Class Name

IPWorks_MCast

Procedural Interface

 ipworks_mcast_open();
 ipworks_mcast_close($res);
 ipworks_mcast_register_callback($res, $id, $function);
 ipworks_mcast_get_last_error($res);
 ipworks_mcast_get_last_error_code($res);
 ipworks_mcast_set($res, $id, $index, $value);
 ipworks_mcast_get($res, $id, $index);
 ipworks_mcast_do_config($res, $configurationstring);
 ipworks_mcast_do_doevents($res);
 ipworks_mcast_do_send($res, $text);

Remarks

The MCast class is very similar to UDPPort, except for some additional properties that provide support for multicast datagrams. To send datagrams to a multicast group, simply assign the address of the group to RemoteHost. To receive datagrams from one or more groups, assign the group addresses to MulticastGroup one by one (after the class is activated. TimeToLive allows to specify how many subnets a packet should be allowed to receive. ReceiveInterface and SendInterface allow you to select the network interface for multicast operations.

The class is activated/deactivated through the Active property. This property enables or disables sends or receives. The data can be sent in the same way as UDPPort, by calling the Send method with a Text parameter or via the DataToSend property. The destination is specified using the RemoteHost and RemotePort properties. Inbound data is received through the DataIn event.