IP*Works! V9 - Online Help
IP*Works! V9
Questions / Feedback?

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.

Property List


The following is the full list of the properties of the class with short descriptions. Click on the links for further details.

AcceptDataEnables or disables data reception (the DataIn event).
ActiveEnables or disables sending and receiving data.
DataToSendA string of data to be sent to the remote host. Write-only property.
LocalHostThe name of the local host or user-assigned IP interface through which connections are initiated or accepted.
LocalPortThe UDP port in the local host where MCast binds.
LoopbackEnables or disables loopback of data sent to the multicast group.
MulticastGroupMulticast group to join or leave.
ReceiveInterfaceThe interface with which to receive multicast packets. If empty, default is used.
RemoteHostThe address of the remote host (multicast group).
RemotePortThe UDP port in the remote host.
SendInterfaceThe interface from which multicast packets are sent. If empty, default is used.
TimeToLiveThe maximum number of subnets that a multicast datagram can traverse.

Method List


The following is the full list of the methods of the class with short descriptions. Click on the links for further details.

ConfigSets or retrieves a configuration setting .
DoEventsProcesses events from the internal message queue.
SendSends data to the remote host.

Event List


The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.

DataInFired when data is received.
ErrorInformation about errors during data delivery.
ReadyToSendFired when the component is ready to send data.

Configuration Settings


The following is a list of configuration settings for the class with short descriptions. Click on the links for further details.

CaptureIPPacketInfoUsed to capture the packet information.
DestinationAddressUsed to get the destination address from the packet information.
DontFragmentUsed to set the Don't Fragment flag of outgoing packets.
LocalHostThe name of the local host through which connections are initiated or accepted.
LocalPortThe TCP port in the local host where the component binds.
MaxPacketSizeThe maximum length of the packets that can be received.
ShareLocalPortIf set to True, allows more than one instance of the component to be active on the same local port.
UseConnectionDetermines whether to use a connected socket.
QOSDSCPValueUsed to specify an arbitrary QOS/DSCP setting (optional).
QOSTrafficTypeUsed to specify QOS/DSCP settings (optional).
UseIPv6Whether or not to use IPv6.
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallDataUsed to send extra data to the firewall.
InBufferSizeThe size in bytes of the incoming queue of the socket.
OutBufferSizeThe size in bytes of the outgoing queue of the socket.
CodePageThe system code page used for Unicode to Multibyte translations.

 
 
Copyright (c) 2018 /n software inc. - All rights reserved.
Build 9.0.6635.0